Выплаты на банковские карты с использованием синонима карты

Выплаты на карты с использованием синонима банковской карты

В этой статье описаны особенности и порядок проведения выплат на банковские карты с использованием синонима карты, полученного с помощью виджета для сбора данных.

Чтобы сделать выплату на банковскую карту:

Получите данные банковской карты.
Проведите выплату с полученными данными.

Если вы хотите, чтобы в выписках из реестра выплат отображалась информация о получателе выплаты (например, для госорганов), перед проведением выплаты сохраните данные о получателе в ЮKassa и затем передайте идентификатор сохраненных данных в запросе на создание выплаты. Подробнее о передаче данных получателя выплаты для выписок

Получение данных банковской карты

Для проведения выплаты вам нужно получить с помощью виджета синоним банковской карты. Если у вас уже есть синоним нужной карты, можно использовать его. Если нет, получите синоним с помощью виджета:

Шаг 1. Инициализируйте виджет и отобразите пользователю форму для сбора данных.

Шаг 2. Когда пользователь введет номер карты, обработайте полученный результат.

Проведение выплаты с использованием виджета

Создайте выплату : отправьте ЮKassa запрос с данными для аутентификации, ключом идемпотентности и данными для выплаты на банковскую карту:

в объекте amount передайте сумму, которую нужно выплатить пользователю; сумма должна укладываться в лимиты;
в параметре description передайте описание выплаты;
в параметре payout_token передайте полученный синоним банковской карты (значение параметра payout_token, полученного от виджета);
если проводите выплату с передачей данных получателя для выписки из реестра, в массиве personal_data передайте идентификатор персональных данных.

Пример запроса на создание выплаты

cURL
curl https://api.yookassa.ru/v3/payouts \
  -X POST \
  -u <Gateway ID>:<Secret Key> \
  -H 'Idempotence-Key: <Idempotence Key>' \
  -H 'Content-Type: application/json' \
  -d '{
        "amount": {
          "value": "5.00",
          "currency": "RUB"
        },
        "payout_token": "<Bank card synonym>",
        "description": "Payout for order No. 1",
        "metadata": {
          "order_id": "37"
        }
      }'

В ответ на запрос ЮKassa вернет созданный объект выплаты .

Пример созданного объекта выплаты

JSON
{
  "id": "po-285ec15d-0003-5000-a000-08d1bec7dade",
  "amount": {
    "value": "5.00",
    "currency": "RUB"
  },
  "status": "pending",
  "payout_destination": {
    "type": "bank_card",
    "card": {
      "first6": "555555",
      "last4": "4477",
      "card_type": "Mir",
      "issuer_country": "RU",
      "issuer_name": "Sberbank Of Russia"
    }
  },
  "description": "Payout for order No. 37",
  "created_at": "2021-06-21T14:28:45.132Z",
  "metadata": {
    "order_id": "37"
  },
  "test": false
}

Если вы получили объект выплаты в статусе pending, дождитесь, когда статус изменится на succeeded или canceled. Wait for the YooMoney notification or request payout information with an increasing reasonable interval.

Пример запроса на получение информации о выплате

cURL
curl https://api.yookassa.ru/v3/payouts/{payout_id} \
    -X GET \
    -u <Gateway ID>:<Secret Key> \

Пример объекта выплаты в статусе succeeded

JSON
{
    "id": "po-285ec15d-0003-5000-a000-08d1bec7dade",
    "amount": {
        "value": "5.00",
        "currency": "RUB"
    },
    "status": "succeeded",
    "payout_destination": {
        "type": "bank_card",
        "card": {
          "first6": "555555",
          "last4": "4477",
          "card_type": "Mir",
          "issuer_country": "RU",
          "issuer_name": "Sberbank Of Russia"
        }
    },
    "description": "Payout for order No. 37",
    "created_at": "2021-06-21T14:28:45.132Z",
    "metadata": {
        "order_id": "37"
    },
    "test": false
}