Для выполнения платежей через терминал необходимо получить персональную ссылку для открытия терминала. Ссылка содержит персональный код, который регистрируется в терминале и позволит открыть терминал и выполнить платеж. Время жизни ссылки ограничено, на сегодняшний день оно составляет 60 минут. Если в течение этого времени не был произведен платеж, то персональный код для открытия сессии становится недействительным.
Каждое приложение, которое выполняет запрос на получение персональной ссылки для открытия сессии терминала должно быть зарегистрировано в системе B2B Backoffice. Приложение, из которого выполняется получение персональной ссылки для открытия сессии терминала, должно иметь Client ID приложения, из которого выполняется запрос, а также секретный ключ, при помощи которого необходимо формировать подпись запроса.
URL:
- Тестовое окружение:
https://payment-terminal-form.sandbox.idynsys.org/api/auth/personal-url
- Продакшн окружение:
https://pay.trustedskycenter.com/api/auth/personal-url
Метод запроса: POST
Заголовки запросе:
X-Client-Id: (обязательно). Идентификатор приложения, получаемый при регистрации приложения в системе B2B BackofficeX-Authorization-Sign: (обязательно). Подпись запроса по секретному ключу приложения, который определяется в системе B2B Backoffice. Подпись формируется по алгоритму, описанному на странице “Подпись”Content-Type: (обязательно) Тип содержимого запроса, должно быть 'application/json'.
Структура тела запроса:
Тело запроса должно быть в формате JSON и иметь следующую структуру:
curl --location 'https://payment-terminal-form.sandbox.idynsys.org/api/auth/personal-url' \
--header 'X-Client-Id: {{xClientId}}' \
--header 'X-Authorization-Sign: {{xAuthorizationSign}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"paymentInfo": {
"type": "withdrawal",
"amount": 5001,
"currency": "PHP",
"merchantOrderId": "234345",
"merchantOrderDescription": "withdrawal for order"
},
"sessionSettings": {
"clientTheme": "dark",
"clientLanguage": "eng",
"visibleMethods": [
{
"paymentMethodName": "OnlineBanking",
"communicationType": "h2h"
}
]
},
"urls": {
"redirectSuccess": "https://website.com/redirectSuccess",
"redirectFail": "https://website.com/redirectFail",
"return": "https://website.com/return",
"callback": "https://website.com/callback"
},
"userInfo": {
"externalId": "112345",
"trafficSegment": "VIP",
"trafficType": "ftd",
"riskGroupCode": "LOW",
"firstName": "Ivan",
"lastName": "Ivanov",
"email": "example@mail.com"
},
"userAccount": {
"bankName": "NORTH EAST SMALL FINANCE BANK LIMITED",
"pan": "8310021622",
"bankName": "NORTH EAST SMALL FINANCE BANK LIMITED"
}
}'
Поля в paymentInfo:
| Наименование |
Обязательное? |
Тип |
Описание |
paymentInfo.type |
Да |
string |
Тип платежа - withdrawal |
paymentInfo.amount |
Нет |
float |
Сумма платежа. Допустимые значения - больше 0. Если передается значение с дробной частью, то оно может округляться по правилам платежной системы.- Если клиент не передаёт
paymentInfo.amount или он равен 0, то сумма выбирается внутри терминала - на экране, по тем лимитам и вариантам, которые заданы в presetAmounts. - Лимиты для методов оплаты задаются в админке. Есть возможность указать быстрые суммы для выбора через
presetAmounts в sessionSettings. - Если amount передан (любое значение > 0) - терминал использует эту сумму как фиксированную — пользователь не сможет изменить её на экране. presetAmounts при данном условии игнорируется (если даже передан).
|
paymentInfo.currency |
Да |
string |
3-х значный буквенный код валюты платежа по ISO 4217. |
paymentInfo.merchantOrderId |
Да |
string |
Идентификатор ордера клиента (организации заказчика). |
paymentInfo.merchantOrderDescription |
Да |
string |
Описание ордера клиента. |
Поля в userInfo:
| Наименование |
Обязательное? |
Тип |
Описание |
userInfo.externalId |
Да |
string |
Идентификатор пользователя, который выполняет платеж. |
userInfo.trafficType |
Да |
string |
Тип трафика. Возможные значения:- ftd (первичный трафик для непроверенных пользователей делающих оплату первый раз)
- trusted (для доверенных пользователей)
|
userInfo.trafficSegment |
Нет |
string |
Сегмент трафика для текущего пользователя |
userInfo.riskGroupCode |
Нет |
string |
Код рисковой группы пользователя |
userInfo.firstName |
Да |
string |
Имя плательщика латиницей. |
userInfo.lastName |
Да |
string |
Фамилия плательщика латиницей. |
userInfo.email |
Да |
string |
Электронная почта пользователя, который выполняет платеж. |
Поля в userAccount (не обязательное):
| Наименование |
Обязательное? |
Тип |
Описание |
userAccount.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 |
|
userAccount.pan |
Да |
string |
Номер электронного или банковского счёта |
userAccount.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 |
|
Поля в urls:
| Наименование |
Обязательное? |
Тип |
Описание |
urls.redirectSuccess |
Да |
string |
URL для перенаправления после успешного депозита. |
urls.redirectFail |
Да |
string |
URL для перенаправления после неудачного депозита. |
urls.callback |
Да |
string |
URL для отправки уведомлений о статусе транзакции. |
urls.return |
Да |
string |
URL для возврата на сайт клиента |
Поля sessionSettings:
| Наименование |
Обязательное? |
Тип |
Описание |
sessionSettings.clientTheme |
Нет |
string |
Тема терминала при его открытии. Возможные значения: |
sessionSettings.clientLanguage |
Нет |
string |
Язык терминала при его открытии. Возможные значения: |
sessionSettings.visibleMethods |
Нет |
Возможные варианты:- array [string]
- array [object]
|
Поддерживаются два формата данных:- array [string] - список названий методов, которые хочет получить клиент (массив строк)
["OnlineBanking"] - array [object] - список связок “название метода + тип подключения” (массив объектов)
[{"paymentMethodName":"OnlineBanking","communicationType":"h2h"}]
|
sessionSettings.presetAmounts |
Нет |
array [object] |
Предподготовленные суммы для совершения платежа (если paymentInfo.amount не передан):
[{"paymentMethodName":"OnlineBanking","communicationType":"h2h","amounts":[300,500,1000]}] |
Варианты ответов
Формат: JSON
1. Успешный ответ (статус 200)
При успешном выполнении запроса API возвращает ответ со статусом 200 OK и следующей структурой:
{
"url": "https://payment-terminal-form.idynsys.org/open/bj9MBmsE0ovw1a75Si867Le1MpDg5O-1733321054223170",
"sessionId: "bj9MBmsE0ovw1a75Si867Le1MpDg5O-1733321054223170"
}
2. Ошибка доступа (статус 403)
Если подпись некорректна, секретный ключ не совпадает с ключом, зарегистрированном в системе B2B Backoffice, отсутствует или неактивно приложение, определенное в заголовке запроса X-Client-Id, то API вернет ответ со статусом 403 Forbidden и со следующей структурой:
{
"error": {
"code": "403",
"message": "Access denied"
}
}
Система отправляет коллбек на указанный в 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": "",
"sessionId": "some-id",
"bonusCode": "bonus"
}
| Наименование |
Тип |
Обязательность |
Описание |
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 |
Платежная система. |