Перейти к содержимому

API Reference

Все запросы отправляются в Business API с ключом мерчанта в заголовке Authorization.

PaymentPOST /api/v1/payments

Инициализирует входящий платёж. После успешного ответа откройте processingUrl методом GET.

Окно терминала
curl "https://business.example.com/api/v1/payments" \
-X POST \
-H "Authorization: Bearer test_private_key" \
-H "Content-Type: application/json" \
-d '{
"product": "Тестовый платёж",
"amount": 1000,
"currency": "USD",
"callbackUrl": "https://merchant.example.com/callback",
"redirectSuccessUrl": "https://merchant.example.com/success",
"redirectFailUrl": "https://merchant.example.com/declined",
"pendingUrl": "https://merchant.example.com/pending",
"bank_account": {
"bank_name": "test_bank",
"requisite_type": "card"
},
"customer": {
"email": "test@example.com",
"ip": "192.0.2.10"
}
}'
Параметр Обязательный Описание
product Да Название продукта, от 5 до 255 символов
amount Да Сумма в минимальных единицах валюты
currency Да Код валюты ISO 4217
callbackUrl Да URL уведомления о финальном статусе
redirectSuccessUrl Нет URL редиректа при успешном платеже
redirectFailUrl Нет URL редиректа при ошибке
pendingUrl Нет URL редиректа для незавершённого платежа
bank_account Нет Параметры банка и типа реквизита
customer Да Данные клиента для Host-to-Host платежа
Параметр Обязательный Описание
bank_name Нет Системное имя банка
requisite_type Нет sbp, card, account или link
Параметр Обязательный Описание
email Да Email клиента
ip Нет IP-адрес клиента
{
"success": true,
"result": 0,
"status": 200,
"token": "test_payment_token",
"processingUrl": [
{
"trader": "https://business.example.com/p/test_payment_token"
}
],
"selectorUrl": "https://business.example.com/select/test_payment_token",
"payment": {
"amount": 1000,
"gateway_amount": 1000,
"currency": "USD",
"status": "init",
"two_stage_mode": false,
"commission": 0
}
}
Payout CardPOST /api/v1/payouts

Создаёт выплату на карту. После успешного ответа откройте processingUrl методом GET.

Окно терминала
curl "https://business.example.com/api/v1/payouts" \
-X POST \
-H "Authorization: Bearer test_private_key" \
-H "Content-Type: application/json" \
-d '{
"amount": 1000,
"currency": "USD",
"orderNumber": "ТЕСТ-КАРТА-0001",
"callbackUrl": "https://merchant.example.com/callback",
"bank_account": {
"bank_name": "test_bank",
"requisite_type": "card"
},
"card": {
"pan": "4111111111111111"
},
"customer": {
"email": "recipient@example.com",
"ip": "192.0.2.10",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"phone": "+15555550100"
}
}'
Параметр Обязательный Описание
bank_account.bank_name Нет Системное имя банка
bank_account.requisite_type Да Значение card
card.pan Да PAN карты получателя
{
"success": true,
"result": 0,
"status": 200,
"token": "test_payout_token",
"processingUrl": [
{
"trader": "https://business.example.com/payout/test_payout_token"
}
],
"selectorUrl": "https://business.example.com/select/payout/test_payout_token",
"payment": {
"amount": 1000,
"currency": "USD",
"gateway_amount": 1000,
"gateway_currency": "USD",
"status": "init"
}
}
Payout SBPPOST /api/v1/payouts

Создаёт выплату по номеру телефона.

Окно терминала
curl "https://business.example.com/api/v1/payouts" \
-X POST \
-H "Authorization: Bearer test_private_key" \
-H "Content-Type: application/json" \
-d '{
"amount": 1000,
"currency": "USD",
"orderNumber": "ТЕСТ-СБП-0001",
"callbackUrl": "https://merchant.example.com/callback",
"bank_account": {
"bank_name": "test_bank",
"requisite_type": "sbp"
},
"customer": {
"email": "recipient@example.com",
"ip": "192.0.2.10",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"phone": "+15555550100"
}
}'
Параметр Обязательный Описание
bank_account.bank_name Да Системное имя банка
bank_account.requisite_type Да Значение sbp
customer.phone Да Телефон получателя

Ответ имеет ту же структуру, что и ответ Payout Card.

Payout AccountPOST /api/v1/payouts

Создаёт выплату на банковский счёт.

Окно терминала
curl "https://business.example.com/api/v1/payouts" \
-X POST \
-H "Authorization: Bearer test_private_key" \
-H "Content-Type: application/json" \
-d '{
"amount": 1000,
"currency": "USD",
"orderNumber": "ТЕСТ-СЧЕТ-0001",
"callbackUrl": "https://merchant.example.com/callback",
"bank_account": {
"bank_name": "test_bank",
"requisite_type": "account",
"account_number": "TEST-ACCOUNT-0001"
},
"customer": {
"email": "recipient@example.com",
"ip": "192.0.2.10",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"phone": "+15555550100"
}
}'
Параметр Обязательный Описание
bank_account.bank_name Да Системное имя банка
bank_account.requisite_type Да Значение account
bank_account.account_number Да Номер счёта получателя

Ответ имеет ту же структуру, что и ответ Payout Card.