Россия (банковский счёт)
Выплаты на рублёвые счета физических лиц по номеру счёта и БИК
Перед тем как начать
Авторизация
Как подписывать запросы API-токеном.
Обзор выплат
Общий формат запроса, поля ответа и статусы.
Это направление выплат доступно не всем мерчантам. Уточните доступность у вашего менеджера и убедитесь, что на вашем балансе мерчанта достаточно средств, прежде чем создавать выплату.
Обзор
| Валюта | Направление | Тип платежа |
|---|---|---|
RUB | Счёт физического лица в банке России | BANK_ACCOUNT |
Выплата на счёт выполняется в два запроса: сначала вы получаете список банков, затем создаёте выплату с БИК банка получателя.
Не хотите собирать реквизиты сами? Встройте виджет «Выплата в 1 клик»: клиент введёт реквизиты один раз, а следующие выплаты — в один клик.
Порядок действий
Получите список банков
GET /v1/payouts/banks?serviceId={serviceId}| Query-параметр | Тип | Обязательное | Описание |
|---|---|---|---|
serviceId | number | ❌ Нет | Сервис выплат на счёт из GET /v1/payouts/services. Передавайте его, если у вас подключено несколько направлений |
curl -X GET "https://api.platinout.com/v1/payouts/banks?serviceId=123" \
-H "X-Api-Token: YOUR_API_TOKEN"{
"data": [
{ "id": "044525225", "name": "ПАО Сбербанк" },
{ "id": "044525974", "name": "АО \"ТБанк\"" }
]
}id банка — это его БИК. Передайте его в account.bankName на следующем шаге.
Создайте выплату
POST /v1/payoutscurl -X POST "https://api.platinout.com/v1/payouts" \
-H "Content-Type: application/json" \
-H "X-Api-Token: YOUR_API_TOKEN" \
-d '{
"amount": 15000,
"currency": "RUB",
"paymentType": "BANK_ACCOUNT",
"serviceId": 123,
"externalId": "payout-123",
"account": {
"name": "Иванов Иван Иванович",
"requisites": "40817810700000000001",
"bankName": "044525225",
"userPhone": "+79991234567",
"userId": "user_12345"
},
"note": "Выплата по заказу №1234"
}'Поля account
Все поля обязательные.
| Поле | Тип | Описание |
|---|---|---|
name | string | ФИО получателя кириллицей в порядке «Фамилия Имя Отчество», например Иванов Иван Иванович. Не меньше трёх слов, каждое не короче двух букв. Двойная фамилия пишется через дефис (Римский-Корсаков). Слова не должны повторяться |
requisites | string | Номер счёта получателя: 20 цифр без пробелов. Принимаются только рублёвые счета физических лиц: начинаются на 40817810 (резиденты) или 40820810 (нерезиденты) |
bankName | string | БИК банка получателя: id из GET /v1/payouts/banks, например 044525225 |
userPhone | string | Телефон получателя в формате +7XXXXXXXXXX, например +79991234567 |
userId | string | ID пользователя в вашей системе |
Проверка реквизитов
Реквизиты проверяются при создании выплаты:
- ФИО написано кириллицей, в нём не меньше трёх слов и нет повторов;
- телефон указан в формате
+7XXXXXXXXXX; - БИК есть в списке банков;
- номер счёта состоит из 20 цифр, это рублёвый счёт физического лица, и его контрольный ключ сходится с БИК банка.
Если проверка не прошла, выплата не создаётся и баланс не резервируется. API отвечает 400 Bad Request, в message указано, какое поле нужно исправить:
{
"statusCode": 400,
"message": "The account number does not match the recipient bank BIK: the control key check failed (account.requisites, account.bankName)",
"error": "Bad Request"
}Статусы
Выплата создаётся в статусе CREATED, затем переходит в PROCESSING и в финальный статус. Финальный статус выплаты на счёт может прийти не сразу — отслеживайте его по webhook-уведомлениям.
Ответ
В ответе возвращается стандартный объект выплаты со статусом CREATED. Сохраните id, чтобы отслеживать выплату.