¶ Shadow WITHDRAWAL SBP H2H
URL:
- Тестовое окружение:
https://api-gateway.sandbox.idynsys.org/api/accounts/external-app/withdrawal
- Продакшн окружение:
https://api-gateway.idynsys.org/api/accounts/external-app/withdrawal
Метод запроса: POST
Заголовки запросе:
X-Client-Id: (обязательно). Идентификатор приложения, получаемый при регистрации приложения в системе B2B Backoffice.X-Authorization-Sign: (обязательно). Подпись запроса по секретному ключу приложения, который определяется в системе B2B Backoffice. Подпись формируется по алгоритму, описанному на странице “Подпись”Content-Type: (обязательно) Тип содержимого запроса, должно быть application/json.
Структура тела запроса:
Тело запроса должно быть в формате JSON и иметь следующую структуру:
curl --location 'https://api-gateway.sandbox.idynsys.org/api/accounts/external-app/withdrawal' \
--header 'X-Client-Id: {{xClientId}}' \
--header 'X-Authorization-Sign: {{xAuthorizationSign}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"paymentMethodName": "SBP",
"communicationType": "h2h",
"trafficType": "trusted",
"payment": {
"amount": 4000.00,
"currency": "RUB"
},
"merchantOrder": {
"id": "d07d573f-fc62-4652-8b35-9b4a9a9d2ed3",
"description": "desc"
},
"urls": {
"callback": "https://callback.com",
"return": "https://return.com",
"redirectSuccess": "https://redirectSuccess.com",
"redirectFail": "https://redirectFail.com"
},
"sessionDetails": {
"ipAddress": "139.0.51.23",
"acceptLanguage": "en-US",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36",
"fingerprint": "aekrtpwoiertjw34tij34w2-t89twp3j409j"
},
"customer": {
"id": "test1",
"firstName": "Ivan",
"lastName": "Ivanov",
"middleName": "Ivanovich",
"phoneNumber": "254722123456"
},
"customerAccount": {
"bankName": "NORTH EAST SMALL FINANCE BANK LIMITED"
}
}'
В следующей таблице информация об обязательности атрибутов для платежного метода SBP WITHDRAWAL H2H в рамках ПС Shadow:
| Поле |
Обязательное |
Тип |
Описание |
paymentMethodName |
Да |
string |
Код метода оплаты. Возможные значения> |
communicationType |
Да |
string |
Тип коммуникации для выполнения платежа. Возможные значения: |
trafficType |
Да |
string |
Тип трафика. Возможные значения: |
payment.amount |
Да |
float |
Сумма платежа. Допустимые значения - больше 0. Если передается значение с дробной частью, то оно может округляться по правилам платежной системы. |
payment.currency |
Да |
string |
3-х значный буквенный код валюты платежа по ISO 4217. |
merchantOrder.id |
Да |
string |
Идентификатор ордера клиента (организации заказчика). |
merchantOrder.description |
Да |
string |
Описание ордера клиента. |
customer.id |
Да |
string |
Идентификатор пользователя в магазине, который выполняет платеж. |
customer.firstName |
Да |
string |
Имя плательщика латиницей. |
customer.lastName |
Да |
string |
Фамилия плательщика латиницей. |
customer.middleName |
Да |
string |
Отчество или второе имя плательщика латиницей. |
customer.phoneNumber |
Да |
string |
Номер телефона плательщика в международном формате. Значение должно содержать только цифры. |
sessionDetails.acceptLanguage |
Да |
string |
Соответствуете заголовку Accept-Language в браузере, используется для указания предпочтений клиента по языкам. |
sessionDetails.fingerprint |
Да |
string |
Подпись данных пользователя в запросе. см. https://github.com/fingerprintjs/fingerprintjs |
sessionDetails.ipAddress |
Да |
string |
IP адрес пользователя. |
sessionDetails.userAgent |
Да |
string |
Информацию о браузере, операционной системе и устройстве пользователя. |
urls.callback |
Да |
string |
URL для отправки уведомлений о статусе транзакции. |
customerAccount.bankName |
Да |
string |
Код и название банка, в который выполняется платеж.Возможные значения:| Код(значение поля bankName) | Название банка |
|---|
| abank | A-Bank | | abrossiya | АБ Россия | | absolyutbank | Абсолют Банк | | agroban | AgroBan | | agropromkredit | Кб Агропромкредит | | akbars | Акбарс Банк | | akbcentrokredit | АКБ Центрокредит | | akibank | Акибанк | | alefbank | Алеф Банк | | alfabank | Альфа-банк | | alif | Алиф Банк | | almazerjienbank | Алмазэргиэнбанк | | alokabank | AlokaBank | | altyn | AO Altyn Bank | | amanbank | РК АМАНБАНК | | amobile | A-mobile | | amrabank | Amra-Bank | | anor | Anor Bank | | apexbank | APEX BANK | | aresbank | Аресбанк | | asaka | Asaka Bank | | asiaalliance | Asia Alliance Bank | | atb | Азиатско Тихоокеанский Банк | | aurorabank | Aurora-Bank | | avangard | Банк Авангард | | avtofinans | Авто Финанс Банк | | avtogradbank | Автоградбанк | | avtotorgbank | Автоторгбанк | | ayyil | Айыл Банк | | azii | Банк Азии | | bakai | Бакай Банк | | bankagroros | Банк Агророс | | bankakcept | Банк Акцепт | | bankaleksandrovskiy | Банк Александровский | | bankavers | Банк Аверс | | bankbbr | Банк ББР | | bankbkf | Банк БКФ | | bankdomrf | Банк ДОМ.РФ | | bankekb | Банк Екатеринбург (Контур Банк) | | bankfinservis | Банк Финсервис | | bankhlynov | Банк Хлынов | | bankinteza | Банк Интеза | | bankipb | Банк ИПБ (Интерпрогрессбанк) | | bankiturup | Банк Итуруп | | bankkazani | Банк Казани | | bankkremlin | Банк Кремлевский | | bankmbamoskva | Банк МБА Москва | | bankmoskvasiti | Банк Москва Сити | | banknationalstandart | Банк Национальный Стандарт | | banknewcentury | Банк Новый Век | | bankorenburg | Банк Оренбург | | bankpskb | Банк ПСКБ | | bankraund | Банк Раунд | | bankrazvitiestolicza | Банк Развитие Столицы | | bankrbk | АО Bank RBK | | banksaratov | Банк Саратов | | banksiab | Банк СИАБ (Санкт-Петербургский Индустриальный Акционерный Банк) | | banksinara | Синара Банк | | banksnezinskiy | Банк Снежинский | | banksolidarnost | Банк Солидарность | | bankvbrr | Банк ВБРР (Всероссийский банк развития регионов) | | bankvenets | Банк Венец | | bankzareche | Банк Заречье | | bankzenit | Банк Зенит | | baytushum | Бай-Тушум Банк | | belgorodsocbank | Белгородсоцбанк (БС Банк) | | bereke | AO Bereke Bank | | bksbank | БКС Банк | | blank | Бланк Банк | | brb | BRB Bank | | bta | БТА Банк | | bystrobank | Быстробанк | | bzhfbank | БЖФ Банк | | centercredit | АО Банк Центр Кредит | | centrinvest | ЦентрИнвестБанк | | chelindbank | Челиндбанк | | chelyabinvestbank | Челябинвестбанк | | cmrbank | Цмрбанк | | creditevropabankrossiya | Кредит Европа Банк Россия | | dalnevostochnybank | Дальневосточный Банк | | databank | Датабанк | | davr | Davr Bank | | demirbank | DemirBank | | derzhava | Держава Банк | | dolinskbank | Долинск Банк | | doskredobank | Дос-Кредобанк | | driveclickbank | Драйв Клик Банк | | dushanbesiti | Душанбе Сити Банк | | ekspobank | Экспобанк | | elita | Банк Элита | | elplat | Элплат | | energobank | Энергобанк | | energotransbank | Энерготрансбанк | | eob | Енисейский Объединенный Банк | | eshata | Банк Эсхата | | eurasianbank | АО Евразийский банк | | evrofinansmosnarbank | АКБ Еврофинанс Моснарбанк | | faktura | Дбо Фактура | | ffin | Ффин Банк | | finam | Финам | | finanskreditbank | ФинансКредитБанк | | finka | ФИНКА Банк | | firstheartlandjusan | First Heartland Jusan Bank | | firstinvestmentbank | Первый Инвестиционный Банк | | forabank | Фора Банк | | forshtadt | Форштадт | | forte | AO ForteBank | | freedom | АО Банк Фридом Финанс Казахстан | | garantbank | Garant-Bank | | garantinvestbank | Гарант Инвест Банк | | gazenergobank | Газэнергобанк | | gazprombank | Газпромбанк | | gaztransbank | Газтрансбанк | | genbank | Генбанк | | gorbank | Горбанк (Петербургский Городской Банк) | | gutabank | Гута Банк | | hajsbank | Хайс Банк | | halkbank | HalkBank | | halykbank | HalykBank | | hamkorbank | HamkorBank | | hmb | ХМБ (Хакасский Муниципальный Банк) | | homecredit | ХоумКредитБанк | | homecreditkz | AO Home Credit Bank | | humo | Humo | | ikbank | ИК Банк (Инвестиционный Кооперативный Банк) | | inbank | Инбанк | | infinbank | InfinBank | | ingosstrahbank | Ингосстрах Банк | | ipakyuli | IpakYuli Bank | | ipotekabank | IpotekaBank | | ishbank | Ишбанк | | jandtbank | Джей энд Ти Банк (Реалист Банк) | | kapitalbankuzb | KapitalBank (Uzbekistan) | | kazpochta | АО Казпочта | | keremet | Керемет Банк | | kivibank | Киви Банк | | kompanon | Банк Компаньон | | koshelevbank | Кошелев Банк | | kredituralbank | Кредит Урал Банк | | krokusbank | Крокус Банк | | kubankredit | Кубань Кредит | | kubantorgbank | Кубаньторгбанк | | kuzneckbiznesbank | Кузнецкбизнесбанк | | kyirgyizskiyinvestitsionnokreditnyiy | Кыргызский Инвестиционно-Кредитный Банк | | kyirgyizstan | Коммерческий банк КЫРГЫЗСТАН | | lantabank | Ланта Банк | | leftbank | Банк Левобережный | | lichnayakassa | Личная касса | | lokobank | Локо Банк | | m10 | M10 | | mb | Мб Банк | | mbank | MBank | | megapay | MegaPay | | metallinvestbank | Металлинвестбанк | | metkombank | Меткомбанк | | mfk | Международный Финансовый Клуб | | mikrokredit | MikroKredit Bank | | mkb | МКБ (Московский Кредитный Банк) | | modulbank | Модульбанк | | monobank | Monobank | | morskojbank | Морской Банк | | moskombank | Москомбанк | | moskommertbank | Москоммерцбанк | | mosoblbank | Мособлбанк | | mp | Мп Банк | | msbankrus | МС Банк Рус | | mtsbank | МТС Банк | | mtsdengieksi | МТС Деньги (ЭКСИ Банк) | | nacinvestprombank | Нацинвестпромбанк (Национальный инвестиционно-промышленный банк) | | narodnyiykyirgyizstana | Народный Банк Кыргызстана | | nbdbank | НБД Банк | | nbu | NBU Bank | | nikobank | Нико Банк | | nkbank | НК Банк | | nkoyumani | НКО Юмани | | nokssbank | Ноксбанк | | northernpeoplebank | Северный Народный Банк | | norvikbank | Норвик Банк | | novikombank | Новикомбанк | | novobank | Новобанк | | nrbank | Акб Нрбанк | | nsbank | НС Банк | | octobank | OctoBank | | odengi | O!dengi | | openbank | Банк Открытие | | optima | Оптима Банк | | oranzhevyj | Банк Оранжевый | | orientfinbank | OrientFinBank | | otpbank | ОТП Банк | | ozonbank | Озон-банк | | paynet | Paynet | | pervyjdortransbank | Первый Дортрансбанк | | plajt | Плайт | | platezhnyjkonstruktor | Рнко Платежный Конструктор | | pojdyom | Кб Пойдём! | | postbank | Post Bank | | primore | АКБ Приморье | | primsocbank | Примсоцбанк | | priovneshtorgbank | Прио Внешторгбанк | | privatbank | PrivatBank | | probank | ПроБанк (Профессионал Банк) | | psb | ПСБ (ПромСвязь Банк) | | pumb | Pumb | | raiffeisen | Райффайзенбанк | | realistbank | Реалист Банк | | renessanscredit | Ренессанс Кредит | | resocredit | Ресо Кредит | | rnkb | РНКБ | | rosbank | Росбанк | | rosdorbank | Росдорбанк | | rostfinans | КБ Ростфинанс | | rsb | РСБ (Банк Русский Стандарт) | | rshb | Россельхозбанк | | rsk | РСК Банк | | rusnarbank | Руснарбанк | | rusuniversalbank | Русский Универсальный Банк | | sanktpeterburg | Банк Санкт-Петербург | | sberbank | Сбербанк | | sberbankabh | Sberbank (ABH) | | sbibank | Эс Би Ай Банк | | sdmbank | СДМ Банк | | severgazbank | Севергазбанк | | sibsocbank | Сибсоцбанк | | simbank | Simbank | | sinkobank | Синко Банк | | sitibank | Ситибанк | | slaviya | Славия Банк | | smpbank | СМП Банк (Банк Северный Морской Путь) | | sngb | СНГБ (Сургутнефтегазбанк) | | sociumbank | Социум Банк | | solidbank | Солид Банк | | sovcombank | Совкомбанк | | spitamen | Спитамен Банк | | sqb | SQB Bank | | strojlesbank | Стройлесбанк | | tascombank | Tascombank | | tatsocbank | Татсоцбанк | | tavricheskijbank | Таврический Банк | | tbc | TBC Bank | | tenderbank | АКБ Тендер Банк | | tengebank | TengeBank | | timerbank | Таймер Банк | | tinkoff | Т-Банк | | tkb | Ткб Банк | | tochkabank | Точка банк | | tochkafkopen | Точка ФК Открытие | | togliattichembank | Тольяттихимбанк | | tomskpromstrojbank | Томскпромстройбанк | | toyotabank | Тойота Банк | | transstrojbank | Трансстройбанк | | trastpay | Trastpay | | turon | Turon Bank | | ubrir | УБРиР | | uglemetbank | Углеметбанк | | unicreditbank | ЮникредитБанк | | unistrim | КБ Юнистрим | | unitedcapitalbank | Банк Объединенный Капитал | | universalbank | Universal-Bank | | uralfd | Урал ФД | | uralfinans | Уралфинанс Банк | | uralprombank | Уралпромбанк | | uralsibbank | Банк Уралсиб | | uzcard | Uzcard | | uzum | Uzum Bank | | vladbiznesbank | Владбизнесбанк | | vneshfinbank | Внешфинбанк | | vtb | ВТБ | | vuzbank | ВУЗ Банк | | wildberries | Вайлдберриз Банк | | xazna | Xazna Bank | | yandexbank | Яндекс-банк | | yarinterbank | Икбр Яринтербанк | | yuginvestbank | Юг Инвестбанк | | zemskijbank | Земский Банк | | ziraat | Ziraat Bank |
|
trafficSegment |
Нет |
string |
Сегмент трафика. Задается через валютный счет. |
riskGroupCode |
Нет |
string |
Код рисковой группы пользователя. Задается через валютный счет. |
Ответ возвращается в формате JSON.
1. Успешный ответ (статус 200)
При успешном выполнении запроса API возвращает ответ со статусом 200 OK и следующей структурой:
{
"amount": 4000,
"currency": "RUB",
"id": 467343,
"status": "NEW"
}
Описание полей ответа:
| Наименование |
Тип |
Обязательное? |
Описание |
| id |
integer |
Да |
Идентификатор ордера для выполненного платежа. Может содержать значение 0, если ордер не был создан по причине отсутствия настроенных маршрутов, некорректных данных для создания ордера и других случаев. |
| amount |
integer |
Да |
Сумма платежа |
| currency |
string |
Да |
Валюта платежа |
| status |
string |
Да |
Код статуса выполнения платежа.Возможные значения- ERROR
- IN_PROGRESS
- COMPLETED
- DECLINED
- INVALID
|
| error |
string |
Нет |
Содержит текстовое описание ошибки, в случае, если статус = ERROR |
2. Ошибка доступа (статус 403)
Если подпись некорректна, секретный ключ не совпадает с ключом, зарегистрированном в системе B2B Backoffice, отсутствует или неактивно приложение, определенное в заголовке запроса X-Client-Id, то API вернет ответ со статусом 403 Forbidden
{
"success": false,
"message": "access denied"
}
3. Ошибка валидации (статус 422)
Если не удается создать ордер по переданному body, то срабатывает ошибка валидации
{
"success": false,
"message": "data validation error for: payment.amount - Value is required"
}
4. Внутренняя ошибка (статус 500)
При внутренней ошибке:
{
"success": false,
"message": "internal error"
}
- Выплаты не переводятся в статус EXPIRED по истечению 72 часов. По зависшим ордерам необходимо написать техподдержке (tg @BillingTechSupport).