or
or
By clicking below, you agree to our terms of service.
New to HackMD? Sign up
Syntax | Example | Reference | |
---|---|---|---|
# Header | Header | 基本排版 | |
- Unordered List |
|
||
1. Ordered List |
|
||
- [ ] Todo List |
|
||
> Blockquote | Blockquote |
||
**Bold font** | Bold font | ||
*Italics font* | Italics font | ||
~~Strikethrough~~ | |||
19^th^ | 19th | ||
H~2~O | H2O | ||
++Inserted text++ | Inserted text | ||
==Marked text== | Marked text | ||
[link text](https:// "title") | Link | ||
 | Image | ||
`Code` | Code |
在筆記中貼入程式碼 | |
```javascript var i = 0; ``` |
|
||
:smile: | ![]() |
Emoji list | |
{%youtube youtube_id %} | Externals | ||
$L^aT_eX$ | LaTeX | ||
:::info This is a alert area. ::: |
This is a alert area. |
On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?
Please give us some advice and help us improve HackMD.
Do you want to remove this version name and description?
Syncing
xxxxxxxxxx
УКР | ENG

- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →Підключення до системи MTBMoney
Підключення до API
Підключення Партнера виконується методом виклику API XPAY. Для звернення до API XPAY використовується персональний токен Партнера.
Всі запити Партнера мають бути закриптовані з використанням алгоритму RSA (ключі RSA).
Для ідентифікації запиту в системах Партнера та Оператора необхідно використовувати структуру "Transaction".
Налаштування системи та тестові запити API виконуються на тестовому середовищі:
Адреса тестового середовища:
Ключ для тестового середовища:
Для роботи на продуктовому середовищі необхідно застосувати наступні дані:
Адреса продуктового середовища:
Ключ для продуктового середовища:
Приймання оплати
Для прийому оплати на рахунок Партнера застосовується запит [10005].
Переглянути повний опис запиту: [10005] "Отримання посилання на платіжну сторінку".
Запит
Опис атрибутів "Partner", "KeyAES" та "Sign" див. у розділі "Загальна інформація по підключенню (API)".
Структура "Data" для даної операції формується з наступних параметрів:
PayType
0
абовідсутність параметра
- пряме списання коштів з картки клієнта через с2а (card-to-account) або p2p (person-to-person) переказ;1
- оплата через шлюз інтернет-еквайрингу;2
- відкладений платіж1;3
- оплата через сторонній віджет;4
- оплата за реквізитами2;5
- відкладений платіж за реквізитами1,2;7
- пакетна оплата послуг;12
- пакетна оплата послуг за реквізитами;13
- оплата на користь мерчантів (MIDs);20
- оплата через "Google/Apple Pay".Див. деталі у розділі "Типи платіжного методу "PayType".
5
1 При проведенні запитів "відкладеного платежу" (
"PayType":2
або"PayType":5
) - Партнер додатково надсилає запит на "Підтвердження/скасування передавторизації". У разі відсутності підтвердження - списання коштів буде автоматично скасовано (через відрізок часу, вказаний у договорі з Партнером).2 При проведенні запитів "оплати за реквізитами" (
"PayType":4
або"PayType":5
) - Оператор у відповідь надсилає запит "check", на який необхідно повернути дані реквізитів для оплати (див. розділ "[check] Протокол двостадійної взаємодії").Phone
3380961000000
Email
3index@gmail.com
Account
3380961000000
3 Якщо в запиті не вказано жодного з цих параметрів (
Phone
,Email
чиAccount
) - Оператор передає посилання на форму для їх введення клієнтом. Після отримання даних виконується запит "check" для уточнення деталей оплати. Серед полівPhone
таEmail
більш пріоритетним єPhone
. Якщо запит необхідно проводити за допомогою email-у, то його слід вказати у поліAccount
.FirstName
Олег
MiddleName
Михайлович
LastName
Подільський
Address
456 Main Street
City
San Diego
CountryCode
US
PostCode
92126
State
California (CA)
PaymentSum
5000
Order
1234А
Currency
USD
Exchange
GBP
Callback
PaySuccess
для обробки успішного платежу, де полеURL
- адреса, на яку буде перенаправлений клієнт після завершення оплати.https://partner.com/payment_success
CallBackURL
https://partner.com/callback
MIDs
4PaymentInfo
5Transaction
4 Параметри масиву "MIDs":
MID
111
Sum
100
PaymentInfo
5Account
UA4830529900000 26008031203677
EDRPOU
3505506226
MFO
305299
Name
ТОВ "Ресурс"
5 Параметри масиву "PaymentInfo":
Caption
Призначення
Value
Оплата за замовлення №1 від 08.04.2024 клієнт ПІБ
Приклад запиту [10005]
Приклад структури "Data"
Відповідь
Загальна інформація по формуванню структури відповіді наведена у розділі “Загальна інформація по підключенню (API)”.
Успішна відповідь на запит [10005] містить посилання у вигляді рядка з ім'ям "URI" у структурі "Data":
URI
https://stage-mapi.xpaydirect.com/uk/frame/widget/691fafc9-5d64-46b5-22ba-85ce61cc26be
uuid
f3cd72b6-e1ea-406f-9b44-a9b93b401b7f
Приклади відповідей на запит [10005]
Операція проведена успішно
Помилка виконання операції
Протокол двостадійної взаємодії
Коли платіжна сторінка Партнера передбачає авторизацію клієнта (введення телефону/email), та у ході обробки даних на стороні Оператора виникає необхідність перевірки реквізитів оплати та/або уточнення суми оплати - застосовується протокол двостадійної взаємодії.
Див. деталі у розділі: "[check] Протокол двостадійної взаємодії".
Запити "pay/error/refund" (CallBackURL)
Завершальним етапом у виконанні операції є надсилання нотифікацій Партнеру про статус операції у вигляді одного з запитів:
Див. деталі у розділі: "[pay/error/refund] Статус операції (CallBackURL)".
Виплати
Виплата на картку
Виплата на картку може проводитись по одному з двох сценаріїв:
1. За один крок - "Payouts (one step)" - в результаті надсилання запиту на проведення виплати [10301/10311/103013] "Гаманець-карта" Партнер отримує відповідь про статус операції: успіх ("OperationStatus": 10) або помилку ("OperationStatus": 21/22).
Де: Client - клієнт Партнера, APP - мобільний додаток Партнера, XPAY - Оператор,
PS (Payment System) - платіжна система (Visa, Mastercard та ін.).
2. У два кроки - "Payouts (two steps)" - в результаті надсилання запиту на проведення виплати [10301/10311/103013] "Гаманець-карта" Партнер: а) отримує розрахунок суми списання (+комісії) у відповідній валюті; б) надсилає підтвердження/скасування операції по виплаті через надсилання запитів [10001/10002].
Розглянемо детальніше роботу двоетапної схеми "Payouts (two steps)":
Приклад запиту [103013]
Приклад структури "Data"
Приклади відповідей на запит [103013]
Операція проведена успішно
Помилка виконання операції
Виплата на IBAN
Для проведення виплати на IBAN, що використовується для CJ, застосовується запит: [10303] "Гаманець-IBAN".
Приклад запиту [10303]
Приклад структури "Data"
Приклади відповідей на запит [10303]
Операція проведена успішно
Помилка виконання операції
Отримання даних по проведеній операції
Перевірка балансу гаманця
Для отримання поточного балансу гаманця застосовується запит: [20001] "Отримання балансу гаманця".
Перевірка статусу операції
Всі операції та статуси їх обробки доступні в особистому кабінеті Партнера, або в реєстрі оплат, отриманому на пошту Партнера на наступний день операції.
Для перевірки поточного статусу операції застосовується запит: [20003] "Отримання статусу операції".
Коди відповідей та ознаки фатальності див. у таблиці: "Коди відповідей Оператора "Code".
Отримання http-коду з ознакою фатальності "ні" передбачає продовження виконання операції у системі Оператора чи Партнера.
Для запиту поточного статусу обробки операції необхідно повторювати запит [20003] з надісланими раніше параметрами до отримання http-коду з ознакою фатальності “так”. У відповіді змінюватиметься статус проведення операції.
Надсилання повторного запиту Оператору здійснюється: не частіше 1-го разу за 60 сек.
Час на надсилання відповіді обмежений та складає 55 сек. Якщо обробка операції не завершена - система XPAY формує відповідь з кодом
102
.Отримання
timeout
на будь-який API запит, в тому числі на запит статусу - необхідно розцінювати, як відповідь з кодом102
та продовжувати запитувати статус до отримання фатального коду.Для запиту [10005] додатково реалізовано два стани обробки операції:
"Reason":100051
),"Reason":100053
).OperationStatus
Reason
102
Processing
7
102
Processing
5
200
Error
21
200
Error
21
200
Ok
10
Див. деталі у розділі "Довідкові матеріали".
Порядок тестування на тестовому середовищі
Для тестування будь-яких операцій та ознайомлення з сервісами системи XPAY заведено Тестового Партнера. Див. деталі підключення у розділі: "Параметри підключення Тестового Партнера".
Порядок тестування на продуктовому середовищі
Для тестування операцій на продуктовому середовищі необхідно перевірити коректність виконання, як мінімум, чотирьох операцій:
По "успішним" операціям необхідно перевірити наявність та коректність квитанцій про оплату. По "успішним/не успішним" - перевірити коректність їх відображення в кабінеті Партнера. За наявності надсилання "колбеків" - перевірити надходження та коректне їх опрацювання в системі Партнера.
Перегляд транзакцій в кабінеті
Щоб отримати повну інформацію по проведеним операціям необхідно в кабінеті Партнера перейти до розділу "Аналітика".
Отримання реєстру
Спосіб, у який будуть формуватися реєстри по операціям, визначається на етапі інтеграції Партнера:
Довідкові матеріали
Опис загальних параметрів системи XPAY див. у розділі "Довідкові матеріали": коди типів операцій, типи платіжних методів, коди статусів обробки операцій, відомості та помилки, що повертаються у відповіді та ін.
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →Служба підтримки XPAY
Телефон: +38 093 891 92 00
Email: info@xpay.com.ua
Telegram: @xpaysupportbot