Создает в ЮKassa объект способа оплаты. В запросе передайте код способа оплаты, который хотите сохранить, и при необходимости дополнительные параметры нужной функциональности. Идентификатор созданного способа оплаты можно использовать при проведении автоплатежей или выплат.
Документация: https://yookassa.ru/developers/api#create_payment_method
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
Idempotence-Key |
header | string | да | Ключ идемпотентности. Рекомендуется использовать строку вида UUID v7 |
type |
body | string (bank_card, sbp) | да | |
holder |
body | object | нет | Данные магазина, для которого сохраняется способ оплаты. |
holder.gateway_id |
body | string | нет | Идентификатор субаккаунта. Используется для разделения потоков платежей в рамках одного аккаунта. |
client_ip |
body | string | нет | IPv4- или IPv6-адрес пользователя. Если не указан, используется IP-адрес TCP-соединения. |
confirmation |
body | object | нет | |
confirmation.type |
body | string (redirect, qr) | нет | Код сценария подтверждения пользователем привязки платежного средства к вашему магазину в ЮKassa. |
confirmation.enforce |
body | boolean | нет | Запрос на проведение привязки с аутентификацией по 3-D Secure. Сработает, если вы по умолчанию принимаете оплату банковской картой без подтверждения платежа пользователем; в остальных случаях аутентификацией по 3-D Secure управляет ЮKassa. Чтобы принимать платежи и создавать привязки без дополнительного подтверждения пользователем, напишите вашему менеджеру ЮKassa. |
confirmation.return_url |
body | string | нет | URL, на который вернется пользователь после подтверждения или отмены привязки на веб-странице. Не более 2048 символов. |
confirmation.locale |
body | string (ru_RU, en_US) | нет | Язык интерфейса, писем и смс, которые будут показаны или отправлены пользователю. Формат соответствует ISO/IEC 15897. Возможные значения: ru_RU, en_US. Регистр важен. |
metadata |
body | object | нет | Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ — значение» и возвращаются в ответе от ЮKassa. Ограничения: не более 16 ключей, имя ключа — не более 32 символов, значение ключа — не более 512 символов, тип данных — строка в формате UTF-8. |
card |
body | object | нет | Данные банковской карты (необходимы, если вы собираете данные карты пользователей на своей стороне). |
card.number |
body | string | нет | Номер банковской карты. |
card.expiry_year |
body | string | нет | Срок действия, год, YYYY. |
card.expiry_month |
body | string | нет | Срок действия, месяц, MM. |
card.cardholder |
body | string | нет | Имя владельца карты. |
card.csc |
body | string | нет | Код CVC2 или CVV2, 3 или 4 символа, печатается на обратной стороне карты. |
Пример запроса:
{
"type": "bank_card"
}
Пример ответа:
{
"id": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
"type": "bank_card",
"saved": true,
"status": "active",
"holder": {
"account_id": "123"
}
}
https://api.yookassa.ru/v3Тип: Basic Auth
HTTP Basic Auth: имя пользователя — идентификатор магазина (shopId, раздел Настройки — Магазин) или шлюза для выплат (agentId, раздел Настройки выплат), пароль — секретный ключ (раздел Интеграция — Ключи API). Для тестового магазина ключ выпускается автоматически. Участники партнерской программы используют OAuth 2.0 и передают Bearer-токен. Секретный ключ и OAuth-токен нельзя публиковать.
curl https://api.yookassa.ru/v3/payments/{payment_id} \
-u <Идентификатор магазина>:<Секретный ключ>
Если этого недостаточно — официальная документация: https://yookassa.ru/developers/api#create_payment_method Вся интеграция одним документом: https://mcp-everything.ru/integrations/yookassa.md