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. |
Content-Type |
Да |
Должно быть application/json. |
X-Signature |
Да |
`Подпись запроса по секретному ключу приложения в системе B2B Backoffice и v2 алгоритму. Алгоритм формирования описан на странице “Подпись”. |
X-Timestamp |
Да |
Unix-секунды UTC на момент формирования подписи (например, 1717000000). Окно валидности — ±5 минут от серверного времени, иначе запрос отбивается. |
X-Nonce |
Да |
Одноразовая случайная строка (рекомендуется UUID v4). Сервер запоминает nonce в течение окна валидности и отбивает повтор. |
Структура тела запроса:
Тело запроса должно быть в формате JSON и иметь следующую структуру:
curl --location 'https://api-gateway.sandbox.idynsys.org/api/accounts/external-app/withdrawal' \
--header 'X-Client-Id: {{xClientId}}' \
--header 'X-Signature: {{xSignature}}' \
--header 'X-Timestamp: {{xTimestamp}}' \
--header 'X-Nonce: {{xNonce}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"paymentMethodName": "OnlineBanking",
"communicationType": "h2h",
"skipTerminalFlow": false,
"payment": {
"amount": 4000.00,
"currency": "PHP"
},
"merchantOrder": {
"id": "d07d573f-fc62-4652-8b35-9b4a9a9d2ed3",
"description": "desc"
},
"urls": {
"callback": "https://callback.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",
"email": "example@mail.com"
},
"customerAccount": {
"bankName": "NORTH EAST SMALL FINANCE BANK LIMITED",
"pan": "8310021622",
"bankName": "NORTH EAST SMALL FINANCE BANK LIMITED"
}
}'
В следующей таблице информация об обязательности атрибутов для платежного метода OnlineBanking WITHDRAWAL H2H в рамках ПС Monetix:
| Поле |
Обязательное |
Тип |
Описание |
paymentMethodName |
Да |
string |
Код метода оплаты. Возможные значения> |
communicationType |
Да |
string |
Тип коммуникации для выполнения платежа. Возможные значения: |
skipTerminalFlow |
Нет |
boolean |
Признак пропуска редиректа на платежный терминал. По умолчанию false. Если передано true, в ответе не будет возвращено поле redirectUrl, а дальнейшая обработка платежа должна выполняться на стороне мерчанта через urls.callback. |
trafficType |
Нет |
string |
Тип трафика. Возможные значения: |
payment.amount |
Да |
float |
Сумма платежа. Допустимые значения - больше 0. Если передается значение с дробной частью, то оно может округляться по правилам платежной системы. |
payment.currency |
Да |
string |
3-х значный буквенный код валюты платежа по ISO 4217. |
merchantOrder.id |
Да |
string |
Идентификатор ордера клиента (организации заказчика).
Регулярное выражение для валидации: ^[a-zA-Z0-9_-]+$ |
merchantOrder.description |
Да |
string |
Описание ордера клиента.
Регулярное выражение для валидации: ^.{1,512}$ |
customer.id |
Да |
string |
Идентификатор пользователя в магазине, который выполняет платеж.
Регулярное выражение для валидации: ^[a-zA-Z0-9_-]+$ |
customer.firstName |
Да |
string |
Имя плательщика латиницей.
Регулярное выражение для валидации: ^(?:\p{L}[\p{L}\p{M}]*(?:['’‘ʼʻ]\p{L}[\p{L}\p{M}]*)*\|(?:\p{L}\.)+)(?:(?:\p{Zs}\|\p{Zs}*[-‐‑‒–—−]\p{Zs}*)(?:\p{L}[\p{L}\p{M}]*(?:['’‘ʼʻ]\p{L}[\p{L}\p{M}]*)*\|(?:\p{L}\.)+))*$ |
customer.lastName |
Да |
string |
Фамилия плательщика латиницей.
Регулярное выражение для валидации: ^(?:\p{L}[\p{L}\p{M}]*(?:['’‘ʼʻ]\p{L}[\p{L}\p{M}]*)*\|(?:\p{L}\.)+)(?:(?:\p{Zs}\|\p{Zs}*[-‐‑‒–—−]\p{Zs}*)(?:\p{L}[\p{L}\p{M}]*(?:['’‘ʼʻ]\p{L}[\p{L}\p{M}]*)*\|(?:\p{L}\.)+))*$ |
customer.email |
Да |
string |
Электронная почта пользователя, который выполняет платеж.
Регулярное выражение для валидации: ^[a-zA-Z0-9](?:[^@\s]*[^@\s.])?@[^@\s]+\.[^@\s]*[^@\s.]$ |
sessionDetails.acceptLanguage |
Да |
string |
Соответствуете заголовку Accept-Language в браузере, используется для указания предпочтений клиента по языкам. |
sessionDetails.fingerprint |
Да |
string |
Подпись данных пользователя в запросе. см. https://github.com/fingerprintjs/fingerprintjs |
sessionDetails.ipAddress |
Да |
string |
IP адрес пользователя.
Регулярное выражение для валидации: ^((25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)\.){3}(25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)$ |
sessionDetails.userAgent |
Да |
string |
Информацию о браузере, операционной системе и устройстве пользователя.
Регулярное выражение для валидации: ^[\p{L}\p{N}\s./:;,()\[\]{}+=_-]+$ |
customerAccount.bankName |
Да |
string |
Код и название банка, в который выполняется платеж.Возможные значения:| Код(значение поля bankName) | Название банка |
|---|
| alamanahislamicbank | AL AMANAH ISLAMIC BANK | | allbank | All Bank | | asiaunitedbank | ASIA UNITED BANK | | aubonlinecashpayment | AUB Online Cash Payment | | australianewzealandbank | AUSTRALIA NEW ZEALAND BANK | | bananafintechservicescorporation | BANANA FINTECH SERVICES CORPORATION | | bangkokabayan | BANGKO KABAYAN | | bangkokbankpubliccoltd | BANGKOK BANK PUBLIC CO LTD | | bangkomabuhay | Bangko Mabuhay | | bangkonuestrasenoradelpilar | BANGKO NUESTRA SENORA DEL PILAR | | bankofamerica | BANK OF AMERICA | | bankofchina | Bank of China | | bankofcommerce | Bank of Commerce | | bankofflorida | BANK OF FLORIDA | | bankofmakati | BANK OF MAKATI | | bankofmontalbaninc | BANK OF MONTALBAN INC | | bayadcenter | Bayad Center | | bayanihanbank | BAYANIHAN BANK | | bdocorporateinternetbanking | BDO Corporate Internet Banking | | bdonetworkbankinc | BDO Network Bank Inc | | bdounibankinc | BDO Unibank Inc | | binangonanruralbank | Binangonan Rural Bank | | binanruralbankinc | BINAN RURAL BANK INC | | bpidirectbankoincasavingsbank | BPI Direct BanKO Inc A Savings Bank | | bpiexpressonlinemobilefundtransfer | BPI ExpressOnline Mobile Fund Transfer | | bpifamilybank | BPI Family Bank | | camaligbank | Camalig Bank | | cantilanbank | Cantilan Bank | | cardbank | CARD Bank | | cardsmebankinc | CARD SME BANK INC | | cathayunitedbankcoltd | CATHAY UNITED BANK CO LTD | | cebulanahuilierruralbank | Cebuana Lhuilier Rural Bank | | centurysavingsbank | CENTURY SAVINGS BANK | | chinabankonline | Chinabank Online | | chinabanksavings | Chinabank Savings | | chinatrust | Chinatrust | | cimbbankphilippinesinc | CIMB BANK PHILIPPINES INC | | citibankna | Citibank NA | | citysavingsbank | CITY SAVINGS BANK | | communityruralbankofrombloninc | Community Rural Bank of Romblon Inc | | cooperativebankofquezonprovince | COOPERATIVE BANK OF QUEZON PROVINCE | | countrybuildersbankinc | COUNTRY BUILDERS BANK INC | | ctbcbank | CTBC Bank | | dcpayphilippinesinc | DCPay Philippines Inc | | deutschebank | Deutsche Bank AG | | developmentbankofthephilippines | Development Bank of the Philippines | | dmbank | DM BANK | | dumaugetecitydevelopmentbankinc | Dumaugete City Development Bank Inc | | dungganonbank | Dungganon Bank | | eastwestbankingcorporation | East West Banking Corporation | | eastwestruralbank | East West Rural Bank | | entrepreneurruralbankinc | Entrepreneur Rural Bank Inc | | equicomsavingsbank | Equicom Savings Bank | | filidianruralbankofantipolo | FILIDIAN RURAL BANK OF ANTIPOLO | | firstconsolidatedbank | FIRST CONSOLIDATED BANK | | gatewayruralbank | GATEWAY RURAL BANK | | gmbankofluzoninc | GM BANK OF LUZON INC | | gotymebank | GoTyme Bank | | guaguaruralbank | GUAGUA RURAL BANK | | gxchange | G Xchange | | hkandshanghaibankingcorp | HK AND SHANGHAI BANKING CORP | | hsbcsavingsbankphils | HSBC SAVINGS BANK PHILS | | industrialbankofkoreamanila | INDUSTRIAL BANK OF KOREA MANILA | | industrialcommercialbankofchina | INDUSTRIAL COMMERCIAL BANK OF CHINA | | ingbanknv | ING Bank NV | | innovativebank | INNOVATIVE BANK | | islabankathriftbankinc | Isla Bank A Thrift Bank Inc | | jpmorganchasebank | JPMORGAN CHASE BANK | | kebhanabank | KEB HANA BANK | | lagunaprestigebankingcorporation | LAGUNA PRESTIGE BANKING CORPORATION | | landbankatmonline | Landbank ATM Online | | landbankcasa | Landbank CA SA | | landbankofbank | LANDBANK OFBank | | legazpisavingsbank | LEGAZPI SAVINGS BANK | | lolcbankphilippines | LOLC BANK PHILIPPINES | | lulufinancialservicesphilsinc | LULU FINANCIAL SERVICES PHILS INC | | luzondevelopmentbank | Luzon Development Bank | | malarayatruralbank | MALARAYAT RURAL BANK | | malayanbanksavings | Malayan Bank Savings | | mayabankmomoinstapayegp | Maya Bank Instapay | | mayabankpesonet | Maya Bank Pesonet | | maybank | Maybank | | maybankonlinebanking | Maybank Online Banking | | maybankphilsinc | Maybank Phils Inc | | megaintlcmmlbankcoltd | MEGA INTL CMML BANK CO LTD | | megaruralbanklucenacity | MEGA RURAL BANK LUCENA CITY | | metrobank | Metrobank | | metrosouthcooperativebank | METROSOUTH COOPERATIVE BANK | | mindanaoconsolidatedcooperative | MINDANAO CONSOLIDATED COOPERATIVE | | mizuhobank | MIZUHO BANK | | moneymallruralbank | MONEY MALL RURAL BANK | | mufgbankltd | MUFG BANK LTD | | mvsmbankruralbank | MVSM BANK RURAL BANK | | netbankruralbankinc | Netbank Rural Bank Inc | | newruralbankofsanleonardo | NEW RURAL BANK OF SAN LEONARDO | | omnipayinc | Omnipay Inc | | ownbank | Own Bank | | pacificacesavingsbank | Pacific Ace Savings Bank | | partnerruralbankcotabatoinc | Partner Rural Bank Cotabato Inc | | paymayaphilippinesinc | Paymaya Philippines Inc | | paymongopaymentsinc | PAYMONGO PAYMENTS INC | | pbcom | PBCom | | philippinebankofcommunications | Philippine Bank of Communications | | philippinebusinessbank | PHILIPPINE BUSINESS BANK | | philippinebusinessbankasavingsbank | Philippine Business Bank A Savings Bank | | philippinedigitalassetexchangemomoinstapayegp | PHILIPPINE DIGITAL ASSET EXCHANGE INSTAPAY | | philippinedigitalassetexchangepesonet | PHILIPPINE DIGITAL ASSET EXCHANGE PESONET | | philippinenationalbankpesonet | Philippine National Bank Pesonet | | philippinesavingsbank | Philippine Savings Bank | | philippinetrustcompany | Philippine Trust Company | | philippineveteransbank | Philippine Veterans Bank | | philtrustbank | Philtrust Bank | | pnbebankingbillspayment | PNB e Banking Bills Payment | | pnbebankingmomoinstapayegp | PNB E Banking Instapay | | pnbsavingsbank | PNB Savings Bank | | poracruralbank | PORAC RURAL BANK | | producerssavingsbankcorporation | Producers Savings Bank Corporation | | psbank | PSBank | | queencitydevelopmentbankinc | Queen City Development Bank Inc | | quezoncapitalruralbank | Quezon Capital Rural Bank | | rangaybank | Rang Ay Bank | | rbtruralbank | RBT RURAL BANK | | rcbconlinebanking | RCBC Online Banking | | robinsonsbankcorporation | ROBINSONS BANK CORPORATION | | robinsonsbankonlinebillspayment | RobinsonsBank Online Bills Payment | | ruralbankofbacolodcity | RURAL BANK OF BACOLOD CITY | | ruralbankofbauang | RURAL BANK OF BAUANG | | ruralbankofcauayanincorporated | RURAL BANK OF CAUAYAN INCORPORATED | | ruralbankofdigos | RURAL BANK OF DIGOS | | ruralbankofguinobataninc | Rural Bank of Guinobatan Inc | | ruralbankoflapaz | RURAL BANK OF LA PAZ | | ruralbankoflebak | RURAL BANK OF LEBAK | | ruralbankofrosario | RURAL BANK OF ROSARIO | | ruralbankofsagay | RURAL BANK OF SAGAY | | ruralbankofsanmedjugorje | RURAL BANK OF SAN MEDJUGORJE | | ruralbankofstaignacia | RURAL BANK OF STA IGNACIA | | seabankphilippines | SeaBank Philippines | | securitybankonlinetransfer | Security Bank Online Transfer | | shinhanbank | SHINHAN BANK | | standardchartered | Standard Chartered Bank | | starpaycorporation | Starpay Corporation | | sterling | Sterling Bank | | sumitomomitsuibankingcorp | SUMITOMO MITSUI BANKING CORP | | sunsavingsbank | Sun Savings Bank | | tayocashinc | TAYOCASH INC | | tonikbank | Tonik Bank | | tonikdigitalbankinc | TONIK DIGITAL BANK INC | | topjuantechcorporation | Topjuan Tech Corporation | | traxionpayinc | TRAXION PAY INC | | ucpbconnect | UCPB Connect | | ucpbsavingsbank | UCPB Savings Bank | | unionbankeon | Unionbank EON | | unionbankinternetbanking | Unionbank Internet Banking | | unionbankphl | Union Bank (Philippines) | | uniondigitalbank | UnionDigital Bank | | unitedcoconutplantersbank | United Coconut Planters Bank | | unitedoverseasbank | United Overseas Bank | | unobank | UNObank | | usscmoneyservicesinc | USSC Money Services Inc | | veteransbank | Veterans Bank | | wealthdevelopmentbankcorporation | Wealth Development Bank Corporation | | yuantasavingsbank | Yuanta Savings Bank | | zambalesruralbank | ZAMBALES RURAL BANK | | zybitechinc | ZYBI Tech Inc |
Регулярное выражение для валидации: ^[\p{L}\p{N}\s&'_-]+$ |
customerAccount.pan |
Да |
string |
Номер электронного или банковского счёта
Регулярное выражение для валидации: ^[a-zA-Z0-9](?:[a-zA-Z0-9.@-]*[a-zA-Z0-9])?$$ |
customerAccount.bankName |
Да |
string |
Код и название банка, в который выполняется платеж.Возможные значения:| Код(значение поля bankName) | Название банка |
|---|
| alamanahislamicbank | AL AMANAH ISLAMIC BANK | | allbank | All Bank | | asiaunitedbank | ASIA UNITED BANK | | aubonlinecashpayment | AUB Online Cash Payment | | australianewzealandbank | AUSTRALIA NEW ZEALAND BANK | | bananafintechservicescorporation | BANANA FINTECH SERVICES CORPORATION | | bangkokabayan | BANGKO KABAYAN | | bangkokbankpubliccoltd | BANGKOK BANK PUBLIC CO LTD | | bangkomabuhay | Bangko Mabuhay | | bangkonuestrasenoradelpilar | BANGKO NUESTRA SENORA DEL PILAR | | bankofamerica | BANK OF AMERICA | | bankofchina | Bank of China | | bankofcommerce | Bank of Commerce | | bankofflorida | BANK OF FLORIDA | | bankofmakati | BANK OF MAKATI | | bankofmontalbaninc | BANK OF MONTALBAN INC | | bayadcenter | Bayad Center | | bayanihanbank | BAYANIHAN BANK | | bdocorporateinternetbanking | BDO Corporate Internet Banking | | bdonetworkbankinc | BDO Network Bank Inc | | bdounibankinc | BDO Unibank Inc | | binangonanruralbank | Binangonan Rural Bank | | binanruralbankinc | BINAN RURAL BANK INC | | bpidirectbankoincasavingsbank | BPI Direct BanKO Inc A Savings Bank | | bpiexpressonlinemobilefundtransfer | BPI ExpressOnline Mobile Fund Transfer | | bpifamilybank | BPI Family Bank | | camaligbank | Camalig Bank | | cantilanbank | Cantilan Bank | | cardbank | CARD Bank | | cardsmebankinc | CARD SME BANK INC | | cathayunitedbankcoltd | CATHAY UNITED BANK CO LTD | | cebulanahuilierruralbank | Cebuana Lhuilier Rural Bank | | centurysavingsbank | CENTURY SAVINGS BANK | | chinabankonline | Chinabank Online | | chinabanksavings | Chinabank Savings | | chinatrust | Chinatrust | | cimbbankphilippinesinc | CIMB BANK PHILIPPINES INC | | citibankna | Citibank NA | | citysavingsbank | CITY SAVINGS BANK | | communityruralbankofrombloninc | Community Rural Bank of Romblon Inc | | cooperativebankofquezonprovince | COOPERATIVE BANK OF QUEZON PROVINCE | | countrybuildersbankinc | COUNTRY BUILDERS BANK INC | | ctbcbank | CTBC Bank | | dcpayphilippinesinc | DCPay Philippines Inc | | deutschebank | Deutsche Bank AG | | developmentbankofthephilippines | Development Bank of the Philippines | | dmbank | DM BANK | | dumaugetecitydevelopmentbankinc | Dumaugete City Development Bank Inc | | dungganonbank | Dungganon Bank | | eastwestbankingcorporation | East West Banking Corporation | | eastwestruralbank | East West Rural Bank | | entrepreneurruralbankinc | Entrepreneur Rural Bank Inc | | equicomsavingsbank | Equicom Savings Bank | | filidianruralbankofantipolo | FILIDIAN RURAL BANK OF ANTIPOLO | | firstconsolidatedbank | FIRST CONSOLIDATED BANK | | gatewayruralbank | GATEWAY RURAL BANK | | gmbankofluzoninc | GM BANK OF LUZON INC | | gotymebank | GoTyme Bank | | guaguaruralbank | GUAGUA RURAL BANK | | gxchange | G Xchange | | hkandshanghaibankingcorp | HK AND SHANGHAI BANKING CORP | | hsbcsavingsbankphils | HSBC SAVINGS BANK PHILS | | industrialbankofkoreamanila | INDUSTRIAL BANK OF KOREA MANILA | | industrialcommercialbankofchina | INDUSTRIAL COMMERCIAL BANK OF CHINA | | ingbanknv | ING Bank NV | | innovativebank | INNOVATIVE BANK | | islabankathriftbankinc | Isla Bank A Thrift Bank Inc | | jpmorganchasebank | JPMORGAN CHASE BANK | | kebhanabank | KEB HANA BANK | | lagunaprestigebankingcorporation | LAGUNA PRESTIGE BANKING CORPORATION | | landbankatmonline | Landbank ATM Online | | landbankcasa | Landbank CA SA | | landbankofbank | LANDBANK OFBank | | legazpisavingsbank | LEGAZPI SAVINGS BANK | | lolcbankphilippines | LOLC BANK PHILIPPINES | | lulufinancialservicesphilsinc | LULU FINANCIAL SERVICES PHILS INC | | luzondevelopmentbank | Luzon Development Bank | | malarayatruralbank | MALARAYAT RURAL BANK | | malayanbanksavings | Malayan Bank Savings | | mayabankmomoinstapayegp | Maya Bank Instapay | | mayabankpesonet | Maya Bank Pesonet | | maybank | Maybank | | maybankonlinebanking | Maybank Online Banking | | maybankphilsinc | Maybank Phils Inc | | megaintlcmmlbankcoltd | MEGA INTL CMML BANK CO LTD | | megaruralbanklucenacity | MEGA RURAL BANK LUCENA CITY | | metrobank | Metrobank | | metrosouthcooperativebank | METROSOUTH COOPERATIVE BANK | | mindanaoconsolidatedcooperative | MINDANAO CONSOLIDATED COOPERATIVE | | mizuhobank | MIZUHO BANK | | moneymallruralbank | MONEY MALL RURAL BANK | | mufgbankltd | MUFG BANK LTD | | mvsmbankruralbank | MVSM BANK RURAL BANK | | netbankruralbankinc | Netbank Rural Bank Inc | | newruralbankofsanleonardo | NEW RURAL BANK OF SAN LEONARDO | | omnipayinc | Omnipay Inc | | ownbank | Own Bank | | pacificacesavingsbank | Pacific Ace Savings Bank | | partnerruralbankcotabatoinc | Partner Rural Bank Cotabato Inc | | paymayaphilippinesinc | Paymaya Philippines Inc | | paymongopaymentsinc | PAYMONGO PAYMENTS INC | | pbcom | PBCom | | philippinebankofcommunications | Philippine Bank of Communications | | philippinebusinessbank | PHILIPPINE BUSINESS BANK | | philippinebusinessbankasavingsbank | Philippine Business Bank A Savings Bank | | philippinedigitalassetexchangemomoinstapayegp | PHILIPPINE DIGITAL ASSET EXCHANGE INSTAPAY | | philippinedigitalassetexchangepesonet | PHILIPPINE DIGITAL ASSET EXCHANGE PESONET | | philippinenationalbankpesonet | Philippine National Bank Pesonet | | philippinesavingsbank | Philippine Savings Bank | | philippinetrustcompany | Philippine Trust Company | | philippineveteransbank | Philippine Veterans Bank | | philtrustbank | Philtrust Bank | | pnbebankingbillspayment | PNB e Banking Bills Payment | | pnbebankingmomoinstapayegp | PNB E Banking Instapay | | pnbsavingsbank | PNB Savings Bank | | poracruralbank | PORAC RURAL BANK | | producerssavingsbankcorporation | Producers Savings Bank Corporation | | psbank | PSBank | | queencitydevelopmentbankinc | Queen City Development Bank Inc | | quezoncapitalruralbank | Quezon Capital Rural Bank | | rangaybank | Rang Ay Bank | | rbtruralbank | RBT RURAL BANK | | rcbconlinebanking | RCBC Online Banking | | robinsonsbankcorporation | ROBINSONS BANK CORPORATION | | robinsonsbankonlinebillspayment | RobinsonsBank Online Bills Payment | | ruralbankofbacolodcity | RURAL BANK OF BACOLOD CITY | | ruralbankofbauang | RURAL BANK OF BAUANG | | ruralbankofcauayanincorporated | RURAL BANK OF CAUAYAN INCORPORATED | | ruralbankofdigos | RURAL BANK OF DIGOS | | ruralbankofguinobataninc | Rural Bank of Guinobatan Inc | | ruralbankoflapaz | RURAL BANK OF LA PAZ | | ruralbankoflebak | RURAL BANK OF LEBAK | | ruralbankofrosario | RURAL BANK OF ROSARIO | | ruralbankofsagay | RURAL BANK OF SAGAY | | ruralbankofsanmedjugorje | RURAL BANK OF SAN MEDJUGORJE | | ruralbankofstaignacia | RURAL BANK OF STA IGNACIA | | seabankphilippines | SeaBank Philippines | | securitybankonlinetransfer | Security Bank Online Transfer | | shinhanbank | SHINHAN BANK | | standardchartered | Standard Chartered Bank | | starpaycorporation | Starpay Corporation | | sterling | Sterling Bank | | sumitomomitsuibankingcorp | SUMITOMO MITSUI BANKING CORP | | sunsavingsbank | Sun Savings Bank | | tayocashinc | TAYOCASH INC | | tonikbank | Tonik Bank | | tonikdigitalbankinc | TONIK DIGITAL BANK INC | | topjuantechcorporation | Topjuan Tech Corporation | | traxionpayinc | TRAXION PAY INC | | ucpbconnect | UCPB Connect | | ucpbsavingsbank | UCPB Savings Bank | | unionbankeon | Unionbank EON | | unionbankinternetbanking | Unionbank Internet Banking | | unionbankphl | Union Bank (Philippines) | | uniondigitalbank | UnionDigital Bank | | unitedcoconutplantersbank | United Coconut Planters Bank | | unitedoverseasbank | United Overseas Bank | | unobank | UNObank | | usscmoneyservicesinc | USSC Money Services Inc | | veteransbank | Veterans Bank | | wealthdevelopmentbankcorporation | Wealth Development Bank Corporation | | yuantasavingsbank | Yuanta Savings Bank | | zambalesruralbank | ZAMBALES RURAL BANK | | zybitechinc | ZYBI Tech Inc |
Регулярное выражение для валидации: ^[\p{L}\p{N}\s&'_-]+$ |
urls.callback |
Да |
string |
URL для отправки уведомлений о статусе транзакции. |
trafficSegment |
Нет |
string |
Сегмент трафика. Задается через валютный счет. |
riskGroupCode |
Нет |
string |
Код рисковой группы пользователя. Задается через валютный счет. |
Ответ возвращается в формате JSON.
1. Успешный ответ (статус 200)
При успешном выполнении запроса API возвращает ответ со статусом 200 OK и следующей структурой:
{
"amount": 4000,
"currency": "PHP",
"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).
Система отправляет коллбек на указанный в urls.callback адрес. Структура коллбека:
{
"id": 223344,
"status": "COMPLETED",
"amount": 4000,
"currency": "PHP",
"error": "",
"merchantClientId": "881100",
"merchantOrderId": "d07d573f-fc62-4652-8b35-9b4a9a9d2ed3",
"paymentMethod": "OnlineBanking",
"paymentSystem": "Monetix",
"trafficType": "ftd",
"trafficSegment": ""
}
| Наименование |
Тип |
Обязательность |
Описание |
id |
integer |
Да |
ID ордера, созданного для платежа на стороне системы биллинга. |
status |
string |
Да |
Текущий статус ордера системы биллинга. Возможные значения:- ERROR (терминальный статус, ошибка при обработке заявки в системе биллинга, либо всех ПС по каскаду на стороне ПС)
- IN_PROGRESS (заявка в обработке на стороне платежной системы, также ожидание оплаты пользаветеля)
- COMPLETED (терминальный статус, заявка успешно обработана, платеж проведен)
- EXPIRED (терминальный статус, время ожидания оплаты прошло)
- DECLINED (терминальный статус, все ПС по каскаду отклонили платеж)
- REFUND (терминальный статус, возврат по операции успешно выполнен)
- CANCELLED_BY_MERCHANT (терминальный статус, заявка отменена мерчантом до завершения платежа)
- CANCELLED_BY_CLIENT (терминальный статус, заявка отменена пользователем)
- RETRY_CANCELLED_BY_MERCHANT (терминальный статус, повторный платёж/ретрай отменён мерчантом)
- PENDING (заявка на выплату ожидает подтверждения менеджером, если в системе биллинга не настроено автоподтверждение)
- INVALID (терминальный статус, может возникуть на этапе валидации как самих данных в запросе, так и при проверки платежных данных в блеклистах до момента отправки данных в ПС)
- WAITING_CONFIRMATION (платёж создан, требуется подтверждение от пользователя или внешней системы)
|
amount |
float |
Да |
Сумма платежа. |
currency |
string |
Да |
Валюта плаежа. 3-х значный буквенный код валюты платежа по ISO 4217. |
error |
string |
Нет |
Ошибка от ПС. |
merchantOrderId |
string |
Да |
ID ордера клиента. |
merchantClientId |
Да |
string |
ID пользователя в системе клиента, который выполняет платеж. |
sessionId |
string |
Нет |
Идентификатор сессии в терминале |
bonusCode |
string |
Нет |
Бонус-код, указанный при создании ордера |
trafficSegment |
Нет |
string |
Сегмент трафика. |
trafficType |
Нет |
string |
Тип трафика. Возможные значения: |
paymentMethod |
Нет |
string |
Платежный метод. |
paymentSystem |
Нет |
string |
Платежная система. |