partnerdocs - Внесок користувача [uk]

MerchantAPI

2025-10-07T13:58:23Z

Vadim.fedorchuk:

== Загальні відомості ==
----Протокол призначено для торговців, які є одержувачами платежів. Продавець підписує договір про прийняття платежів або анкету-акцепт до публічної оферти.

Щоб отримати платежі, ви можете використовувати web, мобільні версії сайтів, а також мобільні програми. У разі використання цього протоколу не здійснюється перевірка даних для ідентифікації замовлення або облікового запису. EasyPay завжди приймає дані, надіслані та створені продавцем.

=== Заголовки запитів ===
----

Для надсилання запиту та отримання відповіді у форматі JSON, необхідно передати такі обов’язкові заголовки у запиті.<syntaxhighlight lang="jsonml+bst" line="1">
--header 'Content-Type: application/json'

--header 'AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209'

--header 'PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760'

--header 'PartnerKey: easypay-test'

--header 'locale: ua'

--header 'Sign: bS+vPOwu1Sif1Iz47Cdh+z1RAi0s6X21C3uU0YNBNWE='
</syntaxhighlight>

=== URL ===
----<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Посилання</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>

<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>https://merchantapi.easypay.ua</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Production</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">в т.ч. для надсилання тестових запитів</td>
</tr><tr><td>https://localapi.easypay.ua</td><td>Test</td><td>локальний тест </td></tr></table>

<br>

=== Налаштування безпеки ===
----Партнер надає IP, з яких будуть здійснюватися запити.
<br>
<br>

=== Реєстрація партнера в системі EasyPay ===
----Реєстрація нового торговця передбачає отримання унікального ідентифікатора '''PartnerKey'''.

===== Характеристика параметрів реєстрації =====
<div style="overflow-x: auto; display: block; width: unset !important; height: auto !important; border: none;">
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор партнера (продавця) у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор сервісу торговця у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>SecretKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">секретний ключ для формування підпису</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>
<br>

=== Тестові параметри ===
----Для тестових запитів використовуються такі параметри:<br><syntaxhighlight lang="pl">
PartnerKey = easypay-test
ServiceKey = MERCHANT-TEST
SecretKey = test

</syntaxhighlight>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
На даний момент відсутня можливість тестування з використанням фейкових оплат / тестових карток.
Платежі тільки реальні, їх можна відмінити в день оплати методом
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">cancelOrder</span>
([[MerchantAPI#Скасування платежу|Скасування платежу]])
</p>

===== Тестове середовище =====

Перед початком використання тестового середовища необхідно надати ір з яких будуть надходити запити, для відкриття доступу. На тестовому середовищі використовуються методи аналогічні Merchant Api.

'''Тестові дані:'''

* PartnerKey:credit-test
* SecretKey: credit-test
* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-TO-CARD - виплата
* Надсилання колбеків з Iр: 195.230.131.50 <br>
<br>
'''Тестові картки для верифікації/виплат:'''

Код підтвердження для 2дс при верифікації картки: 123456

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5167803258208169</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4235751329985326</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4111111111111111</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна без створення транзакції
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4999999999990011</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата з затримкою статусу 5 хв</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4217198608967728</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата з затримкою статусу 5 хв
</td>
</tr></table>
<br>
'''Тестові картки для оплати:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5168752081922117</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0128/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4909150002132451</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0129/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна 2ДС оплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>4300380058021820</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0130/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Не успішна з 3ДС + помилка PAYMENT_ALFABANK_116
</td>
</tr><tr><td><code>'''5567217349220669'''</code></td><td>0130/111</td><td>Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td></tr></table>
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
У разі отримання помилки <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">APPID_NOT_FOUND</span>
у відповідь на будь-який метод, необхідно повторити запит
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">createApp</span>
до отримання точки ІД.
</p>
<br>

== Основні запити/відповіді ==
<hr color="#d3d3d3" size="1" noshade>
<br>
==== Реєстрація точки та створення сесії ====
Цей метод слід викликати, коли користувач вперше звертається до платіжної сторінки. Якщо браузер або пристрій змінюються, метод знову з'являється
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createApp</span>
</p>
'''Request'''<syntaxhighlight line="1" lang="json">
headers:

"PartnerKey": "partnerName",
"locale": "ua"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json-object" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": "https://cdn.easypay.ua/hint_images/",
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "f3f2b678-a3c4-45ba-a865-a136fe4a62bd",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> '''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>

<br>

==== Створення сесії ====
----Даний метод створює новий екземпляр сеансу для користувача , <code>PageId</code>.
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createPage</span>
</p>'''Request'''<syntaxhighlight line="1" lang="json">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": null,
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "29bd7237-6b8d-4048-b028-6efc23d05988",
"requestedSessionId": "fa3595d3-52de-4744-9fc6-ec2d3507d5a5",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">За замовчуванням, якщо не було активності за запитами, час життя PageId - 20 хвилин. З кожним запитом життя PageId автоматично продовжується.</td>
</tr>
</table>
<br>

==== Створення замовлення ====
----Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Для кожного нового запиту <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">CreateOrder</span> потрібно використовувати унікальний <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">PageID</span>.
</p>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/createOrder</span>
</p>

</p><syntaxhighlight lang="markdown" line="1">
headers

'Content-Type': 'application/json'
'PartnerKey': 'partnerName'
'locale': 'ua'
'AppId': 'a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId': '2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign': 'e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

<br>
</syntaxhighlight><syntaxhighlight lang="json" line="1">
{
"userInfo": {
"phone": "string"
},
Обов'язкові параметри:

"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)

Необов'язкові параметри:
"paymentOperation":"PaymentTokenization",
"additionalItems": {},
"expire": "2019-04-15T07:49:20",
"isOneTimePay": true,
"fields": [
{
"fieldName": "string",
"fieldValue": "string",
"fieldKey": "string",
}
]
},
"urls": {
"success": "string",
"failed": "string",
"back": "string",
},
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string",
"id": "string"
},
"narrative": {
"name": "string"
}
},

"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string”
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true
}
]
},
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid",
"pan": "string",
"expire": "MM/YY",
"cvv": "string",
},
"partnerInfo": {
"id": "string",
"name": "string",
"account": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги мерчанта (видає EasyPay)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>description</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення (до 120 символів)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення, роздільник - точка </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип платіжного процесу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* '''PaymentTokenization -''' використовується для токенізації картки, якою буде сплачено це замовлення.
* '''Працює лише для інструмента “карта”'''. Повинен бути заповнений ідентифікатор клієнта '''"userInfo": { "phone": "string"}'''
* Якщо передано URL для колбеку, то після успішної оплати відправляється колбек про платіж та колбек про токенізацію (приклади колбеків про оплату - в [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]], про [[MerchantAPI#Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна)|токенізацію]].
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>userInfo/phone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер телефону (або ідентифікатор) клієнта </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Номер телефону необхідний:

* для отримання списку токенізованих карток (інформація буде в масиві StoredCards)
* при оплаті із зазначенням токена картки
* для токенізації картки після успішної оплати разом із параметром
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>expire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення заданого часу замовлення сплатити неможливо. Час життя сторінки може відображатися на платіжній сторінці у вигляді таймера (за замовчуванням таймер вимкнено). Значення має бути більшим за поточний час на 6 хвилин.
'''Значення за замовчуванням - 3 дні'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>sOneTimePay</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">включає можливість успішно оплатити замовлення лише 1 раз за конкретним forwardUrl </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Значення:

* True - за замовчуванням;
* False - оплатити замовлення по тому самому ''forwardUrl'' можна буде кілька разів;</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>urls</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
*'''back -''' URL для повернення на вказану сторінку з фінальної сторінки успіху EasyPay.
* '''success -''' URL сторінки успіху, для редиректу клієнта у разі успішної оплати.
* '''failed -''' URL сторінки помилки для редиректу клієнта у разі неуспішної оплати</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''back -''' На фінальній сторінці EasyPay вгорі зліва з'явиться кнопка “Повернутись назад” з посиланням на вказану URL-адресу. Параметр не може бути порожнім і повинен відповідати формату URL.
* '''success''' - у разі, якщо не було передано urls{success,failed} для редиректу після оплати. Після оплати клієнт може не дочекатися редиректу на цей url, тому редирект не можна використовувати як індикатор успішної оплати, отримання оповіщення про успішний платіж - '''див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
* '''faild -''' приклад get-параметрів, які приходять на '''url.failed та url.succes''' (те ж, але без ''errorCode''):

<code>?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=</code>

<code>Тестове+описання+замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&''errorCode=PAYMENT_ALFABANK_-2006''&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</table>

<br>

'''Необов'язкові додаткові поля'''

'''<code>additionalItems</code> –''' необов'язкові додаткові параметри, наприклад:
<br>
<syntaxhighlight lang="json" line="1">
"additionalItems":{
"PayerEmail":"client@i.ua",
"PayerPhone":"380930007603",
"Merchant.UrlNotify":"https://notify.url",
"Merchant.Param1":"CustomValue",
"CurrencyAmountLabel":"123.56$"
},
</syntaxhighlight>'''Опис параметрів<br>'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerEmail</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">емейл клієнта для оповіщення його у разі неоплаченого замовлення та для автоматичного заповнення поля “Надіслати квитанцію на email” на сторінці оплати. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається – він не може бути порожнім і має відповідати формату email.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerPhone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">телефон клієнта, на який протягом 15-20 хв після виклику CreateOrder відправиться нагадування про неоплачене замовлення (смс або вайбер). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається, він не може бути порожнім і повинен відповідати формату телефону.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.UrlNotify</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL для надсилання нотифікації за успішним платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Параметр не може бути порожнім і має відповідати формату URL.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.Param1</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">індивідуальний параметр партнера Param1 узгоджується з EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>
</table>

<br>
'''<code>reccurentPayment</code> -''' інформація для створення рекурентного платежу на основі поточного. Рекурентний платіж буде створений за розкладом, якщо основний платіж виконаний за допомогою інструментів card, Rcard, Vcard, LifeMoney
<br><syntaxhighlight lang="json-object" line="1">
"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>cronRule</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">правило у cron-форматі, з якою періодичністю повторювати рекурентний платіж, наприклад 10 20 15 * * (кожного 15 числа місяця о 20:10). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо ця властивість порожня, значить рекурентний платіж виконуватиметься на вимогу продавця.
'''Плануйте перше виконання рекуренту щонайменше 20 хвилин від дати успішного платежу.'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateExpire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата, після якої не проводити рекурентний платіж.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateRun</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата першого запуску рекурентного платежу (опціонально). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо не заданий, перший запуск розраховується за '''recurrent/cronRule'''
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>properties</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри (опціонально) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''reccurent/properties/amount -''' сума кожного рекурентного платежу, наступного після основної оплати (опціонально)
* '''reccurent/properties/failedCount -''' ккількість поспіль неуспішних викликів рекурентних оплат, після чого рекурентний платіж видаляється (опціонально). За замовчуванням - 4 спроби: при неуспіху - повторюється спроба кожні 20-30 хвилин, 4 неуспішних спроби поспіль по одному recurrentId - і рекурент відключається. Якщо після 3 неуспішних спроб була 1 успішна, то лічильник неуспішних для цього рекурента скидається.
* '''reccurent/properties/failedRule -''' cron-правило (період) повтору при неуспішному виклику рекурента (опціонально)
* '''reccurent/properties/UrlNotify''' - URL для надсилання нотифікації за успішним '''рекурентним''' платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
</td>
</table>
<br>
'''<code>bankingDetails</code> -''' передача банківських реквізитів для перерахування коштів у випадку, якщо банківські реквізити можуть змінюватися щодо різних платежів одного сервісу продавця. На стороні EasyPay має бути увімкнено режим "Отримувати реквізити із запиту".
<br>
<syntaxhighlight lang="json" line="1">
{
"bankingDetails": {
"payee": {
"id": "123664578",
"name": "департамент патрульної поліції",
"bank": {
"name": "пат пумб",
"mfo": "330556",
"account": "123654778889"
}
},
"payer": { "name": "Иванова Мария" },
"narrative": { "name": "Переказ коштів згідно договору з ФК № 111/11-П від 11.11.1111 р. за виключенням винагороди за їх переказ згідно реєстру від [work_date]р." }
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/ID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">код одержувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">ЄДРПОУ або ІПН</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">одержувач </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банк отримувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Mfo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">МФО банку </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">може не заповнюватися, якщо Payee/Bank/Account містить IBAN</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Account</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">р/р одержувача або IBAN </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payer/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">платник </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Narrative/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">призначення платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 157 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">повну структуру bankingDetails можна не передавати, для цього достатньо передати </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">

ідентифікатор банківських реквізитів із довідника, який узгоджений із конкретним партнером та перебуває в системі EasyPay.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">

</td>
</table>

'''Splitting''' - інформація щодо сплітування (розщеплення) платежу.

Частина загальної суми з order/amount розподіляється відповідно до інформації в splitting/items/value, а залишок - йде на основні реквізити з bankingDetails (або bankingDetailsId). На стороні EasyPay має бути увімкнено режим “Отримувати реквізити із запиту

Структура '''items''' це масив. Основний платіж буде розщеплений стільки платежів, скільки міститься у цьому масиві плюс залишок. Кожен розщеплений платіж буде надіслано на відповідні банківські реквізити <code>items/bankingDetails</code>. Залишок коштів буде надіслано на реквізити основного платежу з <code>BankingDetails</code> або <code>bankingDetailsId,</code> які потрібно обов'язково вказувати під час сплітування.
<br>
<syntaxhighlight lang="json" line="1">
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string"
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>

 <tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор послуги, за якою ініціюється зарахування спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/orderId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор внутрішнього замовлення Мерчант для маркування конкретного спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/bankingDetails</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банківські реквізити кожного розщепленого платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/unit</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">може бути '''Amount''' (сума розщепленого платежу в грн.) або '''Percent''' (сума розщепленого платежу вважається відсотком від загального). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/value</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">значення у цифрах. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/withCommission - true/false</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Вказує з якого з одержувачів слід утримати внутрішню комісію. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Сума комісії розраховується із загальної суми платежу, а утримується - з першого одержувача зі '''splitting,''' у якого '''withCommission=true'''. Якщо ні в кого з '''splitting''' не зазначено '''withCommission=true''', то комісія втікає з “основного” одержувача, вказаного в bankingDetails.
Якщо у всіх значення '''withCommission=false''' (або не передали), то комісія утримається з "основного одержувача", вказаного в параметрі '''bankingDetails'''

Якщо всі значення '''withCommission=true,''' то комісія утримається з першого одержувача, зазначеного в splitting. Залишок буде надіслано на реквізити основного платежу з '''bankingDetails''' або '''bankingDetailsId.'''

При встановленому сервісом Типі розрахунків “За актами", одержувачам перераховується повна сума, без відрахування комісії, незалежно від значення WithComission.
</td>
</tr>

</table>
<br>

Після виконання сплітування під кожен спліт (частини) платежу на стороні EasyPay створюється фінансова транзакція з унікальним transactionID.
<br>
* Якщо списання грошей з картки пройшло успішно і всі реквізити для спліту вказані корректно (доступні) - всі транзакції набувають успішного статусу і по кожній транзакції відправляється колбек.
* Якщо списання грошей з картки пройшло неуспішно – запит відхиляється з кодом фінансової помилки;
* Якщо списання грошей з картки пройшло успішно, але хоча б один із реквізитів зазначено неправильно – всі транзакції спліту (частини) платежу – будуть відхилені.
<br>
Після проведення успішного списання та сплітування по кожній фінансовій транзакції в рамках спліту направляється колбек (нотифікація) про успішний платіж. Приклад коллбека (нотифікації) вказаний у [[MerchantAPI#Повідомлення про платіж|повідомлення про платіж]]'''''.'''''

<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Якщо параметр <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">userPaymentInstrument</span> не є порожнім, створення платежу буде відбуватися автоматично.
</p>

Для різних інструментів передаються такі параметри:

'''userPaymentInstrument –''' інструмент оплати.

'''*Картка (PCI DSS)'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "Card",
"pan": "5168123456780123",
"expire": "MM/YY",
"cvv": "string" }

</syntaxhighlight>

'''*Токенізована Карта'''<syntaxhighlight lang="json" line="1">
{"userInfo":{"phone":"380935207603"}, /Phone,під яким токенізована карта/
…
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid", /токен картки/
}
}

</syntaxhighlight>
'''Kyivstar Money/Life Money /VodafoneMoney'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "KSMoney / LifeMoney / VodafoneMoney",
"phone": "380xxYYYYYYY" }

</syntaxhighlight>'''ApplePay/GooglePay'''
<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "ApplePay / GooglePay",
"token": “string”/Токен, отриманий від Apple | Google /
}

</syntaxhighlight>

* '''partnerInfo –''' інформація про партнера
* '''partnerInfo.name –''' найменування партнера
* '''partnerInfo.id –''' ВД (ЄДРПОУ) партнера
* '''partnerInfo.account –''' рахунок партнера (особовий рахунок/IBAN…)

*

<br>

==== Створення замовлення для холдованих платежів ====
Перед використанням методу потрібне додаткове налаштування терміналів зі сторони техпідтримкиEasyPay.

Перед викликом цього методу потрібно викликати один із методів:

'''[[MerchantAPI#Створення сесії|- CreateApp]]'''

'''[[MerchantAPI#Створення сесії|- CreatePage]]'''

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>'''REQUEST HEADERS'''<syntaxhighlight lang="http">
PartnerKey: partnerName
locale: ua
AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1
PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d
Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4=
</syntaxhighlight>'''REQUEST BODY'''<syntaxhighlight lang="json">
{
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount": 1.01,
"paymentOperation": "Hold",
"expire": "2019-04-15T07:49:20.009Z",
"isOneTimePay": true,
"additionalItems": {}
},
"urls": {
"success": "string",
"failed": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>orderId</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор замовлення в системі партнера </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>description</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>amount</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td></tr>
<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation = Hold</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр, що вказує, що подальший платіж буде холдовано(зарезервовано) з можливістю підтвердження або скасування. </td></tr>

</table>

'''Необов'язкові параметри'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>expire</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення вказаного часу замовлення оплатити неможливо. При ненульовому значенні на платіжній сторінці відображатиметься таймер. Значення повинне перевищувати поточний час щонайменше на 5 хвилин. Типове значення — 3 дні.

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isOneTimePay</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">вказує, чи можна оплатити одне замовлення кілька разів. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Типове значення — True.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalItems</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">наприклад:
<code>"additionalItems":</code>
<code>{ "PayerEmail" : "client@i.ua",</code>
<code>"PayerPhone" : "380930007603"</code>
<code>},</code>

* де PayerEmail — емейл клієнта для сповіщення у разі неоплаченого замовлення та автоматичної підстановки на платіжній сторінці.

* PayerPhone — номер телефону для надсилання повідомлення (SMS або Viber) про неоплачене замовлення (через 15–20 хвилин після виклику CreateOrder).</td><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URLs </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки успішної оплати для редиректу клієнта. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">failed — URL сторінки помилки для редиректу клієнта.
приклад параметрів, що передаються на url.success (без errorCode) і

<code>url.failed: ?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=Тестове+описання+</code>

<code>замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&errorCode=PAYMENT_ALFABANK_-2006&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</tr></table>

'''RESPONSE''' <syntaxhighlight lang="json">
HEADERS
-------
BODY
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": "https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b",
"error": null
}

</syntaxhighlight>

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів, у яких немає сертифікатів '''PCI DSS''' для обробки карткових даних. Або якщо у партнера немає власної платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструмент '''RCard''' надається лише користувачам, які авторизовані в системі EasyPay.
Можливі значення '''instrumentType''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType:'''
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
</td>
</tr></table>

Холдування платежу можна здійснити, оплативши замовлення на сторінці оплати (перейти за '''forwardUrl'''), або вказавши в запиті '''createOrder''' інструмент оплати у '''userPaymentInstrument''' (див. [[MerchantAPI#Створення замовлення|Створення замовлення]]).

Клієнту відобразиться сторінка успішного платежу EasyPay, або сторінка, вказана в “urls”:{}.

Після '''спроби холдування платежу''' партнеру буде відправлено '''сповіщення''', згідно з варіантом, вказаним в налаштуваннях сервісу [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]].

Статус платежу необхідно перевірити методом '''[[MerchantAPI#Перевірка статусу платежу|orderState]]'''

Після успішного холдування необхідно викликати або '''[[MerchantAPI#Розхолдування платежу|unHoldOrder]]''' , або '''[[MerchantAPI#Скасування платежу|orderCancel]]'''

Якщо протягом '''повних 10 днів''' після холдування жоден з цих методів не буде викликаний, на '''11-й день близько 05:00''' платіж може бути '''відхилений емітентом''', і кошти стануть доступні клієнту.

У транзакцію додається коментар: ''Автоматично відхилено через 10 днів. (SYSTEM ACCOUNT [dateTime])''

Сповіщення партнеру при цьому '''не надсилається'''.

==== Розхолдування платежу ====
Якщо цей метод не буде викликано протягом 10 днів, кошти повертаються клієнту, а платіж у системі відхиляється.

Перед викликом цього методу необхідно здійснити '''[[MerchantAPI#Створення замовлення для холдованих платежів|холдування транзакції]]'''

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/unHoldOrder</span></p>

'''REQUEST''' '''HEADERS''' <syntaxhighlight lang="http">
'PartnerKey: easypay-test'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='
</syntaxhighlight>

'''REQUEST BODY'''<syntaxhighlight lang="json">
{
"transactionId":955537573,
"orderId":"hold_4",
"serviceKey":"MERCHANT-TEST",
"amount": 1.2
}
</syntaxhighlight>
'''<br />RESPONSE''' <syntaxhighlight lang="json">
{
"paymentState": "accepted",
"error": null
}
</syntaxhighlight>'''Опис параметрів запиту''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний номер платежу в системі EasyPay</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор замовлення в системі партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов’язковий параметр, торгова сума, яку слід списати з картки.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Різниця повернеться клієнту на картку протягом '''1–2 днів''', залежно від регламенту банку

</td>
</tr></table>
'''<br>Опис параметрів відповіді'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі '''paymentState:'''
• '''accepted -''' платіж успішний (кінцевий статус)

• '''pending -''' платіж в обробці (некінцевий статус)

• '''declined -''' платіж відхилений (кінцевий статус)

• '''none -''' платіж не знайдено
</td>
</tr></table>

Для платежів з 2DS переадресація на сторінку банку-емітента не відбувається, і користувач відразу отримує статус платежу.

Після '''спроби розхолдування платежу''' партнеру буде надіслано '''сповіщення''' згідно з варіантом, вказаним в налаштуваннях сервісу [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]

Статус платежу необхідно перевіряти методом '''[[MerchantAPI#Перевірка статусу платежу|orderState]]'''

==== Параметри BrowseInfo при 3DS оплаті ====
У зв'язку з переходом банків - екваєрів на модель роботи 3D Secure 2.x, при створенні замовлення з одночасною передачею інструменту оплати в запиті (карта, токен карти, токен Apple / Google Pay), необхідно передавати додаткові параметри пристрою (браузера) клієнта в заголовках і в тілі запиту createOrder, у прикладі вони виділені:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>'''HEADERS'''
"appId: b15c4b64-8964-4c80-852e-df59a0e0d9b6",<br>
"pageId: 607514b8-1da5-490a-bdf3-0c6883131625",<br>
"partnerKey: easypay-test",<br>
"sign: XJ3roGhTLwAZXigBp/iVRdsXlZYdTSen3xSM+29GaRg=",<br>
"Content-Type:application/json",<br>
<span style="color: green;">"AcceptHeader:*/*",</span><br>
<span style="color: green;">"User-Agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"</span><br>
'''BODY'''
<div style="font-family: monospace; white-space: pre-line;">

"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_3ds2x",
"additionalItems":{
"Merchant.UrlNotify":"http://url.noti.fy"
},
"description":"Easy test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"Card",
"pan":"4444444444444444",
"expire":"0599",
"cvv":"123"
},
<span style="color: green;">
"browserInfo":{
"colorDepth":"24",
"screenHeight":"824",
"screenWidth":"1536",
"language":"uk-UA",
"javaEnabled":"false",
"javascriptEnabled": "true",
"timeZone":"-180"
}
</span>

</div>

<br>
'''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AcceptHeader:*/*</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте без змін</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>User-Agent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте клієнтський User-Agent </td></tr></table>

'''Приклад, як збирати дані на JS:'''<syntaxhighlight lang="markdown" line="1">
getBrowserInfo() {
let browserInfoModel = {};
browserInfoModel.colorDepth = window.screen.colorDepth.toString();
browserInfoModel.screenHeight = window.screen.height.toString();
browserInfoModel.screenWidth = window.screen.width.toString();
browserInfoModel.language = window.navigator.language;
browserInfoModel.javaEnabled = window.navigator.javaEnabled();
browserInfoModel.timeZone = (new Date()).getTimezoneOffset().toString();
return browserInfoModel;
}

</syntaxhighlight>Якщо все передано правильно, то отримайте відповідь як нижче у прикладі '''"Якщо передано userPaymentInstrument (для випадку з 3DSecure)",''' або помилку оплати з картки, наприклад, "Недостатньо коштів".

У випадку, якщо додаткові параметри передані неправильно, отримайте помилку платіжного сервісу, наприклад:<syntaxhighlight lang="markdown">
"errorCode":"PAYMENT_PUMB_SERVICE_FAILURE",
"errorMessage":"Технічна помилка екваєра. Зверніться до служби підтримки EasyPay, або спробуйте пізніше"

</syntaxhighlight>'''Відповідь (RESPONSE)''':<syntaxhighlight lang="json" line="1">
header:
відсутній

body:
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},

{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b,
"error": null,
}

Якщо передано userPaymentInstrument (для випадку з 3DSecure):
{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form action='https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type='hidden' name='PaReq' value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":860094566,
"retrievalReferenceNo":null,
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів які не мають сертифікатів PCI DSS для обробки карткових даних. Або якщо партнер не має платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">на сторінці оплати можемо відключати елементи інтерфейсу:
- логотип EasyPay можемо приховувати

- лічильник часу, що залишився до оплати, може бути відображений/прихований

- поле "Призначення" (можемо вимкнути, або за замовчуванням зробити відкритим/закритим)

- рядок з логотипом партнера та назвою можемо приховати

- поле введення імейл сховати / відобразити

- рядок з "Номер замовлення" приховати/показати
</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструменти '''Emoney''', vcard та '''RCard''' видаємо тільки для користувачів, які авторизовані в системі EasyPay. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType'''
* Emoney – гаманець EasyPay
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
* ApplePay – оплата через ApplePay
* GooglePay – оплата через GooglePay
* LifeMoney – мобільні гроші Лайф.
* KsMoney – мобільні гроші Київстар
* VodafoneMoney – мобільні гроші Водафон
* картки лояльності Fishka
</td>
</tr></table>

'''3DSecure / mobile payments case:'''<syntaxhighlight lang="json">
Якщо передано userPaymentInstrument (для випадку з 3DSecure):

{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form" action="https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type="hidden" name="PaReq" value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":"860094566",
"retrievalReferenceNo":"null",
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>

<br>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Confirmed''' - платіж підтверджений (кінцевий статус, якщо "status": "done")
* '''WaitConfirm''' - платіж у статусі "обробляється", необхідно додатково запросити фінальний статус платежу
* '''WaitVerify''' - від клієнта очікується підтвердження (наприклад, якщо "status": "Need3Ds" - необхідно пройти перевірку 3D Secure) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Done''' - додаткові дії не потрібні, якщо при цьому "зберіганнядержави":"затверджено", означає платіж повністю успішний. При іншому значенні paymentState- платіж не прийняв кінцевий статус, необхідно запросити статус ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]).
* '''Need3Ds''' - необхідно підтвердження 3D Secure від клієнта ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedConfirmCode''' - необхідно надіслати код перевірки зі смс методом confirmCodeVerification ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedLookup''' - необхідно надіслати код перевірки з смс '''''методом confirmCodeVerification ('''''[[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]]) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionType</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип наступної дії:

* '''"FormRedirect"''' - необхідно створити сторінку (форму) з html-коду, який передано у параметрі "actionContent" :'''"<html>...</html>",''' відкрити її клієнту, наприклад, для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl".'''
* Після проходження перевірки клієнт буде передресовано на фінальну сторінку EasyPay або на

<code>"urls": {</code>

<code>"success": "string",</code>

<code>"failed": "string"</code>

<code>}</code>

* '''"UrlRedirect"''' - переадресувати клієнта на посилання з "action" або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".'''
* '''"ConfirmCode"''' -необхідно надіслати код перевірки з смс методом '''confirmCodeVerification''' ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])

'''"None"''' - можливий при використанні інструменту гаманець '''("instrumentType": "EMoney"),''' кошти успішно списані з гаманця, партнеру надсилається повідомлення про списання. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"<html>...</html>"''' - html форма сторінки банку для введення коду 3DS. Сформувати сторінку з коду та відкрити її клієнту. Після підтвердження платежу відбудеться 302-й редирект на ваші "urls" із запиту createOrder, або на фінальну сторінку EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції в EasyPay </td></tr></table>

'''<br />2DSecure case:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Confirmed"''' та '''"status": "Done"''' - платіж пройшов успішно. При інших значеннях необхідно перевірити статус '''''платежу''''' '''('''[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]''')''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Done" -'''платіж завершено, додаткові дії не потрібні. При '''"paymentState":'''

* '''"Confirmed"''' - означає, що транзакція на стороні EasyPay прийнята (http - оповіщення успішно доставлено партнеру) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції до EasyPay </td></tr></table>

<br>

==== Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки ====
----У випадку "<code>actionType</code>": "<code>ConfirmCode</code>", клієнту прийде код підтвердження, який потрібно передати до EasyPay
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/confirmCodeVerification</span>
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"code": "string"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{ }
</syntaxhighlight>Якщо "status":"Need3Ds", то клієнту потрібно пройти 3DS перевірку в залежності від значення '''"actionType".'''
<br>
'''Опис параметрів:''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>FormRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно СТВОРИТИ сторінку (форму) з html-коду, який передано у параметрі </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">"<html>...</html>", відкрити її клієнту для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl"''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>UrlRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно переадресувати клієнта на посилання з '''"action"''' або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".''' Відобразиться форма банку емітента картки для перевірки 3D Secure. Після введення коду клієнта переадресує на сторінку успіху чи помилки. Адреси сторінок передаються на етапі створення замовлення.

<code>"urls": {</code>

<code> "success": "string",</code>

<code> "failed": "string"</code>

<code>}</code> </td></tr></table>

<br>

==== Перевірка статусу платежу ====
----

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/orderState</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers:
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20240524-0015",
"transactionId":"1413668587"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers:
відсутній

body:
"merchantKey":"easypay-test",
"transactionId":1413668587,
"orderId":"test_20240524-0015",
"amount":3.000000,
"paymentState":"declined",
"refundTransactionId":1413673292,
"":
"paymentsList":[

],
"refunds":[
{
"refundTransactionId":1413669380,
"paymentState":"accepted",
"refundAmount":1.10,
"dateAccepted":"2024-05-24T16:14:45+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:14:39+03:00"
},
{
"refundTransactionId":1413673292,
"paymentState":"accepted",
"refundAmount":1.90,
"dateAccepted":"2024-05-24T16:19:40+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:19:33+03:00"
}
],
"error":null
}

</syntaxhighlight>
'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;"></th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Фінальний'''
'''статус?'''</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Значення/ подальші дії'''</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accepted</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"> '''так'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж прийнято</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>declined</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">так</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж відхилений
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pending</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ні</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж знаходиться в обробці, необхідно повторити запит статусу пізніше
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>none</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">- </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">статус платежу не визначено, необхідно повторити запит статусу до отримання кінцевого статусу</td>
</tr></table>

'''Нетипові відповіді запит статусу:'''

* Якщо платіж не знайдено, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"error":{
"errorCode":"MERCHANT_ORDERID_NOT_FOUND",
"title":null,
"description":null,
"errorMessage":"MERCHANT_ORDERID_NOT_FOUND",
"fieldErrors":[ ]
}

</syntaxhighlight>

* Якщо платіж (сторінка, замовлення) не були відкриті клієнтом або не було спроби оплати, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId2",
"amount": 0,
"paymentState": "pending",
"refundTransactionId": null,
"paymentsList": [],
"error": null
}

</syntaxhighlight>

* Якщо отримано помилку на замовлення на етапі визначення реквізитів:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId",
"amount": 0,
"paymentState": "declined",
"refundTransactionId": null,
"paymentsList": [],
"error": {
"errorCode": "PROVIDER_ACCOUNT_INVALID", (ерор код може (має) відрізнятися від того, що в прикладі)
"title": "Помилка системи",
"description": "Акаунт не знайдено",
"errorMessage": "string"
}
}

</syntaxhighlight>

При виконанні запиту статусу на замовлення, у яких є спліт (платіжна опція) - повертається наступна модель:

'''Request:'''<syntaxhighlight lang="json" line="1">
headers:

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"easypay-test",
"orderId":"full_split_11",
"transactionId":""
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey": "easypay-test",
"transactionId": 991379504,
"orderId": "full_split_11",
"amount": 3.150000,
"paymentState": "accepted",
"refundTransactionId": null,
"paymentsList": [
{
"merchantKey": "easypay-test",
"transactionId": 991379509,
"orderId": "full_split_11",
"amount": 1.030000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379508,
"orderId": "full_split_11",
"amount": 0.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379507,
"orderId": "full_split_11",
"amount": 1.020000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379506,
"orderId": "full_split_11ID",
"amount": 1.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
}
],
"error": null
}

</syntaxhighlight>

'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentsList</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список платежів у структурі спліту з деталізацією. </td></tr></table>

У випадку зі сплітованими платежами, в основному тілі відповіді '''OrderState''' - параметру '''transactionId''' присвоюється внутрішній технічний номер (нефінансової) операції.<syntaxhighlight lang="json" line="1">
"urls": {
"success": "string",
"failed": "string"
}

</syntaxhighlight>

==== Скасування платежу ====
----Метод викликається '''лише''' для платежів у статусі '''"accepted".''' Для успішного скасування має бути достатньо суми прийнятих платежів у день скасування. Можна скасовувати платежі, які не старші 30 днів. Успішне повернення після цього терміну – не гарантується, залежить від умов банків-еквайєрів.

Повернення суми на картку відбувається в строк 0-3 робочих дні, в окремих випадках – до 30 робочих днів. Це залежить від умов банку-еквайєра, через який пройшов основний платіж, а також банку-емітента.

===== Скасування звичайного платежу =====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "MERCHANT-TEST",
"orderId": "test_20210217-121843",
"transactionId": "913141164",
"amount":"1"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
body
{
"merchantKey":"easypay-test",
"transactionId":913141164,
"refundTransactionId":913141464,
"orderId":"test_20210217-121843",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>

'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">скасована сума </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">для часткового скасування - передається із сумою, яку потрібно скасувати.
для скасування повної суми - параметр amount не передається
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">транзакція рефанду (скасування)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування). Можливі значення: </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* a'''ccepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* p'''ending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен повертати '''"'''<code>paymentState</code>'''":"'''<code>declined</code>'''",''' а запит статусу транзакції скасування - '''"'''<code>paymentState</code>'''": "'''<code>accepted</code>'''"'''

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація ([[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]), на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром "<code>action</code>": "<code>refund</code>'''"''' та сумою (amount), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Скасування платежу (замовлення зі Splitting параметрами) =====
----Скасування платежу (Замовлення) можна робити:

* на всю суму платежу (замовлення)
* на суму одного спліту (Часткова скасування платежу (замовлення))
* на суму меншу від суми спліту (Часткова скасування спліту)
<br>

===== Скасування повної суми платежу (замовлення зі Splitting параметрами) =====
----
* Для скасування повної суми Splitting транзакції необхідно виконати запит статусу транзакції згідно з розділом "[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]'''"''' використовуючи основний <code>OrderID</code>
* Отриманий у відповіді кореневий <code>transactionID</code> використовувати у запиті [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]]
* У відповідь на запит [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]] буде отримано відповідь зі статусом скасування, а також буде отримано коллбек по кожній транзакції, яка входила до Splitting транзакції.
* Коллбек на загальну суму Splitting транзакції не надходить.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379504,
}
</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId": 991379504,
"refundTransactionId":913141464,
"orderId":"full_split_11",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''Pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</tr>

</table>Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати <code>"paymentState"''':"'''declined'''"'''</code> як для основної так і для окремих транзакцій, а запит статусу транзакції скасування - <code>"paymentState":"accepted".</code>

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром <code>"action": "refund"</code> та сумою (<code>amount</code>), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Часткове скасування (повернення) платежу (замовлення зі Splitting параметрами) =====
Для часткового скасування платежу необхідно виконати запит <code>cancelCurder</code> використовуючи <code>transactionID</code> який був отриманий в коллбеку (параметр payment_id), а також вказавши суму скасування (вона має бути меншою або дорівнює сумі транзакції, що скасовується).

* У відповідь на запит <code>cancelOrder</code> буде отримано відповідь зі статусом скасування, а також буде отримано коллбек про успішне скасування цієї транзакції.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379509,
"amount":1.00
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr></table>

'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId":"991379509",
"refundTransactionId":"913141464",
"orderId":"full_split_11",
"amount":"1.000000",
"paymentState":"accepted",
"error":"null"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування)
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>

</tr></table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати "paymentState":"declined", а запит статусу транзакції скасування - "paymentState":"accepted"
При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде одноразово надіслано POST - запит із параметром '''"action": "refund"''' та сумою '''(amount)''', яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

=== Повідомлення про платіж ===
----
# Партнер обов'язково вибирає 1 або кілька способів сповіщення та повідомляє його в EasyPay. Партнер зазначає платіж успішним на своїй стороні лише після отримання цього повідомлення
# Ми надсилаємо HTTP - колек з IP 93.183.196.26 методом POST з інформацією про платіж.
# Запит надсилає EasyPay партнеру після того, як транзакція набула фінального статусу (Accepted, Declined).
# URL для повідомлень '''(UrlNotify)''' партнер направляє у запиті '''createOrder''' у параметрі:
<br>
<syntaxhighlight lang="json" line="1">
"order":{
"additionalItems":{
"Merchant.UrlNotify":"https://notify.url"
}
}
</syntaxhighlight>
<br>
"Merchant.UrlNotify" Параметр не може бути порожнім і має відповідати формату URL.
<br>

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Якщо у відповіді не отримано <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">HTTP StatusCode 200</span>, запит нотифікації буде надіслано повторно протягом <strong>1-10 хвилин</strong>.
Повторення може продовжуватися визначену кількість разів (за замовчуванням – <strong>50 разів</strong>), поки не буде отримано статусу <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #198754;">"200 ОК"</span>.
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Sign": "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
body
{
"OperationType": "Payment",
"PartnerKey": "groshi-com",
"ServiceKey": "GROSHI-COM-GOOGLEPAY",
"TransactionStatus": "Accepted",
"MerchantOrderId": "3127194_28_450866",
"DateTime": "2023-12-09T14:00:48",
"Amount": 2059.08,
"Commission": 28.83,
"TransactionId": 1336448544,
"AdditionalItems": {
"Merchant.Inn": "3178404189",
"Merchant.Details": ";0;0;;4;",
"Merchant.UrlNotify": "https://testpartner.ua/callback",
"Merchant.ClientFullName": "Іванов Дмитро"
"Acquirer.MerchantId":"12345678"
"Acquirer.TerminalId":"E1234567"
"Card.BrandType":"Visa"
"AuthCode":"012345"
}
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>OperationType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)

'''refund -''' про успішне скасування платежу (відправляється разово)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionStatus</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>MerchantOrderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.MerchantId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торговц'''я''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.TerminalId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор платіжного пристрою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Card.BrandType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">найменування платіжної системи, платіжний інструмент якої використовується </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AuthCode</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Код авторизації </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>DateTime</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">якщо партнер не відповість статусом 200 на запит з action:payment, то в наступному запиті час буде новим</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ID транзакції на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>

</table>
<br>Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.
Для правильного обчислення підпису, тіло з нотифай потрібно брати як є, без перетворень та форматувань.
У випадку, якщо підпис notify не перевірено, всі фінансові ризики перекладаються на партнера.

==== Отримання інформації про рекурентний платіж ====
----
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/info</span></p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="
queryParams
"serviceKey": "string"
"orderId": "string"
"reccurentId": "0"
"dateFrom": 2025-03-10
"dateTo": 2025-03-17
"isEnabled": true|false
"pageNumber": 1
"countPerPage": 3

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"merchantReccurentPaymentDetails":[
{
"recurrentId":14433854,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601+url",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:38:02+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:42+02:00",
"properties":{
"failedCount":"1",
"urlNotify":"http://109.251.205.8:9987/merch/notifysigncheckexample.php"
}
},
{
"recurrentId":14433852,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:37:25+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:03+02:00",
"properties":{
"failedCount":"1"
}
}
],
"totalCount":2,
"totalFilteredCount":2,
"pageFilteredCount":2,
"currentPageNumber":1,
"numberOfPages":1,
"error":null
}

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>reccurentId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекурента </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateFrom</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента з.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateTo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента по.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isEnabled</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити лише активні / або неактивні рекуренти </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pageNumber</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити сторінку номер.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>countPerPage</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">кількість записів на сторінці </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>templateId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекуренту (reccurentId) </td></tr></table><br>

==== Виклик рекурентного платежу ====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/payment</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"reccurentId": 0,
"amount": 0
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"reccurentId": 0,
"transactionId": 0,
"transactionStatus": "None",
"error": {
"errorCode": "string",
"title": "string",
"description": "string",
"errorMessage": "string",
"fieldErrors": [
{
"fieldName": "string",
"errorCode": "string",
"errorMessage": "string"
}
]
}
}

</syntaxhighlight>Також буде надіслано нотифікацію у разі успішного платежу. Створення рекурентного платежу на операцію, у структурі якої є спліт – не підтримується.

<br>

=== Видалення рекурентного платежу ===
----
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/reccurent/delete/{id}</span>
</p>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
відсутній
</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

-

body

-
</syntaxhighlight>

== Робота з токенізованими картами ==
----

=== Токенізація карти ===
Метод призначений для токенізації (збереження) картки для ідентифікатора користувача під конкретним торговцем.

===== Токенізація з передачею даних картки у запиті (заборонено без PCI:DSS сертифікації мерчанта) =====
Перед викликом цього методу. Потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]

'''-''' [[MerchantAPI#Створення сесії|CreatePage]] <br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCard</span></p>
<br>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "380501002030ws",
"pan": "4874120123567889",
"expire": "1222",
"cvv": "012",
"vсode": "123654"
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"activateCodeType": "code|amount",
"cardGuid: "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan”: "48741201****1234",
"expire”: "1222"
"error": "null"
}

</syntaxhighlight>Токенізація картки - процес двоетапний.

На першому етапі у запиті йдуть параметри картки та номер телефону користувача. У відповіді, залежно від '''activateCodeType''', може бути активація за кодом підтвердження з виписки або SMS або за сумою списання.

З другого краю етапі до всіх параметрів додається ще vcode – код верифікації. При успішному відповіді прийдуть параметри токенізованої карти чи помилка.

===== Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна) =====
Перед викликом цього методу, потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]];

'''-''' [[MerchantAPI#Створення сесії|CreatePage]];
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">api/merchant/tokenCard/create</span></p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type: application/json"
"PartnerKey: partnerName"
"locale: ua"
"AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "8888",
"expire": "2020-12-06T12:54:32.043Z",
"urls": {
"success": "https://test.ua",
"failed": "https://test1.ua",
"notify": "https://test2.ua",
"back": "https://test3.ua"
},
"description": "testtts",
"checkExistingToken": false
"operationType":"SingleToken | createToken | ExistingToken"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"forwardUrl": "https://easypay.ua/ua/tokencard/cae16afc-be56-4a39-8ce1-5de4f4142e76",
"error": null
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>description</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |опис, який відобразиться на сторінці токенізації
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час життя сторінки токенізації (по дефолту - 15 хвилин)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережеться картка (будь-які літери, цифри, GUID.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |'''Не повинен містити символ ‘+’'''
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>urls</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |містить інформацію про:

* сторінці успіху партнера (success) для переадресації клієнта після успішної токенізації, потрібно обов'язково передавати
* сторінці помилки ('''failed''') для переадресації клієнта у разі помилки
* адреса для відправки callback-запиту з деталями при успішній токенізації ('''notify''')
* адресу для повернення назад зі сторінки токенізації ('''back''')
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>forwardUrl</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |сторінка для додавання картки (токенізації)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>checkExistingToken</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |перевірка наявності токена по карті, що вводиться у даного партнера.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |Параметр може набувати значення:

* true - проводити валідацію на наявність раніше створеного токена по цій карті;
* false - валідація відсутня;
* null - валідація відсутня;

Якщо параметру '''checkExistingToken''' присвоєно значення true, слід очікувати наступних сценаріїв поведінки:

* “checkExistingToken” : '''true,''' і в системі '''немає раніше створених токенів''' під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''true,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) - користувачу відкривається сторінка успіху, додаткова верифікація (надсилання коду верифікації не відбувається), токен не створюється, а в callback вказується '''масив раніше створених токенів''';
* “checkExistingToken” : '''false / null,''' і в системі немає раніше створених токенів під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''false / null,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) – формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену.
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>operationType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |''(Новий параметр) задає тип операції токенізації''
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
* '''SingleToken''' - для однієї карти завжди повертається той самий токен. Логіка така:

* перевіряємо чи є токен для цієї картки під '''partnerKey''' із запиту

* якщо є 1 або більше токенів - беремо останній з них, створюємо новий запис з цим токеном для переданого ідентифікатора клієнта '''(phone)''', відправляємо цей токен в callback у кореневому параметрі '''cardGuid'''
* якщо токенів немає - створюємо новий для цього '''phone''' і відправляємо його в callback в кореневому параметрі '''cardGuid''' (один і той же '''cardGuid''' може бути прив'язаний до різних phone)

* '''createToken''' - значення за замовчуванням, звичайне створення токена (можна не передавати)
* '''ExistingToken''' - поведінка аналогічна '''checkExistingToken:true'''
|}
'''На сторінці токенізації можемо керувати інтерфейсом (на стороні EasyPay):'''
* відображати/сховати логотип EasyPay
* відображати/приховати логотип та назву партнера
* відображати/приховати опис з деталями токенізації
* відображати опис у згорнутому/розгорнутому вигляді

'''Приклад callback - запит з IP адреси 93.183.196.26 після успішної токенізації:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers

Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"partnerName",
"phone":"test989",
"cardGuid":"2ad57b2e-eb5b-4a99-ad05-788cf589b8af",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-02-24T17:32:07.447",
"codeType":"Mpi3Ds"
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережено картку
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>cardGuid</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |токен збереженої карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>pan</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |маскований номер картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |термін дії карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>datePost</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час додавання картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>codeType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ознака типу верифікації картки. Mpi3Ds – з використанням 3ds.
|}

'''Приклад callback - запит з IP адреси 93.183.196.26 з параметром ExistingToken:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers
Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":null,
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:41:53.152",
"codeType":"Code",
"existingTokens":[
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"bac4f855-xxxx-xxxx-bece-14cdf23c6c52",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:28:23.840",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"6338e8b4-xxxx-xxxx-a3e5-f46ad0cb0efa",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:34:25.733",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"18e3c35e-xxxx-xxxx-ba59-9506154394c0",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:39:42.010",
"codeType":"Mpi3Ds"
}
]
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>existingTokens</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |масив з даними раніше створених токенів по цій карті під даного партнера '''(partnerKey)'''
|}

===== Отримання списку токенізованих карт =====
----Метод призначений для отримання списку токенізованих карток за номером телефону (ознакою) користувача.
<br>
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCards/get</span></p>
'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams
phone = string
cardGuid= Guid
</syntaxhighlight>'''Response''' <syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"tokenCards": [
{
"cardGuid": "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan": "48741234****1234",
"expire”: "1222"
}],
"error": "null"
}

</syntaxhighlight>Якщо передати тільки ідентифікатор клієнта (параметр phone) - у відповіді будуть всі карти поточного клієнта. Якщо передати <code>phone</code> та <code>cardGuid</code> - у відповіді буде одна карта поточного клієнта.

<br>

===== Видалення токенізованих карт =====
----Метод призначений для видалення токенізованих карток за номером телефону. Якщо у клієнта під одним номером кілька карток, всі картки будуть видалені.
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone</span>

<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone?CardGuid=Guid</span></p>'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams

cardGuid= Guid

</syntaxhighlight>'''Response'''<syntaxhighlight lang="markdown" line="1">
headers
відсутній

body
відсутній
</syntaxhighlight>

===== Видача кредиту (переказ на картку користувача) =====
Метод призначений для переказу на картку користувача суми кредиту.
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateAPP]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
'''Request:'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order":{
"serviceKey":"CARD-FILL",
"description":"test top up card",
"amount":1.12, (decimal)
"orderId":"test",
"fields":[
{
"fieldName":"Pan",
"fieldValue":"4102321200001111",
"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"
},
{
"fieldName":"Phone",
"fieldValue":"38093520000"
}
],
"additionalItems": {
"Merchant.ClientFullName": "Иванов Петр Сергеевич",
"Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32",
"Merchant.Inn": "3334445823"
}
},
"userPaymentInstrument":{
"instrumentType":"Vcash"
}
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"redirectUrl": null,
"action": null,
"paymentState": "Confirmed",
"status": "Done",
"actionType": "UrlRedirect",
"transactionId": "766934634",
"retrievalReferenceNo": "null",
"responseItems": "null",
"error": "null"
}

</syntaxhighlight>'''Опис параметрів'''
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |paymentState
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |
* '''Confirmed''' оплата пройшла успішно
* '''WaitConfirm ''' очікується підтвердження платежу
* '''Rejected''' і '''Refunded''' платіж відхинело
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>transactionId</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" | ідентифікатор платежу в системі Easypay
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |У об'єкти поля передається інформація для поповнення карти. Номер картки можна вказувати:

* для випадку з PCI DSS сертифікацією: у відкритому вигляді

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldValue":"4102321200001111",</code>'''

* для випадку без PCI DSS сертифікації: у вигляді токена (як отримати токен картки - див. [[MerchantAPI#Токенізація карти|Токенізація карти]]):

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"</code>'''

Також потрібно вказати:

- номер телефону клієнта:

'''<code>"fieldName":"Phone",</code>'''

'''<code>"fieldValue":"38093520000"</code>'''

- ПІБ та адреса клієнта АБО ПІБ та ІПН клієнта:

'''<code>"additionalItems": {</code>'''

'''<code> "Merchant.ClientFullName": "Іванов Петро Сергійович"</code>'''

'''<code> "Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32"</code>'''

'''<code> "Merchant.Inn": "3334445862"</code>'''

'''<code> }</code>'''
|}

'''Статус видачі кредиту:'''

* Якщо у відповіді отримано кінцевий статус <code>(paymentState = Confirmed / Rejected / Refunded)</code> - необхідно присвоїти його платежу.
* Якщо кінцевий статус у відповіді не отримано <code>(paymentState = WaitConfirm)</code>, '''у тому числі при серверних, мережевих та будь-яких інших відповідях та помилках''' - необхідно запросити статус платежу методом '''orderState''' ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]) до отримання кінцевого статусу.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Важливо врахувати, що нотифікація про оплату не надсилається (якщо партнер/мерчант не повідомив про необхідність такого налаштування).<br><br>
Скасування транзакції не передбачено.
</p>
<br>

Response (Приклади відповідей при помилках: status code = 400)<syntaxhighlight lang="json" line="1">
{
"error": {
"errorCode": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"title": null,
"description": null,
"errorMessage": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"fieldErrors": [
{
"fieldName": "Order.Fields[0]",
"errorCode": "SERVICE_FIELDS_VALIDATION_EXCEPTION",
"errorMessage": "Вказана умова не була виконана для значення поля."
}
]
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pv2",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Обслуговуються тільки карти емітовані українськими банками",
"fieldErrors": []
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pa8",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Необхідно уточнити реквізити картки одержувача у банку емітента",
"fieldErrors": []
}
}

</syntaxhighlight>

===== Нотифікації (колбеки) щодо операцій поповнення карток =====
Дані колбеки є опціональним (додатковим) способом отримання інформації від EasyPay про результат виконання запиту на поповнення картки.

Для активації отримання колбеків мерчант (партнер) повинен повідомити EasyPay про таку необхідність, після чого EasyPay включає цю опцію.

Спосіб відправки колбека - '''HTTP - з IP 93.183.196.26''' буде надіслано '''POST''' запит з інформацією про платіж на вказаний <code>urlNotify</code>.

<code>urlNotify</code> прописується на стороні EasyPay і використовується за замовчуванням, якщо партнер не передав його у своєму запиті.

URL для повідомлень ('''UrlNotify''') повідомляє партнер (мерчант).

Партнер може передавати '''UrlNotify''' у запиті '''createOrder''' у параметрі:

<code>"order":{</code>

<code>"additionalItems":{</code>

<code>"Merchant.UrlNotify":"<nowiki>https://notify.url</nowiki>"</code>

<code>}</code>

<code>}</code>

"Merchant.UrlNotify" параметр не може бути порожнім і повинен відповідати формату URL.

Якщо у відповідь не отримано HTTP StatusCode 200 - запит нотифі буде надіслано повторно, доки не отримано статусу “200 ОК”.

Коли нотифікацію (колбек) успішно доставлено (отримано статус 200 ОК), повторне відправлення колбеків припиняється.

Відправлення колбеків можливе за двома сценаріями:

1) лише за успішними операціями (транзакціями);

2) за операціями (транзакціями) у фінальному статусі (успішні та відхилені).

Надання фінального статусу операції (транзакції) асинхронно з процесом відправки колбека (фінансова транзакція набуває фінального статусу незалежно від статусу прийняття колбека партнером).

'''Request''' <syntaxhighlight lang="markdown" line="1">
headers

"Sign: "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
"User-Agent": "EasyPay.MerchantNotifyService"

body

{
"action": "payment",
"merchant_id": 5347,
"order_id": "5",
"date": "2019-06-19T15:38:10.7802613+03:00",
"details": {
"amount": 1.00,
"desc": "Wooden tables x 10",
"payment_id": 724502946,
"recurrent_id": null
},
"additionalitems": {
"BankName": "CB PRIVATBANK",
"Card.Pan": "414962******1234",
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>action</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>merchant_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер сервісу партнера на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>order_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>date</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>details</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">детальна інформація про платіжну операцію (транзакцію) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''payment_id -''' ID детальна інформація про платіжну операцію (транзакцію):
* '''amount''' - сума фінансової операції;
* '''desc''' - опис замовлення, отриманий під час запиту CreateOrder;
* '''recurrent_id''' - ознака реккурентного платежу (завжди за замовчуванням на операціях поповнення картки – null);</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalitems</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">блок додаткових параметрів, до якого можуть включатися додаткові айтеми, отримані в запиті CreateOrder:
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''BankName''' - назва банку власника картки;
* '''Card.Pan -''' номер картки у маскованому вигляді.</td>
</tr></table>

Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> У випадку, якщо підпис <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">notify</span> не перевірено, всі фінансові ризики перекладаються на партнера.
</p>

== Інтеграція з ApplePay ==
----Вимоги

# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитись з умовами надання послуг Apple Pay.
# Необхідно укласти договір із Easypay.ua.
<br>Apple Pay надає простий та безпечний спосіб проведення платежів у додатках iOS, watchOS та сайтах Safari. Використовуючи Face ID, Touch ID або двічі клацнувши Apple Watch, користувачі можуть швидко та безпечно передавати свої платіжні дані для оплати.

=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка Apple Pay буде відображена на сторінці оплати EasyPay

=== Оплата ApplePay з додатку ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], в який потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимоги до брендування].

<br>
==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.

''Примітка: * - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).''

# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay

==== Технічна інтеграція з ApplePay ====

# Щоб інтегрувати Apple Pay у мобільний додаток, дотримуйтесь інструкцій за посиланням: https://developer.apple.com/documentation/passkit/apple_pay.

'''Приклад відповіді ApplePay''' <syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>2. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token в Easypay</code> ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Приклад запиту '''createOrder''':<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{ApplePayMerchantId}"
}
}

</syntaxhighlight>

=== Оплата із сайту ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], до якого потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимог до брендування].

==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).</em>
</p>
<br>
# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay
# Зареєструйте та підтвердіть свій домен:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі "Merchant Domains" натисніть "Add Domain".
## Введіть ім'я домену та натисніть "Continue" *.
## Завантажте файл apple-developer-merchantid-domain-association.txt.
## Збережіть файл на сервері від Apple.
## Натисніть Verify.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - домен повинен підтримувати HTTPS.</em>
</p>
<br>
# Створіть Apple Pay Merchant Identity Certificate:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Merchant Identity Certificate натисніть Create Certificate.
## Виконайте дії, описані на сайті Apple, а потім натисніть «Continue».
## Скопіюйте згенерований CSR-файл, вибравши Choose File, а потім Continue.
## Завантажте згенерований сертифікат (merchant_id.cer) і відкрийте його у програмі Keychain Access на комп'ютері Mac.
## У Keychain Access виберіть сертифікат, що імпортується, та експортувати його у формат .p12 (Personal Information Exchange).
## Виконайте команду: openssl pkcs12 -in merchant_id.p12 -out merchant_id.pem -nodes -clcerts
## Скопіюйте створений сертифікат у форматі PEM на сервер. Це буде потрібно для створення [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/requesting_an_apple_pay_payment_session Apple Pay Payment Session] в процесі [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/providing_merchant_validation перевірки магазину].

<br>
==== Технічна інтеграція з ApplePay ====
Для створення сертифікату (-ів) від Партнера потрібні:

# Country Name (2 letter code) [AU]: ?
# State or Province Name (full name) [Some-State]: ?
# Locality Name (eg, city) []: ?
# Organization Name (eg, company) [Internet Widgits Pty Ltd]: ?
# Organizational Unit Name (eg, section) []: ?
# Common Name (e.g. server FQDN or YOUR name) []:?
# Email Address []: ?

Повідомте, чи буде оплата тільки в додатку, або також і на WEB.

Щоб інтегрувати Apple Pay на сайт, дотримуйтесь інструкцій за [https://developer.apple.com/documentation/apple_pay_on_the_web. посиланням]

# Перевірте можливість оплати з Apple Pay. Виконується перевірка, підтримує або браузер оплату з Apple Pay, а також є у Wallet картку, якою можна оплачувати.
<syntaxhighlight lang="markdown" line="1">
if (window.ApplePaySession) {
var promise = ApplePaySession.canMakePaymentsWithActiveCard({YOUR_MERCHANT_ID});
promise.then(function(canMakePayments) {
if (canMakePayments)
});
} else {
}

</syntaxhighlight>
2. Сформуйте структуру платежу для сесії<syntaxhighlight lang="markdown">
document.getElementById("apple-pay-button").onclick = function(event) {
var paymentRequest = {
currencyCode: 'UAH',
countryCode: 'UA',
total: {
label: {PRODUCT_NAME},
amount: {PAYMENT_AMOUNT}
},
merchantCapabilities: ['supports3DS'],
supportedNetworks: ['masterCard', 'visa']
};

var session = new ApplePaySession(3, paymentRequest)

</syntaxhighlight>
3. Відкрити платіжну сесію з Apple, отримати від них paymentData:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/applePay/validateSession</span><syntaxhighlight lang="json" line="1">
headers

--header "Content-Type: application/json"
--header "AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209"
--header "PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760"
--header "PartnerKey: easypay-test"
--header "locale: ua"

body
{
"url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
"merchantIdentifier": "string", /ідентифікатор мерчанту в Apple/
"displayName": "test", /ідентифікатор магазина/послуги/товару (латиниці) ; буде відображатися в toolBar/
"initiative": "web", /Канал оплати/
"initiativeContext": "string" /Доменне ім’я, Доменное имя, пов'язане із сертифікатом Apple Identity/
}

</syntaxhighlight><blockquote>*response з цього методу передається в сесію Apple, після чого при успішній авторизації платежу, повернеться до необхідний для завершення платежу.</blockquote>4. Приклад відповіді ApplePay<syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>5. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token</code> в Easypay ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Перед цим потрібно викликати метод EasyPayApi CreateApp.

'''Приклад запиту createOrder:'''<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{YOUR_MERCHANT_ID}"
}
}

</syntaxhighlight>

== Інтеграція з GooglePay ==
----'''Вимоги'''
# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитися з [https://payments.developers.google.com/terms/sellertos умовами надання] послуг GooglePay.
# Необхідно укласти договір із Easypay.ua.

Google Pay™ - це миттєвий спосіб оплати від Google, який дозволяє просто та швидко сплатити карткою, без необхідності вводити дані для кожного платежу. Ці картки надійно зберігаються в Google. Даний метод доступний для оплати в мобільних програмах на будь-яких пристроях Android і при здійсненні платежу в браузері Chrome.

• '''Документація'''

# [https://developers.google.com/pay/api/android Для додатків]
# [https://developers.google.com/pay/api/web Для веб-сайтів]

• '''Вимоги щодо брендування'''

# [https://developers.google.com/pay/api/android/guides/brand-guidelines Для додатків]
# [https://developers.google.com/pay/api/web/guides/brand-guidelines Для веб-сайтів]

<br>
=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка GooglePay відображається на сторінці оплати EasyPay.

=== Отримання токена GooglePay для оплати ===
----<nowiki>*</nowiki>Використовуйте бойове середовище GooglePay для отримання PaymentData

Для отримання PaymentData. Як параметри скрипта вкажіть:

# Доступні методи платежу: var allowedPaymentMethods = ['CARD', 'TOKENIZED_CARD'];
# Тип токенізації- PAYMENT_GATEWAY: tokenizationType: 'PAYMENT_GATEWAY';
# Параметр gateway: easypay;
# Параметр gatewayMerchantId: Ваш бойовий merchantAccount от Google, який повідомляє в EasyPay.

Якщо з вашого боку інтеграція виконана правильно, Ви на своєму сайті/додатку отримаєте кнопку

Після натискання кнопки на пристрої з підключеним Google Pay з'явиться спливаюче вікно або форма вибору прив'язаної картки.

'''Приклад відповіді від GooglePay Api'''<syntaxhighlight lang="json">
{
"apiVersionMinor":0,
"apiVersion":2,
"paymentMethodData":{
"description":"Mastercard •••• 1164",
"tokenizationData":{
"type":"PAYMENT_GATEWAY",
"token":"{"signature":"MEUCeretMPEQPUMnvMOnDAgZsOLVnFnfjmo5ALe/1D6o7hdzAiEA94L1GfNWW84kbUdHHn+l6B6n18VgIA3sdkPqKL36tqk\u003d","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEem3biYxltOBuMV+Dd9g+ZhV3VEzP2vAlFXvb9tJoYGLtetxDYWTUqnXPvKGDeAnSNrkPo8hu5kLtxN0QXCYkqQ\\u003d\\u003d\",\"keyExpiration\":\"1551385212256\"}","signatures":["MEYCIQD/TWKunZJhG/u3iL2H5P3i9r0rCbpw1/+z9dr/yGytvwIhAPfV2zF5cqP/L+42W+JKv6fgQKBEc67HTtfderefdghJ"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"OidSptk8w+I3FnR1VFmiVswXaZ7ADnmMP1MQelp6GSg0/3aVpAXeLRH/fT1wN7gpxNPy7tFITeQenrJm3QG19tAPuVhcAVM26DMU6LAmZPyPXALktpnYrUj6etCjvWWM/1LkhjDBSjtkmpWRiHIyqj5aud/j8rxFEk06GhwqPWbnJwdCgNf32LJP7bSpUWvHOioaZIV1vdeV6d7iQ6EDWWAS/z9pXWkqpW//M/TVTrcKFXh4C2TI2O+qyBD9VzK3TqU6wS5VsYL69W9/4xzV5L5irpp/wzNfPHkJd8QIwcsIPuNWBtGm3v+JCaqIA3oK9Sw/5o/gZp/pnOhUdax0VjGEvmbGXs2+ufBChCkh+/BpobbpzVS9T/DZSlUO2FLANMjSaEQzh74ymtDgP4x9O64RAdySW+V7lVZMa7FVZ3PFnTfa8W89pzIgo6ocSGHQPBFnExTmSbDpUU0L12wzHkAcZSyngPAljqg\\u003d\",\"ephemeralPublicKey\":\"BBKgbSbykNy1111QYRmGJEhnCorkt+VoDYlYbAlg0a5WO2uV/M50XqOSG0uxWAvUqrZolQuEX6yZ+dvvufLEZtI\\u003d\",\"tag\":\"p9ItvOfsQVTzhTPHq6ycYjKX1TtozP/yym4QWWVRVCk\\u003d\"}"}"
},
"type":"CARD",
"info":{
"cardNetwork":"MASTERCARD",
"cardDetails":"1164",
"billingAddress":{
"phoneNumber":"+380 93 000 00 11",
"address3":"",
"sortingCode":"",
"address2":"",
"countryCode":"UA",
"address1":"ул. ",
"postalCode":"49107",
"name":"Super 1",
"locality":"Київ",
"administrativeArea":"Київська область"
}
}
},
"email":"test@easypay.ua"
}

</syntaxhighlight>

=== Передача токена для оплати ===
Надішліть дані з поля token з відповіді від '''GooglePay Api''' у поле '''userPaymentInstrument/token''' у Easypay (розділ [[MerchantAPI#Створення замовлення|Створення замовлення]])

Перед цим потрібно викликати метод '''EasyPayApi [[MerchantAPI#Реєстрація точки та створення сесії|createApp.]]'''

'''Приклад запиту'''
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span><syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210000-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"GooglePay",
"token":"{\"signature\":\"MEQCIFTFadYw15Cqfk7+YiM9pp5zEvyTI7oWVZCNFKr1cMthAiAFMv+nt0PWOEhj6LmmMNTByP9E4OhGrSoE7rDvzLDIZw\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEsrkMsOBN8N0xL8AsTVUIETODhCva5PpGFxvPm56pWmI5MG2HKKHXjsdhdvcP6N3d40x90E0rZzDrxBC2ywERXg\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1618591579000\\\"}\",\"signatures\":[\"MEUCIHX0SawuKctPUEjdFu2sDiE81aSSdf8i0KNvdg1dlsWoAiEAye8TEWpPk4sp7EjTovN7DichK6YxY1DajYN9/ArHDYI\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"vlLmhIBndM4a/GWFsvbFZrZOygjAwUao/NlvlJlhAQ3kdprI3gubAcQxAau8L74dkzGJh8w7AD2E77XOHycdwG91NUvsJ0xiXuMCXHJ9NPMhp7k49OUIJjOpJG+RqUM9/SPBgx69eDD7skhG+axZYr/m36LFjIlk5WhmumQgIrfojm02uRm0nOcZ2wbvrwQKZyL1IeTv/txqcYMuQqYWzs/FPkIEbiQ80z6dRhVszrEXcHLKcfBmNmcn/Vk90ArXCotOD52V0JS/Q+Mf9mCoe9G2bABo9R9PAYT/FrKIEOQEhzLCI7m4/vyIlCMf69d6PjigP3AOGxykbS0Kvsxqoh+HYRFCSLCd+8O2Us2wCYD09/OBqcQi78/fs2vwyg4nrWQQJ6ZGwTKHHxVRY8VGAUUnMFr18HPsN1BQNuz08M4t6Qx6X0nEZ3hseSIcUMVcBm+NyvL2T/XSWqTh2poDuQ4B+UJ59gMrsPapzouxk2iC/+vS1Bs/2sSf77Nsqr7BhE7SMgnZ/a2LF+Shx2aOKSIGflMz+MjVSzpMg2AUh43pbcsi8g\\\\u003d\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BDJpYzoN9XPVKrHIxwNes83HbR0/AOUPpQgAwi3fTzR+TIB8/VAc9CdI9guWX8Pjvii/T+WxwcByuo9pzJC7518\\\\u003d\\\",\\\"tag\\\":\\\"LFOOTwd5Crtn60KnT0J6MHuFlGE0+EYL3D7IrWrPsRA\\\\u003d\\\"}\"}",
}
}

</syntaxhighlight>

== Створення підпису ==
----Формування підпису Sign (основний варіант для POST – запитів)<syntaxhighlight lang="text">
Sign = base64(sha256(secretKey + requestBody))

</syntaxhighlight>'''Де:'''
* <code>secretKey</code> – секретний ключ.
* <code>requestBody</code> – тіло запиту у форматі JSON (ідентичне формату EasyPay).
<br>

=== Приклади коду ===
----'''C#'''

<code>Convert.ToBase64String(SHA256.Create().ComputeHash(Encoding.UTF8.GetBytes(data)))</code>

'''PHP'''

<code>base64_encode(hash('sha256', ($secretKey.$requestbody), true))</code>

<br>
== Можливі варіанти інструментів оплати ==
----

===== Оплата <span style=" display: inline-block; padding: 4px 16px; border: 2px solid #0033A0; /* Темно-синій колір рамки */ background-color: #0033A0; /* Темно-синій фон */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ ">VISA</span> <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid transparent; /* Прозора рамка для градієнту */ background: linear-gradient(to right, #FF5F00, #FFBF00); /* Градієнт від червоного до оранжевого */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">MasterCarD</span> =====
<syntaxhighlight lang="json" line="1">
"paymentInstrumentsTypes": [
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 200,
"additionalParams": {}
}
]
]
},
{
"instrumentType": "RCard",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>
===== Мобільні гроші <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #00A3E0; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #00A3E0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Київстар</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #F7E300; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #0033A0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Lifecell</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #E60012; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #E60012; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Vodafone</span> =====

<syntaxhighlight lang="json" line="1">
{
"instrumentType": "KSMoney",
"commission": 0.0,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4958975,
"instrumentType": "KSMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.0,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 1,
"additionalParams": {}
}
]
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 6000.00,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]

</syntaxhighlight>

===== Картки лояльності <span style=" display: inline-block; padding: 8px 20px; border: 2px solid #FF0000; /* Червона рамка */ background-color: #FF0000; /* Червоний фон */ color: white; /* Білий текст*/ font-family: Arial, sans-serif; /* Шрифт Arial */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Розмір шрифта */ ">Fishka</span> =====
<syntaxhighlight lang="json" line="1">
]
},
{
"instrumentType": "FishkaB2B",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},
{
"instrumentType": "FishkaB2C",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>

===== Оплата <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #000000; /* Темно-синій колір рамки */ background:FFFFFF ; /* Темно-синій фон */ color: #000000; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">ApplePay</span> <span style=" display: inline-block; padding: 8px 20px; border-style: solid; border-width: 4px; border-color: #4285F4 #EA4335 #FABB05 #34A853; /* Чітке розмежування кольорів */ background-color: #FFFFFF; /* Білий фон всередині */ color: #000000; /* Колір тексту */ font-family: Arial, sans-serif; font-weight: bold; text-transform: uppercase; font-size: 16px; border-radius: 24px; /* Закруглені краї */ ">GPAY</span> =====
<syntaxhighlight lang="json" line="1">
{
"instrumentType": "ApplePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958126,
"instrumentType": "ApplePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"instrumentType": "GooglePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958137,
"instrumentType": "GooglePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams":
{
"PublicKey": "BKdzipvJvJzcbTMm3dO0LEh1AXFr8qfSiPjwrI7vv9F6hqhDJB1M="
}
}
]
}
]

</syntaxhighlight>

=== Управління інструментами оплати ===
----Управління інструментами оплати на сторінці оплати EasyPay здійснюється при створенні замовлення. Параметр <code>allowedInstruments</code> визначає, які інструменти оплати будуть відображатися на сторінці платіжного шлюзу.
<br>
<syntaxhighlight lang="json" line="1">
"userInfo": {
"phone": "string"
},

Обов'язкові параметри:
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)
"allowedInstruments": [ "string" ]
</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>allowedInstruments</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр в якому передаються інструменти оплати, які будуть відображені на сторінці </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* RCard
* Card
* EBank
* FishkaB2C
* ApplePay
* GooglePay</td>
</tr></table>
'''<br>
Поведінка системи'''
# '''Якщо параметр''' <code>allowedInstruments</code> '''не передано або він порожній''': На сторінці оплати будуть відображені всі доступні інструменти, які підключені для партнера.
# '''Якщо з переданих інструментів немає доступних для оплати''': Повертається помилка: <code>PAYMENTINSTRUMENT_NOT_FOUND</code>
# '''Приклад помилки''': У разі, якщо у партнера активні ApplePay і Card, а в запиті передається GooglePay, повертається помилка <code>PAYMENTINSTRUMENT_NOT_FOUND</code>.
# '''Якщо передані доступні інструменти оплати''': У разі, якщо партнер передає, наприклад, GooglePay та Card, але GooglePay не активний для цього партнера, система поверне посилання з активним інструментом Card.
<br>

== Технічна підтримка ==
----За потреби консультацій з питань реалізації API можна написати запит на ''merchant.api.support@easypay.ua''

MerchantAPI

2025-10-07T13:55:55Z

Vadim.fedorchuk:

== Загальні відомості ==
----Протокол призначено для торговців, які є одержувачами платежів. Продавець підписує договір про прийняття платежів або анкету-акцепт до публічної оферти.

Щоб отримати платежі, ви можете використовувати web, мобільні версії сайтів, а також мобільні програми. У разі використання цього протоколу не здійснюється перевірка даних для ідентифікації замовлення або облікового запису. EasyPay завжди приймає дані, надіслані та створені продавцем.

=== Заголовки запитів ===
----

Для надсилання запиту та отримання відповіді у форматі JSON, необхідно передати такі обов’язкові заголовки у запиті.<syntaxhighlight lang="jsonml+bst" line="1">
--header 'Content-Type: application/json'

--header 'AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209'

--header 'PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760'

--header 'PartnerKey: easypay-test'

--header 'locale: ua'

--header 'Sign: bS+vPOwu1Sif1Iz47Cdh+z1RAi0s6X21C3uU0YNBNWE='
</syntaxhighlight>

=== URL ===
----<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Посилання</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>

<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>https://merchantapi.easypay.ua</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Production</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">в т.ч. для надсилання тестових запитів</td>
</tr><tr><td>https://localapi.easypay.ua</td><td>Test</td><td>локальний тест </td></tr></table>

<br>

=== Налаштування безпеки ===
----Партнер надає IP, з яких будуть здійснюватися запити.
<br>
<br>

=== Реєстрація партнера в системі EasyPay ===
----Реєстрація нового торговця передбачає отримання унікального ідентифікатора '''PartnerKey'''.

===== Характеристика параметрів реєстрації =====
<div style="overflow-x: auto; display: block; width: unset !important; height: auto !important; border: none;">
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор партнера (продавця) у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор сервісу торговця у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>SecretKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">секретний ключ для формування підпису</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>
<br>

=== Тестові параметри ===
----Для тестових запитів використовуються такі параметри:<br><syntaxhighlight lang="pl">
PartnerKey = easypay-test
ServiceKey = MERCHANT-TEST
SecretKey = test

</syntaxhighlight>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
На даний момент відсутня можливість тестування з використанням фейкових оплат / тестових карток.
Платежі тільки реальні, їх можна відмінити в день оплати методом
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">cancelOrder</span>
([[MerchantAPI#Скасування платежу|Скасування платежу]])
</p>

===== Тестове середовище =====

Перед початком використання тестового середовища необхідно надати ір з яких будуть надходити запити, для відкриття доступу. На тестовому середовищі використовуються методи аналогічні Merchant Api.

'''Тестові дані:'''

* PartnerKey:credit-test
* SecretKey: credit-test

* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-TO-CARD - виплата
* Надсилання колбеків з Iр: 195.230.131.50 <br>
<br>
'''Тестові картки для верифікації/виплат:'''

Код підтвердження для 2дс при верифікації картки: 123456

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5167803258208169</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4235751329985326</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4111111111111111</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна без створення транзакції
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4999999999990011</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата з затримкою статусу 5 хв</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4217198608967728</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата з затримкою статусу 5 хв
</td>
</tr></table>
<br>
'''Тестові картки для оплати:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5168752081922117</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0128/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4909150002132451</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0129/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна 2ДС оплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>4300380058021820</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0130/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Не успішна з 3ДС + помилка PAYMENT_ALFABANK_116
</td>
</tr><tr><td><code>'''5567217349220669'''</code></td><td>0130/111</td><td>Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td></tr></table>
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
У разі отримання помилки <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">APPID_NOT_FOUND</span>
у відповідь на будь-який метод, необхідно повторити запит
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">createApp</span>
до отримання точки ІД.
</p>
<br>

== Основні запити/відповіді ==
<hr color="#d3d3d3" size="1" noshade>
<br>
==== Реєстрація точки та створення сесії ====
Цей метод слід викликати, коли користувач вперше звертається до платіжної сторінки. Якщо браузер або пристрій змінюються, метод знову з'являється
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createApp</span>
</p>
'''Request'''<syntaxhighlight line="1" lang="json">
headers:

"PartnerKey": "partnerName",
"locale": "ua"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json-object" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": "https://cdn.easypay.ua/hint_images/",
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "f3f2b678-a3c4-45ba-a865-a136fe4a62bd",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> '''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>

<br>

==== Створення сесії ====
----Даний метод створює новий екземпляр сеансу для користувача , <code>PageId</code>.
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createPage</span>
</p>'''Request'''<syntaxhighlight line="1" lang="json">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": null,
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "29bd7237-6b8d-4048-b028-6efc23d05988",
"requestedSessionId": "fa3595d3-52de-4744-9fc6-ec2d3507d5a5",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">За замовчуванням, якщо не було активності за запитами, час життя PageId - 20 хвилин. З кожним запитом життя PageId автоматично продовжується.</td>
</tr>
</table>
<br>

==== Створення замовлення ====
----Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Для кожного нового запиту <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">CreateOrder</span> потрібно використовувати унікальний <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">PageID</span>.
</p>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/createOrder</span>
</p>

</p><syntaxhighlight lang="markdown" line="1">
headers

'Content-Type': 'application/json'
'PartnerKey': 'partnerName'
'locale': 'ua'
'AppId': 'a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId': '2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign': 'e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

<br>
</syntaxhighlight><syntaxhighlight lang="json" line="1">
{
"userInfo": {
"phone": "string"
},
Обов'язкові параметри:

"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)

Необов'язкові параметри:
"paymentOperation":"PaymentTokenization",
"additionalItems": {},
"expire": "2019-04-15T07:49:20",
"isOneTimePay": true,
"fields": [
{
"fieldName": "string",
"fieldValue": "string",
"fieldKey": "string",
}
]
},
"urls": {
"success": "string",
"failed": "string",
"back": "string",
},
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string",
"id": "string"
},
"narrative": {
"name": "string"
}
},

"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string”
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true
}
]
},
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid",
"pan": "string",
"expire": "MM/YY",
"cvv": "string",
},
"partnerInfo": {
"id": "string",
"name": "string",
"account": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги мерчанта (видає EasyPay)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>description</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення (до 120 символів)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення, роздільник - точка </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип платіжного процесу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* '''PaymentTokenization -''' використовується для токенізації картки, якою буде сплачено це замовлення.
* '''Працює лише для інструмента “карта”'''. Повинен бути заповнений ідентифікатор клієнта '''"userInfo": { "phone": "string"}'''
* Якщо передано URL для колбеку, то після успішної оплати відправляється колбек про платіж та колбек про токенізацію (приклади колбеків про оплату - в [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]], про [[MerchantAPI#Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна)|токенізацію]].
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>userInfo/phone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер телефону (або ідентифікатор) клієнта </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Номер телефону необхідний:

* для отримання списку токенізованих карток (інформація буде в масиві StoredCards)
* при оплаті із зазначенням токена картки
* для токенізації картки після успішної оплати разом із параметром
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>expire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення заданого часу замовлення сплатити неможливо. Час життя сторінки може відображатися на платіжній сторінці у вигляді таймера (за замовчуванням таймер вимкнено). Значення має бути більшим за поточний час на 6 хвилин.
'''Значення за замовчуванням - 3 дні'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>sOneTimePay</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">включає можливість успішно оплатити замовлення лише 1 раз за конкретним forwardUrl </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Значення:

* True - за замовчуванням;
* False - оплатити замовлення по тому самому ''forwardUrl'' можна буде кілька разів;</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>urls</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
*'''back -''' URL для повернення на вказану сторінку з фінальної сторінки успіху EasyPay.
* '''success -''' URL сторінки успіху, для редиректу клієнта у разі успішної оплати.
* '''failed -''' URL сторінки помилки для редиректу клієнта у разі неуспішної оплати</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''back -''' На фінальній сторінці EasyPay вгорі зліва з'явиться кнопка “Повернутись назад” з посиланням на вказану URL-адресу. Параметр не може бути порожнім і повинен відповідати формату URL.
* '''success''' - у разі, якщо не було передано urls{success,failed} для редиректу після оплати. Після оплати клієнт може не дочекатися редиректу на цей url, тому редирект не можна використовувати як індикатор успішної оплати, отримання оповіщення про успішний платіж - '''див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
* '''faild -''' приклад get-параметрів, які приходять на '''url.failed та url.succes''' (те ж, але без ''errorCode''):

<code>?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=</code>

<code>Тестове+описання+замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&''errorCode=PAYMENT_ALFABANK_-2006''&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</table>

<br>

'''Необов'язкові додаткові поля'''

'''<code>additionalItems</code> –''' необов'язкові додаткові параметри, наприклад:
<br>
<syntaxhighlight lang="json" line="1">
"additionalItems":{
"PayerEmail":"client@i.ua",
"PayerPhone":"380930007603",
"Merchant.UrlNotify":"https://notify.url",
"Merchant.Param1":"CustomValue",
"CurrencyAmountLabel":"123.56$"
},
</syntaxhighlight>'''Опис параметрів<br>'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerEmail</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">емейл клієнта для оповіщення його у разі неоплаченого замовлення та для автоматичного заповнення поля “Надіслати квитанцію на email” на сторінці оплати. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається – він не може бути порожнім і має відповідати формату email.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerPhone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">телефон клієнта, на який протягом 15-20 хв після виклику CreateOrder відправиться нагадування про неоплачене замовлення (смс або вайбер). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається, він не може бути порожнім і повинен відповідати формату телефону.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.UrlNotify</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL для надсилання нотифікації за успішним платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Параметр не може бути порожнім і має відповідати формату URL.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.Param1</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">індивідуальний параметр партнера Param1 узгоджується з EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>
</table>

<br>
'''<code>reccurentPayment</code> -''' інформація для створення рекурентного платежу на основі поточного. Рекурентний платіж буде створений за розкладом, якщо основний платіж виконаний за допомогою інструментів card, Rcard, Vcard, LifeMoney
<br><syntaxhighlight lang="json-object" line="1">
"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>cronRule</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">правило у cron-форматі, з якою періодичністю повторювати рекурентний платіж, наприклад 10 20 15 * * (кожного 15 числа місяця о 20:10). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо ця властивість порожня, значить рекурентний платіж виконуватиметься на вимогу продавця.
'''Плануйте перше виконання рекуренту щонайменше 20 хвилин від дати успішного платежу.'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateExpire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата, після якої не проводити рекурентний платіж.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateRun</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата першого запуску рекурентного платежу (опціонально). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо не заданий, перший запуск розраховується за '''recurrent/cronRule'''
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>properties</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри (опціонально) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''reccurent/properties/amount -''' сума кожного рекурентного платежу, наступного після основної оплати (опціонально)
* '''reccurent/properties/failedCount -''' ккількість поспіль неуспішних викликів рекурентних оплат, після чого рекурентний платіж видаляється (опціонально). За замовчуванням - 4 спроби: при неуспіху - повторюється спроба кожні 20-30 хвилин, 4 неуспішних спроби поспіль по одному recurrentId - і рекурент відключається. Якщо після 3 неуспішних спроб була 1 успішна, то лічильник неуспішних для цього рекурента скидається.
* '''reccurent/properties/failedRule -''' cron-правило (період) повтору при неуспішному виклику рекурента (опціонально)
* '''reccurent/properties/UrlNotify''' - URL для надсилання нотифікації за успішним '''рекурентним''' платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
</td>
</table>
<br>
'''<code>bankingDetails</code> -''' передача банківських реквізитів для перерахування коштів у випадку, якщо банківські реквізити можуть змінюватися щодо різних платежів одного сервісу продавця. На стороні EasyPay має бути увімкнено режим "Отримувати реквізити із запиту".
<br>
<syntaxhighlight lang="json" line="1">
{
"bankingDetails": {
"payee": {
"id": "123664578",
"name": "департамент патрульної поліції",
"bank": {
"name": "пат пумб",
"mfo": "330556",
"account": "123654778889"
}
},
"payer": { "name": "Иванова Мария" },
"narrative": { "name": "Переказ коштів згідно договору з ФК № 111/11-П від 11.11.1111 р. за виключенням винагороди за їх переказ згідно реєстру від [work_date]р." }
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/ID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">код одержувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">ЄДРПОУ або ІПН</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">одержувач </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банк отримувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Mfo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">МФО банку </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">може не заповнюватися, якщо Payee/Bank/Account містить IBAN</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Account</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">р/р одержувача або IBAN </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payer/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">платник </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Narrative/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">призначення платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 157 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">повну структуру bankingDetails можна не передавати, для цього достатньо передати </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">

ідентифікатор банківських реквізитів із довідника, який узгоджений із конкретним партнером та перебуває в системі EasyPay.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">

</td>
</table>

'''Splitting''' - інформація щодо сплітування (розщеплення) платежу.

Частина загальної суми з order/amount розподіляється відповідно до інформації в splitting/items/value, а залишок - йде на основні реквізити з bankingDetails (або bankingDetailsId). На стороні EasyPay має бути увімкнено режим “Отримувати реквізити із запиту

Структура '''items''' це масив. Основний платіж буде розщеплений стільки платежів, скільки міститься у цьому масиві плюс залишок. Кожен розщеплений платіж буде надіслано на відповідні банківські реквізити <code>items/bankingDetails</code>. Залишок коштів буде надіслано на реквізити основного платежу з <code>BankingDetails</code> або <code>bankingDetailsId,</code> які потрібно обов'язково вказувати під час сплітування.
<br>
<syntaxhighlight lang="json" line="1">
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string"
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>

 <tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор послуги, за якою ініціюється зарахування спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/orderId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор внутрішнього замовлення Мерчант для маркування конкретного спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/bankingDetails</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банківські реквізити кожного розщепленого платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/unit</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">може бути '''Amount''' (сума розщепленого платежу в грн.) або '''Percent''' (сума розщепленого платежу вважається відсотком від загального). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/value</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">значення у цифрах. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/withCommission - true/false</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Вказує з якого з одержувачів слід утримати внутрішню комісію. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Сума комісії розраховується із загальної суми платежу, а утримується - з першого одержувача зі '''splitting,''' у якого '''withCommission=true'''. Якщо ні в кого з '''splitting''' не зазначено '''withCommission=true''', то комісія втікає з “основного” одержувача, вказаного в bankingDetails.
Якщо у всіх значення '''withCommission=false''' (або не передали), то комісія утримається з "основного одержувача", вказаного в параметрі '''bankingDetails'''

Якщо всі значення '''withCommission=true,''' то комісія утримається з першого одержувача, зазначеного в splitting. Залишок буде надіслано на реквізити основного платежу з '''bankingDetails''' або '''bankingDetailsId.'''

При встановленому сервісом Типі розрахунків “За актами", одержувачам перераховується повна сума, без відрахування комісії, незалежно від значення WithComission.
</td>
</tr>

</table>
<br>

Після виконання сплітування під кожен спліт (частини) платежу на стороні EasyPay створюється фінансова транзакція з унікальним transactionID.
<br>
* Якщо списання грошей з картки пройшло успішно і всі реквізити для спліту вказані корректно (доступні) - всі транзакції набувають успішного статусу і по кожній транзакції відправляється колбек.
* Якщо списання грошей з картки пройшло неуспішно – запит відхиляється з кодом фінансової помилки;
* Якщо списання грошей з картки пройшло успішно, але хоча б один із реквізитів зазначено неправильно – всі транзакції спліту (частини) платежу – будуть відхилені.
<br>
Після проведення успішного списання та сплітування по кожній фінансовій транзакції в рамках спліту направляється колбек (нотифікація) про успішний платіж. Приклад коллбека (нотифікації) вказаний у [[MerchantAPI#Повідомлення про платіж|повідомлення про платіж]]'''''.'''''

<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Якщо параметр <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">userPaymentInstrument</span> не є порожнім, створення платежу буде відбуватися автоматично.
</p>

Для різних інструментів передаються такі параметри:

'''userPaymentInstrument –''' інструмент оплати.

'''*Картка (PCI DSS)'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "Card",
"pan": "5168123456780123",
"expire": "MM/YY",
"cvv": "string" }

</syntaxhighlight>

'''*Токенізована Карта'''<syntaxhighlight lang="json" line="1">
{"userInfo":{"phone":"380935207603"}, /Phone,під яким токенізована карта/
…
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid", /токен картки/
}
}

</syntaxhighlight>
'''Kyivstar Money/Life Money /VodafoneMoney'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "KSMoney / LifeMoney / VodafoneMoney",
"phone": "380xxYYYYYYY" }

</syntaxhighlight>'''ApplePay/GooglePay'''
<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "ApplePay / GooglePay",
"token": “string”/Токен, отриманий від Apple | Google /
}

</syntaxhighlight>

* '''partnerInfo –''' інформація про партнера
* '''partnerInfo.name –''' найменування партнера
* '''partnerInfo.id –''' ВД (ЄДРПОУ) партнера
* '''partnerInfo.account –''' рахунок партнера (особовий рахунок/IBAN…)

*

<br>

==== Створення замовлення для холдованих платежів ====
Перед використанням методу потрібне додаткове налаштування терміналів зі сторони техпідтримкиEasyPay.

Перед викликом цього методу потрібно викликати один із методів:

'''[[MerchantAPI#Створення сесії|- CreateApp]]'''

'''[[MerchantAPI#Створення сесії|- CreatePage]]'''

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>'''REQUEST HEADERS'''<syntaxhighlight lang="http">
PartnerKey: partnerName
locale: ua
AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1
PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d
Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4=
</syntaxhighlight>'''REQUEST BODY'''<syntaxhighlight lang="json">
{
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount": 1.01,
"paymentOperation": "Hold",
"expire": "2019-04-15T07:49:20.009Z",
"isOneTimePay": true,
"additionalItems": {}
},
"urls": {
"success": "string",
"failed": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>orderId</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор замовлення в системі партнера </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>description</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>amount</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td></tr>
<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation = Hold</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр, що вказує, що подальший платіж буде холдовано(зарезервовано) з можливістю підтвердження або скасування. </td></tr>

</table>

'''Необов'язкові параметри'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>expire</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення вказаного часу замовлення оплатити неможливо. При ненульовому значенні на платіжній сторінці відображатиметься таймер. Значення повинне перевищувати поточний час щонайменше на 5 хвилин. Типове значення — 3 дні.

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isOneTimePay</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">вказує, чи можна оплатити одне замовлення кілька разів. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Типове значення — True.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalItems</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">наприклад:
<code>"additionalItems":</code>
<code>{ "PayerEmail" : "client@i.ua",</code>
<code>"PayerPhone" : "380930007603"</code>
<code>},</code>

* де PayerEmail — емейл клієнта для сповіщення у разі неоплаченого замовлення та автоматичної підстановки на платіжній сторінці.

* PayerPhone — номер телефону для надсилання повідомлення (SMS або Viber) про неоплачене замовлення (через 15–20 хвилин після виклику CreateOrder).</td><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URLs </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки успішної оплати для редиректу клієнта. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">failed — URL сторінки помилки для редиректу клієнта.
приклад параметрів, що передаються на url.success (без errorCode) і

<code>url.failed: ?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=Тестове+описання+</code>

<code>замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&errorCode=PAYMENT_ALFABANK_-2006&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</tr></table>

'''RESPONSE''' <syntaxhighlight lang="json">
HEADERS
-------
BODY
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": "https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b",
"error": null
}

</syntaxhighlight>

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів, у яких немає сертифікатів '''PCI DSS''' для обробки карткових даних. Або якщо у партнера немає власної платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструмент '''RCard''' надається лише користувачам, які авторизовані в системі EasyPay.
Можливі значення '''instrumentType''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType:'''
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
</td>
</tr></table>

Холдування платежу можна здійснити, оплативши замовлення на сторінці оплати (перейти за '''forwardUrl'''), або вказавши в запиті '''createOrder''' інструмент оплати у '''userPaymentInstrument''' (див. [[MerchantAPI#Створення замовлення|Створення замовлення]]).

Клієнту відобразиться сторінка успішного платежу EasyPay, або сторінка, вказана в “urls”:{}.

Після '''спроби холдування платежу''' партнеру буде відправлено '''сповіщення''', згідно з варіантом, вказаним в налаштуваннях сервісу [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]].

Статус платежу необхідно перевірити методом '''[[MerchantAPI#Перевірка статусу платежу|orderState]]'''

Після успішного холдування необхідно викликати або '''[[MerchantAPI#Розхолдування платежу|unHoldOrder]]''' , або '''[[MerchantAPI#Скасування платежу|orderCancel]]'''

Якщо протягом '''повних 10 днів''' після холдування жоден з цих методів не буде викликаний, на '''11-й день близько 05:00''' платіж може бути '''відхилений емітентом''', і кошти стануть доступні клієнту.

У транзакцію додається коментар: ''Автоматично відхилено через 10 днів. (SYSTEM ACCOUNT [dateTime])''

Сповіщення партнеру при цьому '''не надсилається'''.

==== Розхолдування платежу ====
Якщо цей метод не буде викликано протягом 10 днів, кошти повертаються клієнту, а платіж у системі відхиляється.

Перед викликом цього методу необхідно здійснити '''[[MerchantAPI#Створення замовлення для холдованих платежів|холдування транзакції]]'''

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/unHoldOrder</span></p>

'''REQUEST''' '''HEADERS''' <syntaxhighlight lang="http">
'PartnerKey: easypay-test'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='
</syntaxhighlight>

'''REQUEST BODY'''<syntaxhighlight lang="json">
{
"transactionId":955537573,
"orderId":"hold_4",
"serviceKey":"MERCHANT-TEST",
"amount": 1.2
}
</syntaxhighlight>
'''<br />RESPONSE''' <syntaxhighlight lang="json">
{
"paymentState": "accepted",
"error": null
}
</syntaxhighlight>'''Опис параметрів запиту''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний номер платежу в системі EasyPay</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор замовлення в системі партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов’язковий параметр, торгова сума, яку слід списати з картки.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Різниця повернеться клієнту на картку протягом '''1–2 днів''', залежно від регламенту банку

</td>
</tr></table>
'''<br>Опис параметрів відповіді'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі '''paymentState:'''
• '''accepted -''' платіж успішний (кінцевий статус)

• '''pending -''' платіж в обробці (некінцевий статус)

• '''declined -''' платіж відхилений (кінцевий статус)

• '''none -''' платіж не знайдено
</td>
</tr></table>

Для платежів з 2DS переадресація на сторінку банку-емітента не відбувається, і користувач відразу отримує статус платежу.

Після '''спроби розхолдування платежу''' партнеру буде надіслано '''сповіщення''' згідно з варіантом, вказаним в налаштуваннях сервісу [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]

Статус платежу необхідно перевіряти методом '''[[MerchantAPI#Перевірка статусу платежу|orderState]]'''

==== Параметри BrowseInfo при 3DS оплаті ====
У зв'язку з переходом банків - екваєрів на модель роботи 3D Secure 2.x, при створенні замовлення з одночасною передачею інструменту оплати в запиті (карта, токен карти, токен Apple / Google Pay), необхідно передавати додаткові параметри пристрою (браузера) клієнта в заголовках і в тілі запиту createOrder, у прикладі вони виділені:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>'''HEADERS'''
"appId: b15c4b64-8964-4c80-852e-df59a0e0d9b6",<br>
"pageId: 607514b8-1da5-490a-bdf3-0c6883131625",<br>
"partnerKey: easypay-test",<br>
"sign: XJ3roGhTLwAZXigBp/iVRdsXlZYdTSen3xSM+29GaRg=",<br>
"Content-Type:application/json",<br>
<span style="color: green;">"AcceptHeader:*/*",</span><br>
<span style="color: green;">"User-Agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"</span><br>
'''BODY'''
<div style="font-family: monospace; white-space: pre-line;">

"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_3ds2x",
"additionalItems":{
"Merchant.UrlNotify":"http://url.noti.fy"
},
"description":"Easy test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"Card",
"pan":"4444444444444444",
"expire":"0599",
"cvv":"123"
},
<span style="color: green;">
"browserInfo":{
"colorDepth":"24",
"screenHeight":"824",
"screenWidth":"1536",
"language":"uk-UA",
"javaEnabled":"false",
"javascriptEnabled": "true",
"timeZone":"-180"
}
</span>

</div>

<br>
'''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AcceptHeader:*/*</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте без змін</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>User-Agent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте клієнтський User-Agent </td></tr></table>

'''Приклад, як збирати дані на JS:'''<syntaxhighlight lang="markdown" line="1">
getBrowserInfo() {
let browserInfoModel = {};
browserInfoModel.colorDepth = window.screen.colorDepth.toString();
browserInfoModel.screenHeight = window.screen.height.toString();
browserInfoModel.screenWidth = window.screen.width.toString();
browserInfoModel.language = window.navigator.language;
browserInfoModel.javaEnabled = window.navigator.javaEnabled();
browserInfoModel.timeZone = (new Date()).getTimezoneOffset().toString();
return browserInfoModel;
}

</syntaxhighlight>Якщо все передано правильно, то отримайте відповідь як нижче у прикладі '''"Якщо передано userPaymentInstrument (для випадку з 3DSecure)",''' або помилку оплати з картки, наприклад, "Недостатньо коштів".

У випадку, якщо додаткові параметри передані неправильно, отримайте помилку платіжного сервісу, наприклад:<syntaxhighlight lang="markdown">
"errorCode":"PAYMENT_PUMB_SERVICE_FAILURE",
"errorMessage":"Технічна помилка екваєра. Зверніться до служби підтримки EasyPay, або спробуйте пізніше"

</syntaxhighlight>'''Відповідь (RESPONSE)''':<syntaxhighlight lang="json" line="1">
header:
відсутній

body:
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},

{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b,
"error": null,
}

Якщо передано userPaymentInstrument (для випадку з 3DSecure):
{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form action='https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type='hidden' name='PaReq' value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":860094566,
"retrievalReferenceNo":null,
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів які не мають сертифікатів PCI DSS для обробки карткових даних. Або якщо партнер не має платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">на сторінці оплати можемо відключати елементи інтерфейсу:
- логотип EasyPay можемо приховувати

- лічильник часу, що залишився до оплати, може бути відображений/прихований

- поле "Призначення" (можемо вимкнути, або за замовчуванням зробити відкритим/закритим)

- рядок з логотипом партнера та назвою можемо приховати

- поле введення імейл сховати / відобразити

- рядок з "Номер замовлення" приховати/показати
</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструменти '''Emoney''', vcard та '''RCard''' видаємо тільки для користувачів, які авторизовані в системі EasyPay. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType'''
* Emoney – гаманець EasyPay
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
* ApplePay – оплата через ApplePay
* GooglePay – оплата через GooglePay
* LifeMoney – мобільні гроші Лайф.
* KsMoney – мобільні гроші Київстар
* VodafoneMoney – мобільні гроші Водафон
* картки лояльності Fishka
</td>
</tr></table>

'''3DSecure / mobile payments case:'''<syntaxhighlight lang="json">
Якщо передано userPaymentInstrument (для випадку з 3DSecure):

{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form" action="https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type="hidden" name="PaReq" value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":"860094566",
"retrievalReferenceNo":"null",
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>

<br>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Confirmed''' - платіж підтверджений (кінцевий статус, якщо "status": "done")
* '''WaitConfirm''' - платіж у статусі "обробляється", необхідно додатково запросити фінальний статус платежу
* '''WaitVerify''' - від клієнта очікується підтвердження (наприклад, якщо "status": "Need3Ds" - необхідно пройти перевірку 3D Secure) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Done''' - додаткові дії не потрібні, якщо при цьому "зберіганнядержави":"затверджено", означає платіж повністю успішний. При іншому значенні paymentState- платіж не прийняв кінцевий статус, необхідно запросити статус ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]).
* '''Need3Ds''' - необхідно підтвердження 3D Secure від клієнта ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedConfirmCode''' - необхідно надіслати код перевірки зі смс методом confirmCodeVerification ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedLookup''' - необхідно надіслати код перевірки з смс '''''методом confirmCodeVerification ('''''[[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]]) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionType</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип наступної дії:

* '''"FormRedirect"''' - необхідно створити сторінку (форму) з html-коду, який передано у параметрі "actionContent" :'''"<html>...</html>",''' відкрити її клієнту, наприклад, для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl".'''
* Після проходження перевірки клієнт буде передресовано на фінальну сторінку EasyPay або на

<code>"urls": {</code>

<code>"success": "string",</code>

<code>"failed": "string"</code>

<code>}</code>

* '''"UrlRedirect"''' - переадресувати клієнта на посилання з "action" або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".'''
* '''"ConfirmCode"''' -необхідно надіслати код перевірки з смс методом '''confirmCodeVerification''' ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])

'''"None"''' - можливий при використанні інструменту гаманець '''("instrumentType": "EMoney"),''' кошти успішно списані з гаманця, партнеру надсилається повідомлення про списання. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"<html>...</html>"''' - html форма сторінки банку для введення коду 3DS. Сформувати сторінку з коду та відкрити її клієнту. Після підтвердження платежу відбудеться 302-й редирект на ваші "urls" із запиту createOrder, або на фінальну сторінку EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції в EasyPay </td></tr></table>

'''<br />2DSecure case:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Confirmed"''' та '''"status": "Done"''' - платіж пройшов успішно. При інших значеннях необхідно перевірити статус '''''платежу''''' '''('''[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]''')''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Done" -'''платіж завершено, додаткові дії не потрібні. При '''"paymentState":'''

* '''"Confirmed"''' - означає, що транзакція на стороні EasyPay прийнята (http - оповіщення успішно доставлено партнеру) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції до EasyPay </td></tr></table>

<br>

==== Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки ====
----У випадку "<code>actionType</code>": "<code>ConfirmCode</code>", клієнту прийде код підтвердження, який потрібно передати до EasyPay
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/confirmCodeVerification</span>
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"code": "string"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{ }
</syntaxhighlight>Якщо "status":"Need3Ds", то клієнту потрібно пройти 3DS перевірку в залежності від значення '''"actionType".'''
<br>
'''Опис параметрів:''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>FormRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно СТВОРИТИ сторінку (форму) з html-коду, який передано у параметрі </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">"<html>...</html>", відкрити її клієнту для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl"''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>UrlRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно переадресувати клієнта на посилання з '''"action"''' або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".''' Відобразиться форма банку емітента картки для перевірки 3D Secure. Після введення коду клієнта переадресує на сторінку успіху чи помилки. Адреси сторінок передаються на етапі створення замовлення.

<code>"urls": {</code>

<code> "success": "string",</code>

<code> "failed": "string"</code>

<code>}</code> </td></tr></table>

<br>

==== Перевірка статусу платежу ====
----

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/orderState</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers:
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20240524-0015",
"transactionId":"1413668587"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers:
відсутній

body:
"merchantKey":"easypay-test",
"transactionId":1413668587,
"orderId":"test_20240524-0015",
"amount":3.000000,
"paymentState":"declined",
"refundTransactionId":1413673292,
"":
"paymentsList":[

],
"refunds":[
{
"refundTransactionId":1413669380,
"paymentState":"accepted",
"refundAmount":1.10,
"dateAccepted":"2024-05-24T16:14:45+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:14:39+03:00"
},
{
"refundTransactionId":1413673292,
"paymentState":"accepted",
"refundAmount":1.90,
"dateAccepted":"2024-05-24T16:19:40+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:19:33+03:00"
}
],
"error":null
}

</syntaxhighlight>
'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;"></th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Фінальний'''
'''статус?'''</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Значення/ подальші дії'''</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accepted</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"> '''так'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж прийнято</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>declined</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">так</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж відхилений
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pending</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ні</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж знаходиться в обробці, необхідно повторити запит статусу пізніше
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>none</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">- </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">статус платежу не визначено, необхідно повторити запит статусу до отримання кінцевого статусу</td>
</tr></table>

'''Нетипові відповіді запит статусу:'''

* Якщо платіж не знайдено, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"error":{
"errorCode":"MERCHANT_ORDERID_NOT_FOUND",
"title":null,
"description":null,
"errorMessage":"MERCHANT_ORDERID_NOT_FOUND",
"fieldErrors":[ ]
}

</syntaxhighlight>

* Якщо платіж (сторінка, замовлення) не були відкриті клієнтом або не було спроби оплати, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId2",
"amount": 0,
"paymentState": "pending",
"refundTransactionId": null,
"paymentsList": [],
"error": null
}

</syntaxhighlight>

* Якщо отримано помилку на замовлення на етапі визначення реквізитів:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId",
"amount": 0,
"paymentState": "declined",
"refundTransactionId": null,
"paymentsList": [],
"error": {
"errorCode": "PROVIDER_ACCOUNT_INVALID", (ерор код може (має) відрізнятися від того, що в прикладі)
"title": "Помилка системи",
"description": "Акаунт не знайдено",
"errorMessage": "string"
}
}

</syntaxhighlight>

При виконанні запиту статусу на замовлення, у яких є спліт (платіжна опція) - повертається наступна модель:

'''Request:'''<syntaxhighlight lang="json" line="1">
headers:

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"easypay-test",
"orderId":"full_split_11",
"transactionId":""
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey": "easypay-test",
"transactionId": 991379504,
"orderId": "full_split_11",
"amount": 3.150000,
"paymentState": "accepted",
"refundTransactionId": null,
"paymentsList": [
{
"merchantKey": "easypay-test",
"transactionId": 991379509,
"orderId": "full_split_11",
"amount": 1.030000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379508,
"orderId": "full_split_11",
"amount": 0.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379507,
"orderId": "full_split_11",
"amount": 1.020000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379506,
"orderId": "full_split_11ID",
"amount": 1.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
}
],
"error": null
}

</syntaxhighlight>

'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentsList</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список платежів у структурі спліту з деталізацією. </td></tr></table>

У випадку зі сплітованими платежами, в основному тілі відповіді '''OrderState''' - параметру '''transactionId''' присвоюється внутрішній технічний номер (нефінансової) операції.<syntaxhighlight lang="json" line="1">
"urls": {
"success": "string",
"failed": "string"
}

</syntaxhighlight>

==== Скасування платежу ====
----Метод викликається '''лише''' для платежів у статусі '''"accepted".''' Для успішного скасування має бути достатньо суми прийнятих платежів у день скасування. Можна скасовувати платежі, які не старші 30 днів. Успішне повернення після цього терміну – не гарантується, залежить від умов банків-еквайєрів.

Повернення суми на картку відбувається в строк 0-3 робочих дні, в окремих випадках – до 30 робочих днів. Це залежить від умов банку-еквайєра, через який пройшов основний платіж, а також банку-емітента.

===== Скасування звичайного платежу =====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "MERCHANT-TEST",
"orderId": "test_20210217-121843",
"transactionId": "913141164",
"amount":"1"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
body
{
"merchantKey":"easypay-test",
"transactionId":913141164,
"refundTransactionId":913141464,
"orderId":"test_20210217-121843",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>

'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">скасована сума </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">для часткового скасування - передається із сумою, яку потрібно скасувати.
для скасування повної суми - параметр amount не передається
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">транзакція рефанду (скасування)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування). Можливі значення: </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* a'''ccepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* p'''ending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен повертати '''"'''<code>paymentState</code>'''":"'''<code>declined</code>'''",''' а запит статусу транзакції скасування - '''"'''<code>paymentState</code>'''": "'''<code>accepted</code>'''"'''

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація ([[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]), на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром "<code>action</code>": "<code>refund</code>'''"''' та сумою (amount), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Скасування платежу (замовлення зі Splitting параметрами) =====
----Скасування платежу (Замовлення) можна робити:

* на всю суму платежу (замовлення)
* на суму одного спліту (Часткова скасування платежу (замовлення))
* на суму меншу від суми спліту (Часткова скасування спліту)
<br>

===== Скасування повної суми платежу (замовлення зі Splitting параметрами) =====
----
* Для скасування повної суми Splitting транзакції необхідно виконати запит статусу транзакції згідно з розділом "[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]'''"''' використовуючи основний <code>OrderID</code>
* Отриманий у відповіді кореневий <code>transactionID</code> використовувати у запиті [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]]
* У відповідь на запит [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]] буде отримано відповідь зі статусом скасування, а також буде отримано коллбек по кожній транзакції, яка входила до Splitting транзакції.
* Коллбек на загальну суму Splitting транзакції не надходить.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379504,
}
</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId": 991379504,
"refundTransactionId":913141464,
"orderId":"full_split_11",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''Pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</tr>

</table>Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати <code>"paymentState"''':"'''declined'''"'''</code> як для основної так і для окремих транзакцій, а запит статусу транзакції скасування - <code>"paymentState":"accepted".</code>

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром <code>"action": "refund"</code> та сумою (<code>amount</code>), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Часткове скасування (повернення) платежу (замовлення зі Splitting параметрами) =====
Для часткового скасування платежу необхідно виконати запит <code>cancelCurder</code> використовуючи <code>transactionID</code> який був отриманий в коллбеку (параметр payment_id), а також вказавши суму скасування (вона має бути меншою або дорівнює сумі транзакції, що скасовується).

* У відповідь на запит <code>cancelOrder</code> буде отримано відповідь зі статусом скасування, а також буде отримано коллбек про успішне скасування цієї транзакції.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379509,
"amount":1.00
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr></table>

'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId":"991379509",
"refundTransactionId":"913141464",
"orderId":"full_split_11",
"amount":"1.000000",
"paymentState":"accepted",
"error":"null"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування)
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>

</tr></table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати "paymentState":"declined", а запит статусу транзакції скасування - "paymentState":"accepted"
При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде одноразово надіслано POST - запит із параметром '''"action": "refund"''' та сумою '''(amount)''', яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

=== Повідомлення про платіж ===
----
# Партнер обов'язково вибирає 1 або кілька способів сповіщення та повідомляє його в EasyPay. Партнер зазначає платіж успішним на своїй стороні лише після отримання цього повідомлення
# Ми надсилаємо HTTP - колек з IP 93.183.196.26 методом POST з інформацією про платіж.
# Запит надсилає EasyPay партнеру після того, як транзакція набула фінального статусу (Accepted, Declined).
# URL для повідомлень '''(UrlNotify)''' партнер направляє у запиті '''createOrder''' у параметрі:
<br>
<syntaxhighlight lang="json" line="1">
"order":{
"additionalItems":{
"Merchant.UrlNotify":"https://notify.url"
}
}
</syntaxhighlight>
<br>
"Merchant.UrlNotify" Параметр не може бути порожнім і має відповідати формату URL.
<br>

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Якщо у відповіді не отримано <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">HTTP StatusCode 200</span>, запит нотифікації буде надіслано повторно протягом <strong>1-10 хвилин</strong>.
Повторення може продовжуватися визначену кількість разів (за замовчуванням – <strong>50 разів</strong>), поки не буде отримано статусу <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #198754;">"200 ОК"</span>.
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Sign": "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
body
{
"OperationType": "Payment",
"PartnerKey": "groshi-com",
"ServiceKey": "GROSHI-COM-GOOGLEPAY",
"TransactionStatus": "Accepted",
"MerchantOrderId": "3127194_28_450866",
"DateTime": "2023-12-09T14:00:48",
"Amount": 2059.08,
"Commission": 28.83,
"TransactionId": 1336448544,
"AdditionalItems": {
"Merchant.Inn": "3178404189",
"Merchant.Details": ";0;0;;4;",
"Merchant.UrlNotify": "https://testpartner.ua/callback",
"Merchant.ClientFullName": "Іванов Дмитро"
"Acquirer.MerchantId":"12345678"
"Acquirer.TerminalId":"E1234567"
"Card.BrandType":"Visa"
"AuthCode":"012345"
}
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>OperationType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)

'''refund -''' про успішне скасування платежу (відправляється разово)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionStatus</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>MerchantOrderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.MerchantId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торговц'''я''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.TerminalId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор платіжного пристрою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Card.BrandType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">найменування платіжної системи, платіжний інструмент якої використовується </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AuthCode</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Код авторизації </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>DateTime</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">якщо партнер не відповість статусом 200 на запит з action:payment, то в наступному запиті час буде новим</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ID транзакції на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>

</table>
<br>Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.
Для правильного обчислення підпису, тіло з нотифай потрібно брати як є, без перетворень та форматувань.
У випадку, якщо підпис notify не перевірено, всі фінансові ризики перекладаються на партнера.

==== Отримання інформації про рекурентний платіж ====
----
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/info</span></p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="
queryParams
"serviceKey": "string"
"orderId": "string"
"reccurentId": "0"
"dateFrom": 2025-03-10
"dateTo": 2025-03-17
"isEnabled": true|false
"pageNumber": 1
"countPerPage": 3

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"merchantReccurentPaymentDetails":[
{
"recurrentId":14433854,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601+url",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:38:02+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:42+02:00",
"properties":{
"failedCount":"1",
"urlNotify":"http://109.251.205.8:9987/merch/notifysigncheckexample.php"
}
},
{
"recurrentId":14433852,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:37:25+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:03+02:00",
"properties":{
"failedCount":"1"
}
}
],
"totalCount":2,
"totalFilteredCount":2,
"pageFilteredCount":2,
"currentPageNumber":1,
"numberOfPages":1,
"error":null
}

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>reccurentId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекурента </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateFrom</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента з.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateTo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента по.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isEnabled</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити лише активні / або неактивні рекуренти </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pageNumber</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити сторінку номер.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>countPerPage</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">кількість записів на сторінці </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>templateId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекуренту (reccurentId) </td></tr></table><br>

==== Виклик рекурентного платежу ====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/payment</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"reccurentId": 0,
"amount": 0
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"reccurentId": 0,
"transactionId": 0,
"transactionStatus": "None",
"error": {
"errorCode": "string",
"title": "string",
"description": "string",
"errorMessage": "string",
"fieldErrors": [
{
"fieldName": "string",
"errorCode": "string",
"errorMessage": "string"
}
]
}
}

</syntaxhighlight>Також буде надіслано нотифікацію у разі успішного платежу. Створення рекурентного платежу на операцію, у структурі якої є спліт – не підтримується.

<br>

=== Видалення рекурентного платежу ===
----
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/reccurent/delete/{id}</span>
</p>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
відсутній
</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

-

body

-
</syntaxhighlight>

== Робота з токенізованими картами ==
----

=== Токенізація карти ===
Метод призначений для токенізації (збереження) картки для ідентифікатора користувача під конкретним торговцем.

===== Токенізація з передачею даних картки у запиті (заборонено без PCI:DSS сертифікації мерчанта) =====
Перед викликом цього методу. Потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]

'''-''' [[MerchantAPI#Створення сесії|CreatePage]] <br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCard</span></p>
<br>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "380501002030ws",
"pan": "4874120123567889",
"expire": "1222",
"cvv": "012",
"vсode": "123654"
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"activateCodeType": "code|amount",
"cardGuid: "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan”: "48741201****1234",
"expire”: "1222"
"error": "null"
}

</syntaxhighlight>Токенізація картки - процес двоетапний.

На першому етапі у запиті йдуть параметри картки та номер телефону користувача. У відповіді, залежно від '''activateCodeType''', може бути активація за кодом підтвердження з виписки або SMS або за сумою списання.

З другого краю етапі до всіх параметрів додається ще vcode – код верифікації. При успішному відповіді прийдуть параметри токенізованої карти чи помилка.

===== Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна) =====
Перед викликом цього методу, потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]];

'''-''' [[MerchantAPI#Створення сесії|CreatePage]];
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">api/merchant/tokenCard/create</span></p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type: application/json"
"PartnerKey: partnerName"
"locale: ua"
"AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "8888",
"expire": "2020-12-06T12:54:32.043Z",
"urls": {
"success": "https://test.ua",
"failed": "https://test1.ua",
"notify": "https://test2.ua",
"back": "https://test3.ua"
},
"description": "testtts",
"checkExistingToken": false
"operationType":"SingleToken | createToken | ExistingToken"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"forwardUrl": "https://easypay.ua/ua/tokencard/cae16afc-be56-4a39-8ce1-5de4f4142e76",
"error": null
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>description</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |опис, який відобразиться на сторінці токенізації
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час життя сторінки токенізації (по дефолту - 15 хвилин)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережеться картка (будь-які літери, цифри, GUID.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |'''Не повинен містити символ ‘+’'''
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>urls</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |містить інформацію про:

* сторінці успіху партнера (success) для переадресації клієнта після успішної токенізації, потрібно обов'язково передавати
* сторінці помилки ('''failed''') для переадресації клієнта у разі помилки
* адреса для відправки callback-запиту з деталями при успішній токенізації ('''notify''')
* адресу для повернення назад зі сторінки токенізації ('''back''')
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>forwardUrl</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |сторінка для додавання картки (токенізації)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>checkExistingToken</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |перевірка наявності токена по карті, що вводиться у даного партнера.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |Параметр може набувати значення:

* true - проводити валідацію на наявність раніше створеного токена по цій карті;
* false - валідація відсутня;
* null - валідація відсутня;

Якщо параметру '''checkExistingToken''' присвоєно значення true, слід очікувати наступних сценаріїв поведінки:

* “checkExistingToken” : '''true,''' і в системі '''немає раніше створених токенів''' під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''true,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) - користувачу відкривається сторінка успіху, додаткова верифікація (надсилання коду верифікації не відбувається), токен не створюється, а в callback вказується '''масив раніше створених токенів''';
* “checkExistingToken” : '''false / null,''' і в системі немає раніше створених токенів під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''false / null,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) – формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену.
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>operationType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |''(Новий параметр) задає тип операції токенізації''
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
* '''SingleToken''' - для однієї карти завжди повертається той самий токен. Логіка така:

* перевіряємо чи є токен для цієї картки під '''partnerKey''' із запиту

* якщо є 1 або більше токенів - беремо останній з них, створюємо новий запис з цим токеном для переданого ідентифікатора клієнта '''(phone)''', відправляємо цей токен в callback у кореневому параметрі '''cardGuid'''
* якщо токенів немає - створюємо новий для цього '''phone''' і відправляємо його в callback в кореневому параметрі '''cardGuid''' (один і той же '''cardGuid''' може бути прив'язаний до різних phone)

* '''createToken''' - значення за замовчуванням, звичайне створення токена (можна не передавати)
* '''ExistingToken''' - поведінка аналогічна '''checkExistingToken:true'''
|}
'''На сторінці токенізації можемо керувати інтерфейсом (на стороні EasyPay):'''
* відображати/сховати логотип EasyPay
* відображати/приховати логотип та назву партнера
* відображати/приховати опис з деталями токенізації
* відображати опис у згорнутому/розгорнутому вигляді

'''Приклад callback - запит з IP адреси 93.183.196.26 після успішної токенізації:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers

Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"partnerName",
"phone":"test989",
"cardGuid":"2ad57b2e-eb5b-4a99-ad05-788cf589b8af",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-02-24T17:32:07.447",
"codeType":"Mpi3Ds"
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережено картку
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>cardGuid</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |токен збереженої карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>pan</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |маскований номер картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |термін дії карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>datePost</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час додавання картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>codeType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ознака типу верифікації картки. Mpi3Ds – з використанням 3ds.
|}

'''Приклад callback - запит з IP адреси 93.183.196.26 з параметром ExistingToken:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers
Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":null,
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:41:53.152",
"codeType":"Code",
"existingTokens":[
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"bac4f855-xxxx-xxxx-bece-14cdf23c6c52",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:28:23.840",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"6338e8b4-xxxx-xxxx-a3e5-f46ad0cb0efa",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:34:25.733",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"18e3c35e-xxxx-xxxx-ba59-9506154394c0",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:39:42.010",
"codeType":"Mpi3Ds"
}
]
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>existingTokens</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |масив з даними раніше створених токенів по цій карті під даного партнера '''(partnerKey)'''
|}

===== Отримання списку токенізованих карт =====
----Метод призначений для отримання списку токенізованих карток за номером телефону (ознакою) користувача.
<br>
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCards/get</span></p>
'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams
phone = string
cardGuid= Guid
</syntaxhighlight>'''Response''' <syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"tokenCards": [
{
"cardGuid": "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan": "48741234****1234",
"expire”: "1222"
}],
"error": "null"
}

</syntaxhighlight>Якщо передати тільки ідентифікатор клієнта (параметр phone) - у відповіді будуть всі карти поточного клієнта. Якщо передати <code>phone</code> та <code>cardGuid</code> - у відповіді буде одна карта поточного клієнта.

<br>

===== Видалення токенізованих карт =====
----Метод призначений для видалення токенізованих карток за номером телефону. Якщо у клієнта під одним номером кілька карток, всі картки будуть видалені.
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone</span>

<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone?CardGuid=Guid</span></p>'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams

cardGuid= Guid

</syntaxhighlight>'''Response'''<syntaxhighlight lang="markdown" line="1">
headers
відсутній

body
відсутній
</syntaxhighlight>

===== Видача кредиту (переказ на картку користувача) =====
Метод призначений для переказу на картку користувача суми кредиту.
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateAPP]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
'''Request:'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order":{
"serviceKey":"CARD-FILL",
"description":"test top up card",
"amount":1.12, (decimal)
"orderId":"test",
"fields":[
{
"fieldName":"Pan",
"fieldValue":"4102321200001111",
"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"
},
{
"fieldName":"Phone",
"fieldValue":"38093520000"
}
],
"additionalItems": {
"Merchant.ClientFullName": "Иванов Петр Сергеевич",
"Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32",
"Merchant.Inn": "3334445823"
}
},
"userPaymentInstrument":{
"instrumentType":"Vcash"
}
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"redirectUrl": null,
"action": null,
"paymentState": "Confirmed",
"status": "Done",
"actionType": "UrlRedirect",
"transactionId": "766934634",
"retrievalReferenceNo": "null",
"responseItems": "null",
"error": "null"
}

</syntaxhighlight>'''Опис параметрів'''
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |paymentState
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |
* '''Confirmed''' оплата пройшла успішно
* '''WaitConfirm ''' очікується підтвердження платежу
* '''Rejected''' і '''Refunded''' платіж відхинело
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>transactionId</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" | ідентифікатор платежу в системі Easypay
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |У об'єкти поля передається інформація для поповнення карти. Номер картки можна вказувати:

* для випадку з PCI DSS сертифікацією: у відкритому вигляді

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldValue":"4102321200001111",</code>'''

* для випадку без PCI DSS сертифікації: у вигляді токена (як отримати токен картки - див. [[MerchantAPI#Токенізація карти|Токенізація карти]]):

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"</code>'''

Також потрібно вказати:

- номер телефону клієнта:

'''<code>"fieldName":"Phone",</code>'''

'''<code>"fieldValue":"38093520000"</code>'''

- ПІБ та адреса клієнта АБО ПІБ та ІПН клієнта:

'''<code>"additionalItems": {</code>'''

'''<code> "Merchant.ClientFullName": "Іванов Петро Сергійович"</code>'''

'''<code> "Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32"</code>'''

'''<code> "Merchant.Inn": "3334445862"</code>'''

'''<code> }</code>'''
|}

'''Статус видачі кредиту:'''

* Якщо у відповіді отримано кінцевий статус <code>(paymentState = Confirmed / Rejected / Refunded)</code> - необхідно присвоїти його платежу.
* Якщо кінцевий статус у відповіді не отримано <code>(paymentState = WaitConfirm)</code>, '''у тому числі при серверних, мережевих та будь-яких інших відповідях та помилках''' - необхідно запросити статус платежу методом '''orderState''' ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]) до отримання кінцевого статусу.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Важливо врахувати, що нотифікація про оплату не надсилається (якщо партнер/мерчант не повідомив про необхідність такого налаштування).<br><br>
Скасування транзакції не передбачено.
</p>
<br>

Response (Приклади відповідей при помилках: status code = 400)<syntaxhighlight lang="json" line="1">
{
"error": {
"errorCode": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"title": null,
"description": null,
"errorMessage": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"fieldErrors": [
{
"fieldName": "Order.Fields[0]",
"errorCode": "SERVICE_FIELDS_VALIDATION_EXCEPTION",
"errorMessage": "Вказана умова не була виконана для значення поля."
}
]
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pv2",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Обслуговуються тільки карти емітовані українськими банками",
"fieldErrors": []
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pa8",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Необхідно уточнити реквізити картки одержувача у банку емітента",
"fieldErrors": []
}
}

</syntaxhighlight>

===== Нотифікації (колбеки) щодо операцій поповнення карток =====
Дані колбеки є опціональним (додатковим) способом отримання інформації від EasyPay про результат виконання запиту на поповнення картки.

Для активації отримання колбеків мерчант (партнер) повинен повідомити EasyPay про таку необхідність, після чого EasyPay включає цю опцію.

Спосіб відправки колбека - '''HTTP - з IP 93.183.196.26''' буде надіслано '''POST''' запит з інформацією про платіж на вказаний <code>urlNotify</code>.

<code>urlNotify</code> прописується на стороні EasyPay і використовується за замовчуванням, якщо партнер не передав його у своєму запиті.

URL для повідомлень ('''UrlNotify''') повідомляє партнер (мерчант).

Партнер може передавати '''UrlNotify''' у запиті '''createOrder''' у параметрі:

<code>"order":{</code>

<code>"additionalItems":{</code>

<code>"Merchant.UrlNotify":"<nowiki>https://notify.url</nowiki>"</code>

<code>}</code>

<code>}</code>

"Merchant.UrlNotify" параметр не може бути порожнім і повинен відповідати формату URL.

Якщо у відповідь не отримано HTTP StatusCode 200 - запит нотифі буде надіслано повторно, доки не отримано статусу “200 ОК”.

Коли нотифікацію (колбек) успішно доставлено (отримано статус 200 ОК), повторне відправлення колбеків припиняється.

Відправлення колбеків можливе за двома сценаріями:

1) лише за успішними операціями (транзакціями);

2) за операціями (транзакціями) у фінальному статусі (успішні та відхилені).

Надання фінального статусу операції (транзакції) асинхронно з процесом відправки колбека (фінансова транзакція набуває фінального статусу незалежно від статусу прийняття колбека партнером).

'''Request''' <syntaxhighlight lang="markdown" line="1">
headers

"Sign: "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
"User-Agent": "EasyPay.MerchantNotifyService"

body

{
"action": "payment",
"merchant_id": 5347,
"order_id": "5",
"date": "2019-06-19T15:38:10.7802613+03:00",
"details": {
"amount": 1.00,
"desc": "Wooden tables x 10",
"payment_id": 724502946,
"recurrent_id": null
},
"additionalitems": {
"BankName": "CB PRIVATBANK",
"Card.Pan": "414962******1234",
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>action</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>merchant_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер сервісу партнера на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>order_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>date</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>details</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">детальна інформація про платіжну операцію (транзакцію) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''payment_id -''' ID детальна інформація про платіжну операцію (транзакцію):
* '''amount''' - сума фінансової операції;
* '''desc''' - опис замовлення, отриманий під час запиту CreateOrder;
* '''recurrent_id''' - ознака реккурентного платежу (завжди за замовчуванням на операціях поповнення картки – null);</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalitems</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">блок додаткових параметрів, до якого можуть включатися додаткові айтеми, отримані в запиті CreateOrder:
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''BankName''' - назва банку власника картки;
* '''Card.Pan -''' номер картки у маскованому вигляді.</td>
</tr></table>

Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> У випадку, якщо підпис <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">notify</span> не перевірено, всі фінансові ризики перекладаються на партнера.
</p>

== Інтеграція з ApplePay ==
----Вимоги

# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитись з умовами надання послуг Apple Pay.
# Необхідно укласти договір із Easypay.ua.
<br>Apple Pay надає простий та безпечний спосіб проведення платежів у додатках iOS, watchOS та сайтах Safari. Використовуючи Face ID, Touch ID або двічі клацнувши Apple Watch, користувачі можуть швидко та безпечно передавати свої платіжні дані для оплати.

=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка Apple Pay буде відображена на сторінці оплати EasyPay

=== Оплата ApplePay з додатку ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], в який потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимоги до брендування].

<br>
==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.

''Примітка: * - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).''

# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay

==== Технічна інтеграція з ApplePay ====

# Щоб інтегрувати Apple Pay у мобільний додаток, дотримуйтесь інструкцій за посиланням: https://developer.apple.com/documentation/passkit/apple_pay.

'''Приклад відповіді ApplePay''' <syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>2. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token в Easypay</code> ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Приклад запиту '''createOrder''':<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{ApplePayMerchantId}"
}
}

</syntaxhighlight>

=== Оплата із сайту ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], до якого потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимог до брендування].

==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).</em>
</p>
<br>
# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay
# Зареєструйте та підтвердіть свій домен:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі "Merchant Domains" натисніть "Add Domain".
## Введіть ім'я домену та натисніть "Continue" *.
## Завантажте файл apple-developer-merchantid-domain-association.txt.
## Збережіть файл на сервері від Apple.
## Натисніть Verify.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - домен повинен підтримувати HTTPS.</em>
</p>
<br>
# Створіть Apple Pay Merchant Identity Certificate:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Merchant Identity Certificate натисніть Create Certificate.
## Виконайте дії, описані на сайті Apple, а потім натисніть «Continue».
## Скопіюйте згенерований CSR-файл, вибравши Choose File, а потім Continue.
## Завантажте згенерований сертифікат (merchant_id.cer) і відкрийте його у програмі Keychain Access на комп'ютері Mac.
## У Keychain Access виберіть сертифікат, що імпортується, та експортувати його у формат .p12 (Personal Information Exchange).
## Виконайте команду: openssl pkcs12 -in merchant_id.p12 -out merchant_id.pem -nodes -clcerts
## Скопіюйте створений сертифікат у форматі PEM на сервер. Це буде потрібно для створення [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/requesting_an_apple_pay_payment_session Apple Pay Payment Session] в процесі [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/providing_merchant_validation перевірки магазину].

<br>
==== Технічна інтеграція з ApplePay ====
Для створення сертифікату (-ів) від Партнера потрібні:

# Country Name (2 letter code) [AU]: ?
# State or Province Name (full name) [Some-State]: ?
# Locality Name (eg, city) []: ?
# Organization Name (eg, company) [Internet Widgits Pty Ltd]: ?
# Organizational Unit Name (eg, section) []: ?
# Common Name (e.g. server FQDN or YOUR name) []:?
# Email Address []: ?

Повідомте, чи буде оплата тільки в додатку, або також і на WEB.

Щоб інтегрувати Apple Pay на сайт, дотримуйтесь інструкцій за [https://developer.apple.com/documentation/apple_pay_on_the_web. посиланням]

# Перевірте можливість оплати з Apple Pay. Виконується перевірка, підтримує або браузер оплату з Apple Pay, а також є у Wallet картку, якою можна оплачувати.
<syntaxhighlight lang="markdown" line="1">
if (window.ApplePaySession) {
var promise = ApplePaySession.canMakePaymentsWithActiveCard({YOUR_MERCHANT_ID});
promise.then(function(canMakePayments) {
if (canMakePayments)
});
} else {
}

</syntaxhighlight>
2. Сформуйте структуру платежу для сесії<syntaxhighlight lang="markdown">
document.getElementById("apple-pay-button").onclick = function(event) {
var paymentRequest = {
currencyCode: 'UAH',
countryCode: 'UA',
total: {
label: {PRODUCT_NAME},
amount: {PAYMENT_AMOUNT}
},
merchantCapabilities: ['supports3DS'],
supportedNetworks: ['masterCard', 'visa']
};

var session = new ApplePaySession(3, paymentRequest)

</syntaxhighlight>
3. Відкрити платіжну сесію з Apple, отримати від них paymentData:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/applePay/validateSession</span><syntaxhighlight lang="json" line="1">
headers

--header "Content-Type: application/json"
--header "AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209"
--header "PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760"
--header "PartnerKey: easypay-test"
--header "locale: ua"

body
{
"url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
"merchantIdentifier": "string", /ідентифікатор мерчанту в Apple/
"displayName": "test", /ідентифікатор магазина/послуги/товару (латиниці) ; буде відображатися в toolBar/
"initiative": "web", /Канал оплати/
"initiativeContext": "string" /Доменне ім’я, Доменное имя, пов'язане із сертифікатом Apple Identity/
}

</syntaxhighlight><blockquote>*response з цього методу передається в сесію Apple, після чого при успішній авторизації платежу, повернеться до необхідний для завершення платежу.</blockquote>4. Приклад відповіді ApplePay<syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>5. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token</code> в Easypay ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Перед цим потрібно викликати метод EasyPayApi CreateApp.

'''Приклад запиту createOrder:'''<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{YOUR_MERCHANT_ID}"
}
}

</syntaxhighlight>

== Інтеграція з GooglePay ==
----'''Вимоги'''
# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитися з [https://payments.developers.google.com/terms/sellertos умовами надання] послуг GooglePay.
# Необхідно укласти договір із Easypay.ua.

Google Pay™ - це миттєвий спосіб оплати від Google, який дозволяє просто та швидко сплатити карткою, без необхідності вводити дані для кожного платежу. Ці картки надійно зберігаються в Google. Даний метод доступний для оплати в мобільних програмах на будь-яких пристроях Android і при здійсненні платежу в браузері Chrome.

• '''Документація'''

# [https://developers.google.com/pay/api/android Для додатків]
# [https://developers.google.com/pay/api/web Для веб-сайтів]

• '''Вимоги щодо брендування'''

# [https://developers.google.com/pay/api/android/guides/brand-guidelines Для додатків]
# [https://developers.google.com/pay/api/web/guides/brand-guidelines Для веб-сайтів]

<br>
=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка GooglePay відображається на сторінці оплати EasyPay.

=== Отримання токена GooglePay для оплати ===
----<nowiki>*</nowiki>Використовуйте бойове середовище GooglePay для отримання PaymentData

Для отримання PaymentData. Як параметри скрипта вкажіть:

# Доступні методи платежу: var allowedPaymentMethods = ['CARD', 'TOKENIZED_CARD'];
# Тип токенізації- PAYMENT_GATEWAY: tokenizationType: 'PAYMENT_GATEWAY';
# Параметр gateway: easypay;
# Параметр gatewayMerchantId: Ваш бойовий merchantAccount от Google, який повідомляє в EasyPay.

Якщо з вашого боку інтеграція виконана правильно, Ви на своєму сайті/додатку отримаєте кнопку

Після натискання кнопки на пристрої з підключеним Google Pay з'явиться спливаюче вікно або форма вибору прив'язаної картки.

'''Приклад відповіді від GooglePay Api'''<syntaxhighlight lang="json">
{
"apiVersionMinor":0,
"apiVersion":2,
"paymentMethodData":{
"description":"Mastercard •••• 1164",
"tokenizationData":{
"type":"PAYMENT_GATEWAY",
"token":"{"signature":"MEUCeretMPEQPUMnvMOnDAgZsOLVnFnfjmo5ALe/1D6o7hdzAiEA94L1GfNWW84kbUdHHn+l6B6n18VgIA3sdkPqKL36tqk\u003d","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEem3biYxltOBuMV+Dd9g+ZhV3VEzP2vAlFXvb9tJoYGLtetxDYWTUqnXPvKGDeAnSNrkPo8hu5kLtxN0QXCYkqQ\\u003d\\u003d\",\"keyExpiration\":\"1551385212256\"}","signatures":["MEYCIQD/TWKunZJhG/u3iL2H5P3i9r0rCbpw1/+z9dr/yGytvwIhAPfV2zF5cqP/L+42W+JKv6fgQKBEc67HTtfderefdghJ"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"OidSptk8w+I3FnR1VFmiVswXaZ7ADnmMP1MQelp6GSg0/3aVpAXeLRH/fT1wN7gpxNPy7tFITeQenrJm3QG19tAPuVhcAVM26DMU6LAmZPyPXALktpnYrUj6etCjvWWM/1LkhjDBSjtkmpWRiHIyqj5aud/j8rxFEk06GhwqPWbnJwdCgNf32LJP7bSpUWvHOioaZIV1vdeV6d7iQ6EDWWAS/z9pXWkqpW//M/TVTrcKFXh4C2TI2O+qyBD9VzK3TqU6wS5VsYL69W9/4xzV5L5irpp/wzNfPHkJd8QIwcsIPuNWBtGm3v+JCaqIA3oK9Sw/5o/gZp/pnOhUdax0VjGEvmbGXs2+ufBChCkh+/BpobbpzVS9T/DZSlUO2FLANMjSaEQzh74ymtDgP4x9O64RAdySW+V7lVZMa7FVZ3PFnTfa8W89pzIgo6ocSGHQPBFnExTmSbDpUU0L12wzHkAcZSyngPAljqg\\u003d\",\"ephemeralPublicKey\":\"BBKgbSbykNy1111QYRmGJEhnCorkt+VoDYlYbAlg0a5WO2uV/M50XqOSG0uxWAvUqrZolQuEX6yZ+dvvufLEZtI\\u003d\",\"tag\":\"p9ItvOfsQVTzhTPHq6ycYjKX1TtozP/yym4QWWVRVCk\\u003d\"}"}"
},
"type":"CARD",
"info":{
"cardNetwork":"MASTERCARD",
"cardDetails":"1164",
"billingAddress":{
"phoneNumber":"+380 93 000 00 11",
"address3":"",
"sortingCode":"",
"address2":"",
"countryCode":"UA",
"address1":"ул. ",
"postalCode":"49107",
"name":"Super 1",
"locality":"Київ",
"administrativeArea":"Київська область"
}
}
},
"email":"test@easypay.ua"
}

</syntaxhighlight>

=== Передача токена для оплати ===
Надішліть дані з поля token з відповіді від '''GooglePay Api''' у поле '''userPaymentInstrument/token''' у Easypay (розділ [[MerchantAPI#Створення замовлення|Створення замовлення]])

Перед цим потрібно викликати метод '''EasyPayApi [[MerchantAPI#Реєстрація точки та створення сесії|createApp.]]'''

'''Приклад запиту'''
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span><syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210000-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"GooglePay",
"token":"{\"signature\":\"MEQCIFTFadYw15Cqfk7+YiM9pp5zEvyTI7oWVZCNFKr1cMthAiAFMv+nt0PWOEhj6LmmMNTByP9E4OhGrSoE7rDvzLDIZw\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEsrkMsOBN8N0xL8AsTVUIETODhCva5PpGFxvPm56pWmI5MG2HKKHXjsdhdvcP6N3d40x90E0rZzDrxBC2ywERXg\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1618591579000\\\"}\",\"signatures\":[\"MEUCIHX0SawuKctPUEjdFu2sDiE81aSSdf8i0KNvdg1dlsWoAiEAye8TEWpPk4sp7EjTovN7DichK6YxY1DajYN9/ArHDYI\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"vlLmhIBndM4a/GWFsvbFZrZOygjAwUao/NlvlJlhAQ3kdprI3gubAcQxAau8L74dkzGJh8w7AD2E77XOHycdwG91NUvsJ0xiXuMCXHJ9NPMhp7k49OUIJjOpJG+RqUM9/SPBgx69eDD7skhG+axZYr/m36LFjIlk5WhmumQgIrfojm02uRm0nOcZ2wbvrwQKZyL1IeTv/txqcYMuQqYWzs/FPkIEbiQ80z6dRhVszrEXcHLKcfBmNmcn/Vk90ArXCotOD52V0JS/Q+Mf9mCoe9G2bABo9R9PAYT/FrKIEOQEhzLCI7m4/vyIlCMf69d6PjigP3AOGxykbS0Kvsxqoh+HYRFCSLCd+8O2Us2wCYD09/OBqcQi78/fs2vwyg4nrWQQJ6ZGwTKHHxVRY8VGAUUnMFr18HPsN1BQNuz08M4t6Qx6X0nEZ3hseSIcUMVcBm+NyvL2T/XSWqTh2poDuQ4B+UJ59gMrsPapzouxk2iC/+vS1Bs/2sSf77Nsqr7BhE7SMgnZ/a2LF+Shx2aOKSIGflMz+MjVSzpMg2AUh43pbcsi8g\\\\u003d\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BDJpYzoN9XPVKrHIxwNes83HbR0/AOUPpQgAwi3fTzR+TIB8/VAc9CdI9guWX8Pjvii/T+WxwcByuo9pzJC7518\\\\u003d\\\",\\\"tag\\\":\\\"LFOOTwd5Crtn60KnT0J6MHuFlGE0+EYL3D7IrWrPsRA\\\\u003d\\\"}\"}",
}
}

</syntaxhighlight>

== Створення підпису ==
----Формування підпису Sign (основний варіант для POST – запитів)<syntaxhighlight lang="text">
Sign = base64(sha256(secretKey + requestBody))

</syntaxhighlight>'''Де:'''
* <code>secretKey</code> – секретний ключ.
* <code>requestBody</code> – тіло запиту у форматі JSON (ідентичне формату EasyPay).
<br>

=== Приклади коду ===
----'''C#'''

<code>Convert.ToBase64String(SHA256.Create().ComputeHash(Encoding.UTF8.GetBytes(data)))</code>

'''PHP'''

<code>base64_encode(hash('sha256', ($secretKey.$requestbody), true))</code>

<br>
== Можливі варіанти інструментів оплати ==
----

===== Оплата <span style=" display: inline-block; padding: 4px 16px; border: 2px solid #0033A0; /* Темно-синій колір рамки */ background-color: #0033A0; /* Темно-синій фон */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ ">VISA</span> <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid transparent; /* Прозора рамка для градієнту */ background: linear-gradient(to right, #FF5F00, #FFBF00); /* Градієнт від червоного до оранжевого */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">MasterCarD</span> =====
<syntaxhighlight lang="json" line="1">
"paymentInstrumentsTypes": [
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 200,
"additionalParams": {}
}
]
]
},
{
"instrumentType": "RCard",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>
===== Мобільні гроші <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #00A3E0; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #00A3E0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Київстар</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #F7E300; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #0033A0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Lifecell</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #E60012; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #E60012; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Vodafone</span> =====

<syntaxhighlight lang="json" line="1">
{
"instrumentType": "KSMoney",
"commission": 0.0,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4958975,
"instrumentType": "KSMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.0,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 1,
"additionalParams": {}
}
]
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 6000.00,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]

</syntaxhighlight>

===== Картки лояльності <span style=" display: inline-block; padding: 8px 20px; border: 2px solid #FF0000; /* Червона рамка */ background-color: #FF0000; /* Червоний фон */ color: white; /* Білий текст*/ font-family: Arial, sans-serif; /* Шрифт Arial */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Розмір шрифта */ ">Fishka</span> =====
<syntaxhighlight lang="json" line="1">
]
},
{
"instrumentType": "FishkaB2B",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},
{
"instrumentType": "FishkaB2C",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>

===== Оплата <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #000000; /* Темно-синій колір рамки */ background:FFFFFF ; /* Темно-синій фон */ color: #000000; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">ApplePay</span> <span style=" display: inline-block; padding: 8px 20px; border-style: solid; border-width: 4px; border-color: #4285F4 #EA4335 #FABB05 #34A853; /* Чітке розмежування кольорів */ background-color: #FFFFFF; /* Білий фон всередині */ color: #000000; /* Колір тексту */ font-family: Arial, sans-serif; font-weight: bold; text-transform: uppercase; font-size: 16px; border-radius: 24px; /* Закруглені краї */ ">GPAY</span> =====
<syntaxhighlight lang="json" line="1">
{
"instrumentType": "ApplePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958126,
"instrumentType": "ApplePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"instrumentType": "GooglePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958137,
"instrumentType": "GooglePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams":
{
"PublicKey": "BKdzipvJvJzcbTMm3dO0LEh1AXFr8qfSiPjwrI7vv9F6hqhDJB1M="
}
}
]
}
]

</syntaxhighlight>

=== Управління інструментами оплати ===
----Управління інструментами оплати на сторінці оплати EasyPay здійснюється при створенні замовлення. Параметр <code>allowedInstruments</code> визначає, які інструменти оплати будуть відображатися на сторінці платіжного шлюзу.
<br>
<syntaxhighlight lang="json" line="1">
"userInfo": {
"phone": "string"
},

Обов'язкові параметри:
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)
"allowedInstruments": [ "string" ]
</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>allowedInstruments</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр в якому передаються інструменти оплати, які будуть відображені на сторінці </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* RCard
* Card
* EBank
* FishkaB2C
* ApplePay
* GooglePay</td>
</tr></table>
'''<br>
Поведінка системи'''
# '''Якщо параметр''' <code>allowedInstruments</code> '''не передано або він порожній''': На сторінці оплати будуть відображені всі доступні інструменти, які підключені для партнера.
# '''Якщо з переданих інструментів немає доступних для оплати''': Повертається помилка: <code>PAYMENTINSTRUMENT_NOT_FOUND</code>
# '''Приклад помилки''': У разі, якщо у партнера активні ApplePay і Card, а в запиті передається GooglePay, повертається помилка <code>PAYMENTINSTRUMENT_NOT_FOUND</code>.
# '''Якщо передані доступні інструменти оплати''': У разі, якщо партнер передає, наприклад, GooglePay та Card, але GooglePay не активний для цього партнера, система поверне посилання з активним інструментом Card.
<br>

== Технічна підтримка ==
----За потреби консультацій з питань реалізації API можна написати запит на ''merchant.api.support@easypay.ua''

MerchantAPI

2025-10-07T13:51:58Z

Vadim.fedorchuk:

== Загальні відомості ==
----Протокол призначено для торговців, які є одержувачами платежів. Продавець підписує договір про прийняття платежів або анкету-акцепт до публічної оферти.

Щоб отримати платежі, ви можете використовувати web, мобільні версії сайтів, а також мобільні програми. У разі використання цього протоколу не здійснюється перевірка даних для ідентифікації замовлення або облікового запису. EasyPay завжди приймає дані, надіслані та створені продавцем.

=== Заголовки запитів ===
----

Для надсилання запиту та отримання відповіді у форматі JSON, необхідно передати такі обов’язкові заголовки у запиті.<syntaxhighlight lang="jsonml+bst" line="1">
--header 'Content-Type: application/json'

--header 'AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209'

--header 'PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760'

--header 'PartnerKey: easypay-test'

--header 'locale: ua'

--header 'Sign: bS+vPOwu1Sif1Iz47Cdh+z1RAi0s6X21C3uU0YNBNWE='
</syntaxhighlight>

=== URL ===
----<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Посилання</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>

<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>https://merchantapi.easypay.ua</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Production</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">в т.ч. для надсилання тестових запитів</td>
</tr><tr><td>[https://localapi.easypay.ua/ https://localapi.easypay.ua]</td><td>Test</td><td>локальний тест </td></tr></table>

<br>

=== Налаштування безпеки ===
----Партнер надає IP, з яких будуть здійснюватися запити.
<br>
<br>

=== Реєстрація партнера в системі EasyPay ===
----Реєстрація нового торговця передбачає отримання унікального ідентифікатора '''PartnerKey'''.

===== Характеристика параметрів реєстрації =====
<div style="overflow-x: auto; display: block; width: unset !important; height: auto !important; border: none;">
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор партнера (продавця) у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор сервісу торговця у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>SecretKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">секретний ключ для формування підпису</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>
<br>

=== Тестові параметри ===
----Для тестових запитів використовуються такі параметри:<br><syntaxhighlight lang="pl">
PartnerKey = easypay-test
ServiceKey = MERCHANT-TEST
SecretKey = test

</syntaxhighlight>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
На даний момент відсутня можливість тестування з використанням фейкових оплат / тестових карток.
Платежі тільки реальні, їх можна відмінити в день оплати методом
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">cancelOrder</span>
([[MerchantAPI#Скасування платежу|Скасування платежу]])
</p>

===== Тестове середовище =====

Перед початком використання тестового середовища необхідно надати ір з яких будуть надходити запити, для відкриття доступу. На тестовому середовищі використовуються методи аналогічні Merchant Api.

'''Тестові дані:'''

* PartnerKey:credit-test
* SecretKey: credit-test

* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-TO-CARD - виплата
* Надсилання колбеків з Iр: 195.230.131.50 <br>
<br>
'''Тестові картки для верифікації/виплат:'''

Код підтвердження для 2дс при верифікації картки: 123456

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5167803258208169</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4235751329985326</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4111111111111111</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна без створення транзакції
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4999999999990011</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата з затримкою статусу 5 хв</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4217198608967728</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата з затримкою статусу 5 хв
</td>
</tr></table>
<br>
'''Тестові картки для оплати:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5168752081922117</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0128/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4909150002132451</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0129/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна 2ДС оплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>4300380058021820</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0130/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Не успішна з 3ДС + помилка PAYMENT_ALFABANK_116
</td>
</tr><tr><td><code>'''5567217349220669'''</code></td><td>0130/111</td><td>Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td></tr></table>
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
У разі отримання помилки <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">APPID_NOT_FOUND</span>
у відповідь на будь-який метод, необхідно повторити запит
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">createApp</span>
до отримання точки ІД.
</p>
<br>

== Основні запити/відповіді ==
<hr color="#d3d3d3" size="1" noshade>
<br>
==== Реєстрація точки та створення сесії ====
Цей метод слід викликати, коли користувач вперше звертається до платіжної сторінки. Якщо браузер або пристрій змінюються, метод знову з'являється
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createApp</span>
</p>
'''Request'''<syntaxhighlight line="1" lang="json">
headers:

"PartnerKey": "partnerName",
"locale": "ua"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json-object" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": "https://cdn.easypay.ua/hint_images/",
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "f3f2b678-a3c4-45ba-a865-a136fe4a62bd",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> '''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>

<br>

==== Створення сесії ====
----Даний метод створює новий екземпляр сеансу для користувача , <code>PageId</code>.
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createPage</span>
</p>'''Request'''<syntaxhighlight line="1" lang="json">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": null,
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "29bd7237-6b8d-4048-b028-6efc23d05988",
"requestedSessionId": "fa3595d3-52de-4744-9fc6-ec2d3507d5a5",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">За замовчуванням, якщо не було активності за запитами, час життя PageId - 20 хвилин. З кожним запитом життя PageId автоматично продовжується.</td>
</tr>
</table>
<br>

==== Створення замовлення ====
----Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Для кожного нового запиту <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">CreateOrder</span> потрібно використовувати унікальний <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">PageID</span>.
</p>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/createOrder</span>
</p>

</p><syntaxhighlight lang="markdown" line="1">
headers

'Content-Type': 'application/json'
'PartnerKey': 'partnerName'
'locale': 'ua'
'AppId': 'a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId': '2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign': 'e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

<br>
</syntaxhighlight><syntaxhighlight lang="json" line="1">
{
"userInfo": {
"phone": "string"
},
Обов'язкові параметри:

"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)

Необов'язкові параметри:
"paymentOperation":"PaymentTokenization",
"additionalItems": {},
"expire": "2019-04-15T07:49:20",
"isOneTimePay": true,
"fields": [
{
"fieldName": "string",
"fieldValue": "string",
"fieldKey": "string",
}
]
},
"urls": {
"success": "string",
"failed": "string",
"back": "string",
},
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string",
"id": "string"
},
"narrative": {
"name": "string"
}
},

"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string”
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true
}
]
},
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid",
"pan": "string",
"expire": "MM/YY",
"cvv": "string",
},
"partnerInfo": {
"id": "string",
"name": "string",
"account": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги мерчанта (видає EasyPay)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>description</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення (до 120 символів)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення, роздільник - точка </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип платіжного процесу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* '''PaymentTokenization -''' використовується для токенізації картки, якою буде сплачено це замовлення.
* '''Працює лише для інструмента “карта”'''. Повинен бути заповнений ідентифікатор клієнта '''"userInfo": { "phone": "string"}'''
* Якщо передано URL для колбеку, то після успішної оплати відправляється колбек про платіж та колбек про токенізацію (приклади колбеків про оплату - в [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]], про [[MerchantAPI#Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна)|токенізацію]].
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>userInfo/phone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер телефону (або ідентифікатор) клієнта </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Номер телефону необхідний:

* для отримання списку токенізованих карток (інформація буде в масиві StoredCards)
* при оплаті із зазначенням токена картки
* для токенізації картки після успішної оплати разом із параметром
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>expire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення заданого часу замовлення сплатити неможливо. Час життя сторінки може відображатися на платіжній сторінці у вигляді таймера (за замовчуванням таймер вимкнено). Значення має бути більшим за поточний час на 6 хвилин.
'''Значення за замовчуванням - 3 дні'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>sOneTimePay</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">включає можливість успішно оплатити замовлення лише 1 раз за конкретним forwardUrl </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Значення:

* True - за замовчуванням;
* False - оплатити замовлення по тому самому ''forwardUrl'' можна буде кілька разів;</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>urls</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
*'''back -''' URL для повернення на вказану сторінку з фінальної сторінки успіху EasyPay.
* '''success -''' URL сторінки успіху, для редиректу клієнта у разі успішної оплати.
* '''failed -''' URL сторінки помилки для редиректу клієнта у разі неуспішної оплати</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''back -''' На фінальній сторінці EasyPay вгорі зліва з'явиться кнопка “Повернутись назад” з посиланням на вказану URL-адресу. Параметр не може бути порожнім і повинен відповідати формату URL.
* '''success''' - у разі, якщо не було передано urls{success,failed} для редиректу після оплати. Після оплати клієнт може не дочекатися редиректу на цей url, тому редирект не можна використовувати як індикатор успішної оплати, отримання оповіщення про успішний платіж - '''див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
* '''faild -''' приклад get-параметрів, які приходять на '''url.failed та url.succes''' (те ж, але без ''errorCode''):

<code>?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=</code>

<code>Тестове+описання+замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&''errorCode=PAYMENT_ALFABANK_-2006''&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</table>

<br>

'''Необов'язкові додаткові поля'''

'''<code>additionalItems</code> –''' необов'язкові додаткові параметри, наприклад:
<br>
<syntaxhighlight lang="json" line="1">
"additionalItems":{
"PayerEmail":"client@i.ua",
"PayerPhone":"380930007603",
"Merchant.UrlNotify":"https://notify.url",
"Merchant.Param1":"CustomValue",
"CurrencyAmountLabel":"123.56$"
},
</syntaxhighlight>'''Опис параметрів<br>'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerEmail</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">емейл клієнта для оповіщення його у разі неоплаченого замовлення та для автоматичного заповнення поля “Надіслати квитанцію на email” на сторінці оплати. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається – він не може бути порожнім і має відповідати формату email.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerPhone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">телефон клієнта, на який протягом 15-20 хв після виклику CreateOrder відправиться нагадування про неоплачене замовлення (смс або вайбер). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається, він не може бути порожнім і повинен відповідати формату телефону.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.UrlNotify</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL для надсилання нотифікації за успішним платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Параметр не може бути порожнім і має відповідати формату URL.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.Param1</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">індивідуальний параметр партнера Param1 узгоджується з EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>
</table>

<br>
'''<code>reccurentPayment</code> -''' інформація для створення рекурентного платежу на основі поточного. Рекурентний платіж буде створений за розкладом, якщо основний платіж виконаний за допомогою інструментів card, Rcard, Vcard, LifeMoney
<br><syntaxhighlight lang="json-object" line="1">
"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>cronRule</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">правило у cron-форматі, з якою періодичністю повторювати рекурентний платіж, наприклад 10 20 15 * * (кожного 15 числа місяця о 20:10). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо ця властивість порожня, значить рекурентний платіж виконуватиметься на вимогу продавця.
'''Плануйте перше виконання рекуренту щонайменше 20 хвилин від дати успішного платежу.'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateExpire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата, після якої не проводити рекурентний платіж.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateRun</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата першого запуску рекурентного платежу (опціонально). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо не заданий, перший запуск розраховується за '''recurrent/cronRule'''
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>properties</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри (опціонально) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''reccurent/properties/amount -''' сума кожного рекурентного платежу, наступного після основної оплати (опціонально)
* '''reccurent/properties/failedCount -''' ккількість поспіль неуспішних викликів рекурентних оплат, після чого рекурентний платіж видаляється (опціонально). За замовчуванням - 4 спроби: при неуспіху - повторюється спроба кожні 20-30 хвилин, 4 неуспішних спроби поспіль по одному recurrentId - і рекурент відключається. Якщо після 3 неуспішних спроб була 1 успішна, то лічильник неуспішних для цього рекурента скидається.
* '''reccurent/properties/failedRule -''' cron-правило (період) повтору при неуспішному виклику рекурента (опціонально)
* '''reccurent/properties/UrlNotify''' - URL для надсилання нотифікації за успішним '''рекурентним''' платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
</td>
</table>
<br>
'''<code>bankingDetails</code> -''' передача банківських реквізитів для перерахування коштів у випадку, якщо банківські реквізити можуть змінюватися щодо різних платежів одного сервісу продавця. На стороні EasyPay має бути увімкнено режим "Отримувати реквізити із запиту".
<br>
<syntaxhighlight lang="json" line="1">
{
"bankingDetails": {
"payee": {
"id": "123664578",
"name": "департамент патрульної поліції",
"bank": {
"name": "пат пумб",
"mfo": "330556",
"account": "123654778889"
}
},
"payer": { "name": "Иванова Мария" },
"narrative": { "name": "Переказ коштів згідно договору з ФК № 111/11-П від 11.11.1111 р. за виключенням винагороди за їх переказ згідно реєстру від [work_date]р." }
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/ID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">код одержувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">ЄДРПОУ або ІПН</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">одержувач </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банк отримувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Mfo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">МФО банку </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">може не заповнюватися, якщо Payee/Bank/Account містить IBAN</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Account</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">р/р одержувача або IBAN </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payer/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">платник </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Narrative/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">призначення платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 157 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">повну структуру bankingDetails можна не передавати, для цього достатньо передати </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">

ідентифікатор банківських реквізитів із довідника, який узгоджений із конкретним партнером та перебуває в системі EasyPay.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">

</td>
</table>

'''Splitting''' - інформація щодо сплітування (розщеплення) платежу.

Частина загальної суми з order/amount розподіляється відповідно до інформації в splitting/items/value, а залишок - йде на основні реквізити з bankingDetails (або bankingDetailsId). На стороні EasyPay має бути увімкнено режим “Отримувати реквізити із запиту

Структура '''items''' це масив. Основний платіж буде розщеплений стільки платежів, скільки міститься у цьому масиві плюс залишок. Кожен розщеплений платіж буде надіслано на відповідні банківські реквізити <code>items/bankingDetails</code>. Залишок коштів буде надіслано на реквізити основного платежу з <code>BankingDetails</code> або <code>bankingDetailsId,</code> які потрібно обов'язково вказувати під час сплітування.
<br>
<syntaxhighlight lang="json" line="1">
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string"
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>

 <tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор послуги, за якою ініціюється зарахування спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/orderId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор внутрішнього замовлення Мерчант для маркування конкретного спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/bankingDetails</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банківські реквізити кожного розщепленого платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/unit</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">може бути '''Amount''' (сума розщепленого платежу в грн.) або '''Percent''' (сума розщепленого платежу вважається відсотком від загального). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/value</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">значення у цифрах. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/withCommission - true/false</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Вказує з якого з одержувачів слід утримати внутрішню комісію. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Сума комісії розраховується із загальної суми платежу, а утримується - з першого одержувача зі '''splitting,''' у якого '''withCommission=true'''. Якщо ні в кого з '''splitting''' не зазначено '''withCommission=true''', то комісія втікає з “основного” одержувача, вказаного в bankingDetails.
Якщо у всіх значення '''withCommission=false''' (або не передали), то комісія утримається з "основного одержувача", вказаного в параметрі '''bankingDetails'''

Якщо всі значення '''withCommission=true,''' то комісія утримається з першого одержувача, зазначеного в splitting. Залишок буде надіслано на реквізити основного платежу з '''bankingDetails''' або '''bankingDetailsId.'''

При встановленому сервісом Типі розрахунків “За актами", одержувачам перераховується повна сума, без відрахування комісії, незалежно від значення WithComission.
</td>
</tr>

</table>
<br>

Після виконання сплітування під кожен спліт (частини) платежу на стороні EasyPay створюється фінансова транзакція з унікальним transactionID.
<br>
* Якщо списання грошей з картки пройшло успішно і всі реквізити для спліту вказані корректно (доступні) - всі транзакції набувають успішного статусу і по кожній транзакції відправляється колбек.
* Якщо списання грошей з картки пройшло неуспішно – запит відхиляється з кодом фінансової помилки;
* Якщо списання грошей з картки пройшло успішно, але хоча б один із реквізитів зазначено неправильно – всі транзакції спліту (частини) платежу – будуть відхилені.
<br>
Після проведення успішного списання та сплітування по кожній фінансовій транзакції в рамках спліту направляється колбек (нотифікація) про успішний платіж. Приклад коллбека (нотифікації) вказаний у [[MerchantAPI#Повідомлення про платіж|повідомлення про платіж]]'''''.'''''

<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Якщо параметр <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">userPaymentInstrument</span> не є порожнім, створення платежу буде відбуватися автоматично.
</p>

Для різних інструментів передаються такі параметри:

'''userPaymentInstrument –''' інструмент оплати.

'''*Картка (PCI DSS)'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "Card",
"pan": "5168123456780123",
"expire": "MM/YY",
"cvv": "string" }

</syntaxhighlight>

'''*Токенізована Карта'''<syntaxhighlight lang="json" line="1">
{"userInfo":{"phone":"380935207603"}, /Phone,під яким токенізована карта/
…
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid", /токен картки/
}
}

</syntaxhighlight>
'''Kyivstar Money/Life Money /VodafoneMoney'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "KSMoney / LifeMoney / VodafoneMoney",
"phone": "380xxYYYYYYY" }

</syntaxhighlight>'''ApplePay/GooglePay'''
<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "ApplePay / GooglePay",
"token": “string”/Токен, отриманий від Apple | Google /
}

</syntaxhighlight>

* '''partnerInfo –''' інформація про партнера
* '''partnerInfo.name –''' найменування партнера
* '''partnerInfo.id –''' ВД (ЄДРПОУ) партнера
* '''partnerInfo.account –''' рахунок партнера (особовий рахунок/IBAN…)

*

<br>

==== Створення замовлення для холдованих платежів ====
Перед використанням методу потрібне додаткове налаштування терміналів зі сторони техпідтримкиEasyPay.

Перед викликом цього методу потрібно викликати один із методів:

'''[[MerchantAPI#Створення сесії|- CreateApp]]'''

'''[[MerchantAPI#Створення сесії|- CreatePage]]'''

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>'''REQUEST HEADERS'''<syntaxhighlight lang="http">
PartnerKey: partnerName
locale: ua
AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1
PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d
Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4=
</syntaxhighlight>'''REQUEST BODY'''<syntaxhighlight lang="json">
{
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount": 1.01,
"paymentOperation": "Hold",
"expire": "2019-04-15T07:49:20.009Z",
"isOneTimePay": true,
"additionalItems": {}
},
"urls": {
"success": "string",
"failed": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>orderId</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор замовлення в системі партнера </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>description</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>amount</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td></tr>
<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation = Hold</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр, що вказує, що подальший платіж буде холдовано(зарезервовано) з можливістю підтвердження або скасування. </td></tr>

</table>

'''Необов'язкові параметри'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>expire</code> </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення вказаного часу замовлення оплатити неможливо. При ненульовому значенні на платіжній сторінці відображатиметься таймер. Значення повинне перевищувати поточний час щонайменше на 5 хвилин. Типове значення — 3 дні.

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isOneTimePay</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">вказує, чи можна оплатити одне замовлення кілька разів. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Типове значення — True.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalItems</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">наприклад:
<code>"additionalItems":</code>
<code>{ "PayerEmail" : "client@i.ua",</code>
<code>"PayerPhone" : "380930007603"</code>
<code>},</code>

* де PayerEmail — емейл клієнта для сповіщення у разі неоплаченого замовлення та автоматичної підстановки на платіжній сторінці.

* PayerPhone — номер телефону для надсилання повідомлення (SMS або Viber) про неоплачене замовлення (через 15–20 хвилин після виклику CreateOrder).</td><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URLs </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки успішної оплати для редиректу клієнта. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">failed — URL сторінки помилки для редиректу клієнта.
приклад параметрів, що передаються на url.success (без errorCode) і

<code>url.failed: ?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=Тестове+описання+</code>

<code>замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&errorCode=PAYMENT_ALFABANK_-2006&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</tr></table>

'''RESPONSE''' <syntaxhighlight lang="json">
HEADERS
-------
BODY
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": "https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b",
"error": null
}

</syntaxhighlight>

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів, у яких немає сертифікатів '''PCI DSS''' для обробки карткових даних. Або якщо у партнера немає власної платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструмент '''RCard''' надається лише користувачам, які авторизовані в системі EasyPay.
Можливі значення '''instrumentType''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType:'''
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
</td>
</tr></table>

Холдування платежу можна здійснити, оплативши замовлення на сторінці оплати (перейти за '''forwardUrl'''), або вказавши в запиті '''createOrder''' інструмент оплати у '''userPaymentInstrument''' (див. [[MerchantAPI#Створення замовлення|Створення замовлення]]).

Клієнту відобразиться сторінка успішного платежу EasyPay, або сторінка, вказана в “urls”:{}.

Після '''спроби холдування платежу''' партнеру буде відправлено '''сповіщення''', згідно з варіантом, вказаним в налаштуваннях сервісу [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]].

Статус платежу необхідно перевірити методом '''[[MerchantAPI#Перевірка статусу платежу|orderState]]'''

Після успішного холдування необхідно викликати або '''[[MerchantAPI#Розхолдування платежу|unHoldOrder]]''' , або '''[[MerchantAPI#Скасування платежу|orderCancel]]'''

Якщо протягом '''повних 10 днів''' після холдування жоден з цих методів не буде викликаний, на '''11-й день близько 05:00''' платіж може бути '''відхилений емітентом''', і кошти стануть доступні клієнту.

У транзакцію додається коментар: ''Автоматично відхилено через 10 днів. (SYSTEM ACCOUNT [dateTime])''

Сповіщення партнеру при цьому '''не надсилається'''.

==== Розхолдування платежу ====
Якщо цей метод не буде викликано протягом 10 днів, кошти повертаються клієнту, а платіж у системі відхиляється.

Перед викликом цього методу необхідно здійснити '''[[MerchantAPI#Створення замовлення для холдованих платежів|холдування транзакції]]'''

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/unHoldOrder</span></p>

'''REQUEST''' '''HEADERS''' <syntaxhighlight lang="http">
'PartnerKey: easypay-test'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='
</syntaxhighlight>

'''REQUEST BODY'''<syntaxhighlight lang="json">
{
"transactionId":955537573,
"orderId":"hold_4",
"serviceKey":"MERCHANT-TEST",
"amount": 1.2
}
</syntaxhighlight>
'''<br />RESPONSE''' <syntaxhighlight lang="json">
{
"paymentState": "accepted",
"error": null
}
</syntaxhighlight>'''Опис параметрів запиту''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний номер платежу в системі EasyPay</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор замовлення в системі партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов’язковий параметр, торгова сума, яку слід списати з картки.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Різниця повернеться клієнту на картку протягом '''1–2 днів''', залежно від регламенту банку

</td>
</tr></table>
'''<br>Опис параметрів відповіді'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі '''paymentState:'''
• '''accepted -''' платіж успішний (кінцевий статус)

• '''pending -''' платіж в обробці (некінцевий статус)

• '''declined -''' платіж відхилений (кінцевий статус)

• '''none -''' платіж не знайдено
</td>
</tr></table>

Для платежів з 2DS переадресація на сторінку банку-емітента не відбувається, і користувач відразу отримує статус платежу.

Після '''спроби розхолдування платежу''' партнеру буде надіслано '''сповіщення''' згідно з варіантом, вказаним в налаштуваннях сервісу [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]

Статус платежу необхідно перевіряти методом '''[[MerchantAPI#Перевірка статусу платежу|orderState]]'''

==== Параметри BrowseInfo при 3DS оплаті ====
У зв'язку з переходом банків - екваєрів на модель роботи 3D Secure 2.x, при створенні замовлення з одночасною передачею інструменту оплати в запиті (карта, токен карти, токен Apple / Google Pay), необхідно передавати додаткові параметри пристрою (браузера) клієнта в заголовках і в тілі запиту createOrder, у прикладі вони виділені:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>'''HEADERS'''
"appId: b15c4b64-8964-4c80-852e-df59a0e0d9b6",<br>
"pageId: 607514b8-1da5-490a-bdf3-0c6883131625",<br>
"partnerKey: easypay-test",<br>
"sign: XJ3roGhTLwAZXigBp/iVRdsXlZYdTSen3xSM+29GaRg=",<br>
"Content-Type:application/json",<br>
<span style="color: green;">"AcceptHeader:*/*",</span><br>
<span style="color: green;">"User-Agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"</span><br>
'''BODY'''
<div style="font-family: monospace; white-space: pre-line;">

"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_3ds2x",
"additionalItems":{
"Merchant.UrlNotify":"http://url.noti.fy"
},
"description":"Easy test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"Card",
"pan":"4444444444444444",
"expire":"0599",
"cvv":"123"
},
<span style="color: green;">
"browserInfo":{
"colorDepth":"24",
"screenHeight":"824",
"screenWidth":"1536",
"language":"uk-UA",
"javaEnabled":"false",
"javascriptEnabled": "true",
"timeZone":"-180"
}
</span>

</div>

<br>
'''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AcceptHeader:*/*</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте без змін</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>User-Agent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте клієнтський User-Agent </td></tr></table>

'''Приклад, як збирати дані на JS:'''<syntaxhighlight lang="markdown" line="1">
getBrowserInfo() {
let browserInfoModel = {};
browserInfoModel.colorDepth = window.screen.colorDepth.toString();
browserInfoModel.screenHeight = window.screen.height.toString();
browserInfoModel.screenWidth = window.screen.width.toString();
browserInfoModel.language = window.navigator.language;
browserInfoModel.javaEnabled = window.navigator.javaEnabled();
browserInfoModel.timeZone = (new Date()).getTimezoneOffset().toString();
return browserInfoModel;
}

</syntaxhighlight>Якщо все передано правильно, то отримайте відповідь як нижче у прикладі '''"Якщо передано userPaymentInstrument (для випадку з 3DSecure)",''' або помилку оплати з картки, наприклад, "Недостатньо коштів".

У випадку, якщо додаткові параметри передані неправильно, отримайте помилку платіжного сервісу, наприклад:<syntaxhighlight lang="markdown">
"errorCode":"PAYMENT_PUMB_SERVICE_FAILURE",
"errorMessage":"Технічна помилка екваєра. Зверніться до служби підтримки EasyPay, або спробуйте пізніше"

</syntaxhighlight>'''Відповідь (RESPONSE)''':<syntaxhighlight lang="json" line="1">
header:
відсутній

body:
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},

{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b,
"error": null,
}

Якщо передано userPaymentInstrument (для випадку з 3DSecure):
{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form action='https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type='hidden' name='PaReq' value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":860094566,
"retrievalReferenceNo":null,
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів які не мають сертифікатів PCI DSS для обробки карткових даних. Або якщо партнер не має платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">на сторінці оплати можемо відключати елементи інтерфейсу:
- логотип EasyPay можемо приховувати

- лічильник часу, що залишився до оплати, може бути відображений/прихований

- поле "Призначення" (можемо вимкнути, або за замовчуванням зробити відкритим/закритим)

- рядок з логотипом партнера та назвою можемо приховати

- поле введення імейл сховати / відобразити

- рядок з "Номер замовлення" приховати/показати
</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструменти '''Emoney''', vcard та '''RCard''' видаємо тільки для користувачів, які авторизовані в системі EasyPay. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType'''
* Emoney – гаманець EasyPay
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
* ApplePay – оплата через ApplePay
* GooglePay – оплата через GooglePay
* LifeMoney – мобільні гроші Лайф.
* KsMoney – мобільні гроші Київстар
* VodafoneMoney – мобільні гроші Водафон
* картки лояльності Fishka
</td>
</tr></table>

'''3DSecure / mobile payments case:'''<syntaxhighlight lang="json">
Якщо передано userPaymentInstrument (для випадку з 3DSecure):

{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form" action="https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type="hidden" name="PaReq" value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":"860094566",
"retrievalReferenceNo":"null",
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>

<br>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Confirmed''' - платіж підтверджений (кінцевий статус, якщо "status": "done")
* '''WaitConfirm''' - платіж у статусі "обробляється", необхідно додатково запросити фінальний статус платежу
* '''WaitVerify''' - від клієнта очікується підтвердження (наприклад, якщо "status": "Need3Ds" - необхідно пройти перевірку 3D Secure) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Done''' - додаткові дії не потрібні, якщо при цьому "зберіганнядержави":"затверджено", означає платіж повністю успішний. При іншому значенні paymentState- платіж не прийняв кінцевий статус, необхідно запросити статус ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]).
* '''Need3Ds''' - необхідно підтвердження 3D Secure від клієнта ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedConfirmCode''' - необхідно надіслати код перевірки зі смс методом confirmCodeVerification ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedLookup''' - необхідно надіслати код перевірки з смс '''''методом confirmCodeVerification ('''''[[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]]) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionType</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип наступної дії:

* '''"FormRedirect"''' - необхідно створити сторінку (форму) з html-коду, який передано у параметрі "actionContent" :'''"<html>...</html>",''' відкрити її клієнту, наприклад, для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl".'''
* Після проходження перевірки клієнт буде передресовано на фінальну сторінку EasyPay або на

<code>"urls": {</code>

<code>"success": "string",</code>

<code>"failed": "string"</code>

<code>}</code>

* '''"UrlRedirect"''' - переадресувати клієнта на посилання з "action" або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".'''
* '''"ConfirmCode"''' -необхідно надіслати код перевірки з смс методом '''confirmCodeVerification''' ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])

'''"None"''' - можливий при використанні інструменту гаманець '''("instrumentType": "EMoney"),''' кошти успішно списані з гаманця, партнеру надсилається повідомлення про списання. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"<html>...</html>"''' - html форма сторінки банку для введення коду 3DS. Сформувати сторінку з коду та відкрити її клієнту. Після підтвердження платежу відбудеться 302-й редирект на ваші "urls" із запиту createOrder, або на фінальну сторінку EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції в EasyPay </td></tr></table>

'''<br />2DSecure case:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Confirmed"''' та '''"status": "Done"''' - платіж пройшов успішно. При інших значеннях необхідно перевірити статус '''''платежу''''' '''('''[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]''')''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Done" -'''платіж завершено, додаткові дії не потрібні. При '''"paymentState":'''

* '''"Confirmed"''' - означає, що транзакція на стороні EasyPay прийнята (http - оповіщення успішно доставлено партнеру) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції до EasyPay </td></tr></table>

<br>

==== Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки ====
----У випадку "<code>actionType</code>": "<code>ConfirmCode</code>", клієнту прийде код підтвердження, який потрібно передати до EasyPay
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/confirmCodeVerification</span>
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"code": "string"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{ }
</syntaxhighlight>Якщо "status":"Need3Ds", то клієнту потрібно пройти 3DS перевірку в залежності від значення '''"actionType".'''
<br>
'''Опис параметрів:''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>FormRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно СТВОРИТИ сторінку (форму) з html-коду, який передано у параметрі </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">"<html>...</html>", відкрити її клієнту для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl"''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>UrlRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно переадресувати клієнта на посилання з '''"action"''' або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".''' Відобразиться форма банку емітента картки для перевірки 3D Secure. Після введення коду клієнта переадресує на сторінку успіху чи помилки. Адреси сторінок передаються на етапі створення замовлення.

<code>"urls": {</code>

<code> "success": "string",</code>

<code> "failed": "string"</code>

<code>}</code> </td></tr></table>

<br>

==== Перевірка статусу платежу ====
----

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/orderState</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers:
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20240524-0015",
"transactionId":"1413668587"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers:
відсутній

body:
"merchantKey":"easypay-test",
"transactionId":1413668587,
"orderId":"test_20240524-0015",
"amount":3.000000,
"paymentState":"declined",
"refundTransactionId":1413673292,
"":
"paymentsList":[

],
"refunds":[
{
"refundTransactionId":1413669380,
"paymentState":"accepted",
"refundAmount":1.10,
"dateAccepted":"2024-05-24T16:14:45+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:14:39+03:00"
},
{
"refundTransactionId":1413673292,
"paymentState":"accepted",
"refundAmount":1.90,
"dateAccepted":"2024-05-24T16:19:40+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:19:33+03:00"
}
],
"error":null
}

</syntaxhighlight>
'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;"></th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Фінальний'''
'''статус?'''</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Значення/ подальші дії'''</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accepted</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"> '''так'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж прийнято</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>declined</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">так</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж відхилений
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pending</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ні</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж знаходиться в обробці, необхідно повторити запит статусу пізніше
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>none</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">- </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">статус платежу не визначено, необхідно повторити запит статусу до отримання кінцевого статусу</td>
</tr></table>

'''Нетипові відповіді запит статусу:'''

* Якщо платіж не знайдено, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"error":{
"errorCode":"MERCHANT_ORDERID_NOT_FOUND",
"title":null,
"description":null,
"errorMessage":"MERCHANT_ORDERID_NOT_FOUND",
"fieldErrors":[ ]
}

</syntaxhighlight>

* Якщо платіж (сторінка, замовлення) не були відкриті клієнтом або не було спроби оплати, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId2",
"amount": 0,
"paymentState": "pending",
"refundTransactionId": null,
"paymentsList": [],
"error": null
}

</syntaxhighlight>

* Якщо отримано помилку на замовлення на етапі визначення реквізитів:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId",
"amount": 0,
"paymentState": "declined",
"refundTransactionId": null,
"paymentsList": [],
"error": {
"errorCode": "PROVIDER_ACCOUNT_INVALID", (ерор код може (має) відрізнятися від того, що в прикладі)
"title": "Помилка системи",
"description": "Акаунт не знайдено",
"errorMessage": "string"
}
}

</syntaxhighlight>

При виконанні запиту статусу на замовлення, у яких є спліт (платіжна опція) - повертається наступна модель:

'''Request:'''<syntaxhighlight lang="json" line="1">
headers:

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"easypay-test",
"orderId":"full_split_11",
"transactionId":""
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey": "easypay-test",
"transactionId": 991379504,
"orderId": "full_split_11",
"amount": 3.150000,
"paymentState": "accepted",
"refundTransactionId": null,
"paymentsList": [
{
"merchantKey": "easypay-test",
"transactionId": 991379509,
"orderId": "full_split_11",
"amount": 1.030000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379508,
"orderId": "full_split_11",
"amount": 0.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379507,
"orderId": "full_split_11",
"amount": 1.020000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379506,
"orderId": "full_split_11ID",
"amount": 1.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
}
],
"error": null
}

</syntaxhighlight>

'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentsList</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список платежів у структурі спліту з деталізацією. </td></tr></table>

У випадку зі сплітованими платежами, в основному тілі відповіді '''OrderState''' - параметру '''transactionId''' присвоюється внутрішній технічний номер (нефінансової) операції.<syntaxhighlight lang="json" line="1">
"urls": {
"success": "string",
"failed": "string"
}

</syntaxhighlight>

==== Скасування платежу ====
----Метод викликається '''лише''' для платежів у статусі '''"accepted".''' Для успішного скасування має бути достатньо суми прийнятих платежів у день скасування. Можна скасовувати платежі, які не старші 30 днів. Успішне повернення після цього терміну – не гарантується, залежить від умов банків-еквайєрів.

Повернення суми на картку відбувається в строк 0-3 робочих дні, в окремих випадках – до 30 робочих днів. Це залежить від умов банку-еквайєра, через який пройшов основний платіж, а також банку-емітента.

===== Скасування звичайного платежу =====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "MERCHANT-TEST",
"orderId": "test_20210217-121843",
"transactionId": "913141164",
"amount":"1"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
body
{
"merchantKey":"easypay-test",
"transactionId":913141164,
"refundTransactionId":913141464,
"orderId":"test_20210217-121843",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>

'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">скасована сума </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">для часткового скасування - передається із сумою, яку потрібно скасувати.
для скасування повної суми - параметр amount не передається
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">транзакція рефанду (скасування)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування). Можливі значення: </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* a'''ccepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* p'''ending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен повертати '''"'''<code>paymentState</code>'''":"'''<code>declined</code>'''",''' а запит статусу транзакції скасування - '''"'''<code>paymentState</code>'''": "'''<code>accepted</code>'''"'''

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація ([[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]), на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром "<code>action</code>": "<code>refund</code>'''"''' та сумою (amount), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Скасування платежу (замовлення зі Splitting параметрами) =====
----Скасування платежу (Замовлення) можна робити:

* на всю суму платежу (замовлення)
* на суму одного спліту (Часткова скасування платежу (замовлення))
* на суму меншу від суми спліту (Часткова скасування спліту)
<br>

===== Скасування повної суми платежу (замовлення зі Splitting параметрами) =====
----
* Для скасування повної суми Splitting транзакції необхідно виконати запит статусу транзакції згідно з розділом "[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]'''"''' використовуючи основний <code>OrderID</code>
* Отриманий у відповіді кореневий <code>transactionID</code> використовувати у запиті [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]]
* У відповідь на запит [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]] буде отримано відповідь зі статусом скасування, а також буде отримано коллбек по кожній транзакції, яка входила до Splitting транзакції.
* Коллбек на загальну суму Splitting транзакції не надходить.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379504,
}
</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId": 991379504,
"refundTransactionId":913141464,
"orderId":"full_split_11",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''Pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</tr>

</table>Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати <code>"paymentState"''':"'''declined'''"'''</code> як для основної так і для окремих транзакцій, а запит статусу транзакції скасування - <code>"paymentState":"accepted".</code>

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром <code>"action": "refund"</code> та сумою (<code>amount</code>), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Часткове скасування (повернення) платежу (замовлення зі Splitting параметрами) =====
Для часткового скасування платежу необхідно виконати запит <code>cancelCurder</code> використовуючи <code>transactionID</code> який був отриманий в коллбеку (параметр payment_id), а також вказавши суму скасування (вона має бути меншою або дорівнює сумі транзакції, що скасовується).

* У відповідь на запит <code>cancelOrder</code> буде отримано відповідь зі статусом скасування, а також буде отримано коллбек про успішне скасування цієї транзакції.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379509,
"amount":1.00
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr></table>

'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId":"991379509",
"refundTransactionId":"913141464",
"orderId":"full_split_11",
"amount":"1.000000",
"paymentState":"accepted",
"error":"null"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування)
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>

</tr></table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати "paymentState":"declined", а запит статусу транзакції скасування - "paymentState":"accepted"
При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде одноразово надіслано POST - запит із параметром '''"action": "refund"''' та сумою '''(amount)''', яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

=== Повідомлення про платіж ===
----
# Партнер обов'язково вибирає 1 або кілька способів сповіщення та повідомляє його в EasyPay. Партнер зазначає платіж успішним на своїй стороні лише після отримання цього повідомлення
# Ми надсилаємо HTTP - колек з IP 93.183.196.26 методом POST з інформацією про платіж.
# Запит надсилає EasyPay партнеру після того, як транзакція набула фінального статусу (Accepted, Declined).
# URL для повідомлень '''(UrlNotify)''' партнер направляє у запиті '''createOrder''' у параметрі:
<br>
<syntaxhighlight lang="json" line="1">
"order":{
"additionalItems":{
"Merchant.UrlNotify":"https://notify.url"
}
}
</syntaxhighlight>
<br>
"Merchant.UrlNotify" Параметр не може бути порожнім і має відповідати формату URL.
<br>

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Якщо у відповіді не отримано <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">HTTP StatusCode 200</span>, запит нотифікації буде надіслано повторно протягом <strong>1-10 хвилин</strong>.
Повторення може продовжуватися визначену кількість разів (за замовчуванням – <strong>50 разів</strong>), поки не буде отримано статусу <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #198754;">"200 ОК"</span>.
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Sign": "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
body
{
"OperationType": "Payment",
"PartnerKey": "groshi-com",
"ServiceKey": "GROSHI-COM-GOOGLEPAY",
"TransactionStatus": "Accepted",
"MerchantOrderId": "3127194_28_450866",
"DateTime": "2023-12-09T14:00:48",
"Amount": 2059.08,
"Commission": 28.83,
"TransactionId": 1336448544,
"AdditionalItems": {
"Merchant.Inn": "3178404189",
"Merchant.Details": ";0;0;;4;",
"Merchant.UrlNotify": "https://testpartner.ua/callback",
"Merchant.ClientFullName": "Іванов Дмитро"
"Acquirer.MerchantId":"12345678"
"Acquirer.TerminalId":"E1234567"
"Card.BrandType":"Visa"
"AuthCode":"012345"
}
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>OperationType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)

'''refund -''' про успішне скасування платежу (відправляється разово)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionStatus</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>MerchantOrderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.MerchantId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торговц'''я''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.TerminalId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор платіжного пристрою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Card.BrandType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">найменування платіжної системи, платіжний інструмент якої використовується </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AuthCode</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Код авторизації </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>DateTime</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">якщо партнер не відповість статусом 200 на запит з action:payment, то в наступному запиті час буде новим</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ID транзакції на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>

</table>
<br>Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.
Для правильного обчислення підпису, тіло з нотифай потрібно брати як є, без перетворень та форматувань.
У випадку, якщо підпис notify не перевірено, всі фінансові ризики перекладаються на партнера.

==== Отримання інформації про рекурентний платіж ====
----
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/info</span></p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="
queryParams
"serviceKey": "string"
"orderId": "string"
"reccurentId": "0"
"dateFrom": 2025-03-10
"dateTo": 2025-03-17
"isEnabled": true|false
"pageNumber": 1
"countPerPage": 3

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"merchantReccurentPaymentDetails":[
{
"recurrentId":14433854,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601+url",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:38:02+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:42+02:00",
"properties":{
"failedCount":"1",
"urlNotify":"http://109.251.205.8:9987/merch/notifysigncheckexample.php"
}
},
{
"recurrentId":14433852,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:37:25+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:03+02:00",
"properties":{
"failedCount":"1"
}
}
],
"totalCount":2,
"totalFilteredCount":2,
"pageFilteredCount":2,
"currentPageNumber":1,
"numberOfPages":1,
"error":null
}

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>reccurentId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекурента </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateFrom</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента з.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateTo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента по.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isEnabled</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити лише активні / або неактивні рекуренти </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pageNumber</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити сторінку номер.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>countPerPage</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">кількість записів на сторінці </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>templateId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекуренту (reccurentId) </td></tr></table><br>

==== Виклик рекурентного платежу ====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/payment</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"reccurentId": 0,
"amount": 0
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"reccurentId": 0,
"transactionId": 0,
"transactionStatus": "None",
"error": {
"errorCode": "string",
"title": "string",
"description": "string",
"errorMessage": "string",
"fieldErrors": [
{
"fieldName": "string",
"errorCode": "string",
"errorMessage": "string"
}
]
}
}

</syntaxhighlight>Також буде надіслано нотифікацію у разі успішного платежу. Створення рекурентного платежу на операцію, у структурі якої є спліт – не підтримується.

<br>

=== Видалення рекурентного платежу ===
----
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/reccurent/delete/{id}</span>
</p>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
відсутній
</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

-

body

-
</syntaxhighlight>

== Робота з токенізованими картами ==
----

=== Токенізація карти ===
Метод призначений для токенізації (збереження) картки для ідентифікатора користувача під конкретним торговцем.

===== Токенізація з передачею даних картки у запиті (заборонено без PCI:DSS сертифікації мерчанта) =====
Перед викликом цього методу. Потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]

'''-''' [[MerchantAPI#Створення сесії|CreatePage]] <br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCard</span></p>
<br>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "380501002030ws",
"pan": "4874120123567889",
"expire": "1222",
"cvv": "012",
"vсode": "123654"
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"activateCodeType": "code|amount",
"cardGuid: "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan”: "48741201****1234",
"expire”: "1222"
"error": "null"
}

</syntaxhighlight>Токенізація картки - процес двоетапний.

На першому етапі у запиті йдуть параметри картки та номер телефону користувача. У відповіді, залежно від '''activateCodeType''', може бути активація за кодом підтвердження з виписки або SMS або за сумою списання.

З другого краю етапі до всіх параметрів додається ще vcode – код верифікації. При успішному відповіді прийдуть параметри токенізованої карти чи помилка.

===== Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна) =====
Перед викликом цього методу, потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]];

'''-''' [[MerchantAPI#Створення сесії|CreatePage]];
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">api/merchant/tokenCard/create</span></p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type: application/json"
"PartnerKey: partnerName"
"locale: ua"
"AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "8888",
"expire": "2020-12-06T12:54:32.043Z",
"urls": {
"success": "https://test.ua",
"failed": "https://test1.ua",
"notify": "https://test2.ua",
"back": "https://test3.ua"
},
"description": "testtts",
"checkExistingToken": false
"operationType":"SingleToken | createToken | ExistingToken"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"forwardUrl": "https://easypay.ua/ua/tokencard/cae16afc-be56-4a39-8ce1-5de4f4142e76",
"error": null
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>description</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |опис, який відобразиться на сторінці токенізації
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час життя сторінки токенізації (по дефолту - 15 хвилин)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережеться картка (будь-які літери, цифри, GUID.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |'''Не повинен містити символ ‘+’'''
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>urls</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |містить інформацію про:

* сторінці успіху партнера (success) для переадресації клієнта після успішної токенізації, потрібно обов'язково передавати
* сторінці помилки ('''failed''') для переадресації клієнта у разі помилки
* адреса для відправки callback-запиту з деталями при успішній токенізації ('''notify''')
* адресу для повернення назад зі сторінки токенізації ('''back''')
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>forwardUrl</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |сторінка для додавання картки (токенізації)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>checkExistingToken</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |перевірка наявності токена по карті, що вводиться у даного партнера.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |Параметр може набувати значення:

* true - проводити валідацію на наявність раніше створеного токена по цій карті;
* false - валідація відсутня;
* null - валідація відсутня;

Якщо параметру '''checkExistingToken''' присвоєно значення true, слід очікувати наступних сценаріїв поведінки:

* “checkExistingToken” : '''true,''' і в системі '''немає раніше створених токенів''' під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''true,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) - користувачу відкривається сторінка успіху, додаткова верифікація (надсилання коду верифікації не відбувається), токен не створюється, а в callback вказується '''масив раніше створених токенів''';
* “checkExistingToken” : '''false / null,''' і в системі немає раніше створених токенів під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''false / null,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) – формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену.
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>operationType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |''(Новий параметр) задає тип операції токенізації''
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
* '''SingleToken''' - для однієї карти завжди повертається той самий токен. Логіка така:

* перевіряємо чи є токен для цієї картки під '''partnerKey''' із запиту

* якщо є 1 або більше токенів - беремо останній з них, створюємо новий запис з цим токеном для переданого ідентифікатора клієнта '''(phone)''', відправляємо цей токен в callback у кореневому параметрі '''cardGuid'''
* якщо токенів немає - створюємо новий для цього '''phone''' і відправляємо його в callback в кореневому параметрі '''cardGuid''' (один і той же '''cardGuid''' може бути прив'язаний до різних phone)

* '''createToken''' - значення за замовчуванням, звичайне створення токена (можна не передавати)
* '''ExistingToken''' - поведінка аналогічна '''checkExistingToken:true'''
|}
'''На сторінці токенізації можемо керувати інтерфейсом (на стороні EasyPay):'''
* відображати/сховати логотип EasyPay
* відображати/приховати логотип та назву партнера
* відображати/приховати опис з деталями токенізації
* відображати опис у згорнутому/розгорнутому вигляді

'''Приклад callback - запит з IP адреси 93.183.196.26 після успішної токенізації:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers

Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"partnerName",
"phone":"test989",
"cardGuid":"2ad57b2e-eb5b-4a99-ad05-788cf589b8af",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-02-24T17:32:07.447",
"codeType":"Mpi3Ds"
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережено картку
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>cardGuid</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |токен збереженої карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>pan</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |маскований номер картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |термін дії карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>datePost</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час додавання картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>codeType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ознака типу верифікації картки. Mpi3Ds – з використанням 3ds.
|}

'''Приклад callback - запит з IP адреси 93.183.196.26 з параметром ExistingToken:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers
Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":null,
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:41:53.152",
"codeType":"Code",
"existingTokens":[
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"bac4f855-xxxx-xxxx-bece-14cdf23c6c52",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:28:23.840",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"6338e8b4-xxxx-xxxx-a3e5-f46ad0cb0efa",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:34:25.733",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"18e3c35e-xxxx-xxxx-ba59-9506154394c0",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:39:42.010",
"codeType":"Mpi3Ds"
}
]
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>existingTokens</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |масив з даними раніше створених токенів по цій карті під даного партнера '''(partnerKey)'''
|}

===== Отримання списку токенізованих карт =====
----Метод призначений для отримання списку токенізованих карток за номером телефону (ознакою) користувача.
<br>
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCards/get</span></p>
'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams
phone = string
cardGuid= Guid
</syntaxhighlight>'''Response''' <syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"tokenCards": [
{
"cardGuid": "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan": "48741234****1234",
"expire”: "1222"
}],
"error": "null"
}

</syntaxhighlight>Якщо передати тільки ідентифікатор клієнта (параметр phone) - у відповіді будуть всі карти поточного клієнта. Якщо передати <code>phone</code> та <code>cardGuid</code> - у відповіді буде одна карта поточного клієнта.

<br>

===== Видалення токенізованих карт =====
----Метод призначений для видалення токенізованих карток за номером телефону. Якщо у клієнта під одним номером кілька карток, всі картки будуть видалені.
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone</span>

<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone?CardGuid=Guid</span></p>'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams

cardGuid= Guid

</syntaxhighlight>'''Response'''<syntaxhighlight lang="markdown" line="1">
headers
відсутній

body
відсутній
</syntaxhighlight>

===== Видача кредиту (переказ на картку користувача) =====
Метод призначений для переказу на картку користувача суми кредиту.
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateAPP]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
'''Request:'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order":{
"serviceKey":"CARD-FILL",
"description":"test top up card",
"amount":1.12, (decimal)
"orderId":"test",
"fields":[
{
"fieldName":"Pan",
"fieldValue":"4102321200001111",
"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"
},
{
"fieldName":"Phone",
"fieldValue":"38093520000"
}
],
"additionalItems": {
"Merchant.ClientFullName": "Иванов Петр Сергеевич",
"Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32",
"Merchant.Inn": "3334445823"
}
},
"userPaymentInstrument":{
"instrumentType":"Vcash"
}
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"redirectUrl": null,
"action": null,
"paymentState": "Confirmed",
"status": "Done",
"actionType": "UrlRedirect",
"transactionId": "766934634",
"retrievalReferenceNo": "null",
"responseItems": "null",
"error": "null"
}

</syntaxhighlight>'''Опис параметрів'''
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |paymentState
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |
* '''Confirmed''' оплата пройшла успішно
* '''WaitConfirm ''' очікується підтвердження платежу
* '''Rejected''' і '''Refunded''' платіж відхинело
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>transactionId</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" | ідентифікатор платежу в системі Easypay
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |У об'єкти поля передається інформація для поповнення карти. Номер картки можна вказувати:

* для випадку з PCI DSS сертифікацією: у відкритому вигляді

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldValue":"4102321200001111",</code>'''

* для випадку без PCI DSS сертифікації: у вигляді токена (як отримати токен картки - див. [[MerchantAPI#Токенізація карти|Токенізація карти]]):

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"</code>'''

Також потрібно вказати:

- номер телефону клієнта:

'''<code>"fieldName":"Phone",</code>'''

'''<code>"fieldValue":"38093520000"</code>'''

- ПІБ та адреса клієнта АБО ПІБ та ІПН клієнта:

'''<code>"additionalItems": {</code>'''

'''<code> "Merchant.ClientFullName": "Іванов Петро Сергійович"</code>'''

'''<code> "Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32"</code>'''

'''<code> "Merchant.Inn": "3334445862"</code>'''

'''<code> }</code>'''
|}

'''Статус видачі кредиту:'''

* Якщо у відповіді отримано кінцевий статус <code>(paymentState = Confirmed / Rejected / Refunded)</code> - необхідно присвоїти його платежу.
* Якщо кінцевий статус у відповіді не отримано <code>(paymentState = WaitConfirm)</code>, '''у тому числі при серверних, мережевих та будь-яких інших відповідях та помилках''' - необхідно запросити статус платежу методом '''orderState''' ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]) до отримання кінцевого статусу.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Важливо врахувати, що нотифікація про оплату не надсилається (якщо партнер/мерчант не повідомив про необхідність такого налаштування).<br><br>
Скасування транзакції не передбачено.
</p>
<br>

Response (Приклади відповідей при помилках: status code = 400)<syntaxhighlight lang="json" line="1">
{
"error": {
"errorCode": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"title": null,
"description": null,
"errorMessage": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"fieldErrors": [
{
"fieldName": "Order.Fields[0]",
"errorCode": "SERVICE_FIELDS_VALIDATION_EXCEPTION",
"errorMessage": "Вказана умова не була виконана для значення поля."
}
]
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pv2",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Обслуговуються тільки карти емітовані українськими банками",
"fieldErrors": []
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pa8",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Необхідно уточнити реквізити картки одержувача у банку емітента",
"fieldErrors": []
}
}

</syntaxhighlight>

===== Нотифікації (колбеки) щодо операцій поповнення карток =====
Дані колбеки є опціональним (додатковим) способом отримання інформації від EasyPay про результат виконання запиту на поповнення картки.

Для активації отримання колбеків мерчант (партнер) повинен повідомити EasyPay про таку необхідність, після чого EasyPay включає цю опцію.

Спосіб відправки колбека - '''HTTP - з IP 93.183.196.26''' буде надіслано '''POST''' запит з інформацією про платіж на вказаний <code>urlNotify</code>.

<code>urlNotify</code> прописується на стороні EasyPay і використовується за замовчуванням, якщо партнер не передав його у своєму запиті.

URL для повідомлень ('''UrlNotify''') повідомляє партнер (мерчант).

Партнер може передавати '''UrlNotify''' у запиті '''createOrder''' у параметрі:

<code>"order":{</code>

<code>"additionalItems":{</code>

<code>"Merchant.UrlNotify":"<nowiki>https://notify.url</nowiki>"</code>

<code>}</code>

<code>}</code>

"Merchant.UrlNotify" параметр не може бути порожнім і повинен відповідати формату URL.

Якщо у відповідь не отримано HTTP StatusCode 200 - запит нотифі буде надіслано повторно, доки не отримано статусу “200 ОК”.

Коли нотифікацію (колбек) успішно доставлено (отримано статус 200 ОК), повторне відправлення колбеків припиняється.

Відправлення колбеків можливе за двома сценаріями:

1) лише за успішними операціями (транзакціями);

2) за операціями (транзакціями) у фінальному статусі (успішні та відхилені).

Надання фінального статусу операції (транзакції) асинхронно з процесом відправки колбека (фінансова транзакція набуває фінального статусу незалежно від статусу прийняття колбека партнером).

'''Request''' <syntaxhighlight lang="markdown" line="1">
headers

"Sign: "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
"User-Agent": "EasyPay.MerchantNotifyService"

body

{
"action": "payment",
"merchant_id": 5347,
"order_id": "5",
"date": "2019-06-19T15:38:10.7802613+03:00",
"details": {
"amount": 1.00,
"desc": "Wooden tables x 10",
"payment_id": 724502946,
"recurrent_id": null
},
"additionalitems": {
"BankName": "CB PRIVATBANK",
"Card.Pan": "414962******1234",
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>action</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>merchant_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер сервісу партнера на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>order_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>date</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>details</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">детальна інформація про платіжну операцію (транзакцію) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''payment_id -''' ID детальна інформація про платіжну операцію (транзакцію):
* '''amount''' - сума фінансової операції;
* '''desc''' - опис замовлення, отриманий під час запиту CreateOrder;
* '''recurrent_id''' - ознака реккурентного платежу (завжди за замовчуванням на операціях поповнення картки – null);</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalitems</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">блок додаткових параметрів, до якого можуть включатися додаткові айтеми, отримані в запиті CreateOrder:
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''BankName''' - назва банку власника картки;
* '''Card.Pan -''' номер картки у маскованому вигляді.</td>
</tr></table>

Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> У випадку, якщо підпис <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">notify</span> не перевірено, всі фінансові ризики перекладаються на партнера.
</p>

== Інтеграція з ApplePay ==
----Вимоги

# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитись з умовами надання послуг Apple Pay.
# Необхідно укласти договір із Easypay.ua.
<br>Apple Pay надає простий та безпечний спосіб проведення платежів у додатках iOS, watchOS та сайтах Safari. Використовуючи Face ID, Touch ID або двічі клацнувши Apple Watch, користувачі можуть швидко та безпечно передавати свої платіжні дані для оплати.

=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка Apple Pay буде відображена на сторінці оплати EasyPay

=== Оплата ApplePay з додатку ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], в який потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимоги до брендування].

<br>
==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.

''Примітка: * - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).''

# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay

==== Технічна інтеграція з ApplePay ====

# Щоб інтегрувати Apple Pay у мобільний додаток, дотримуйтесь інструкцій за посиланням: https://developer.apple.com/documentation/passkit/apple_pay.

'''Приклад відповіді ApplePay''' <syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>2. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token в Easypay</code> ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Приклад запиту '''createOrder''':<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{ApplePayMerchantId}"
}
}

</syntaxhighlight>

=== Оплата із сайту ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], до якого потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимог до брендування].

==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).</em>
</p>
<br>
# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay
# Зареєструйте та підтвердіть свій домен:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі "Merchant Domains" натисніть "Add Domain".
## Введіть ім'я домену та натисніть "Continue" *.
## Завантажте файл apple-developer-merchantid-domain-association.txt.
## Збережіть файл на сервері від Apple.
## Натисніть Verify.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - домен повинен підтримувати HTTPS.</em>
</p>
<br>
# Створіть Apple Pay Merchant Identity Certificate:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Merchant Identity Certificate натисніть Create Certificate.
## Виконайте дії, описані на сайті Apple, а потім натисніть «Continue».
## Скопіюйте згенерований CSR-файл, вибравши Choose File, а потім Continue.
## Завантажте згенерований сертифікат (merchant_id.cer) і відкрийте його у програмі Keychain Access на комп'ютері Mac.
## У Keychain Access виберіть сертифікат, що імпортується, та експортувати його у формат .p12 (Personal Information Exchange).
## Виконайте команду: openssl pkcs12 -in merchant_id.p12 -out merchant_id.pem -nodes -clcerts
## Скопіюйте створений сертифікат у форматі PEM на сервер. Це буде потрібно для створення [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/requesting_an_apple_pay_payment_session Apple Pay Payment Session] в процесі [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/providing_merchant_validation перевірки магазину].

<br>
==== Технічна інтеграція з ApplePay ====
Для створення сертифікату (-ів) від Партнера потрібні:

# Country Name (2 letter code) [AU]: ?
# State or Province Name (full name) [Some-State]: ?
# Locality Name (eg, city) []: ?
# Organization Name (eg, company) [Internet Widgits Pty Ltd]: ?
# Organizational Unit Name (eg, section) []: ?
# Common Name (e.g. server FQDN or YOUR name) []:?
# Email Address []: ?

Повідомте, чи буде оплата тільки в додатку, або також і на WEB.

Щоб інтегрувати Apple Pay на сайт, дотримуйтесь інструкцій за [https://developer.apple.com/documentation/apple_pay_on_the_web. посиланням]

# Перевірте можливість оплати з Apple Pay. Виконується перевірка, підтримує або браузер оплату з Apple Pay, а також є у Wallet картку, якою можна оплачувати.
<syntaxhighlight lang="markdown" line="1">
if (window.ApplePaySession) {
var promise = ApplePaySession.canMakePaymentsWithActiveCard({YOUR_MERCHANT_ID});
promise.then(function(canMakePayments) {
if (canMakePayments)
});
} else {
}

</syntaxhighlight>
2. Сформуйте структуру платежу для сесії<syntaxhighlight lang="markdown">
document.getElementById("apple-pay-button").onclick = function(event) {
var paymentRequest = {
currencyCode: 'UAH',
countryCode: 'UA',
total: {
label: {PRODUCT_NAME},
amount: {PAYMENT_AMOUNT}
},
merchantCapabilities: ['supports3DS'],
supportedNetworks: ['masterCard', 'visa']
};

var session = new ApplePaySession(3, paymentRequest)

</syntaxhighlight>
3. Відкрити платіжну сесію з Apple, отримати від них paymentData:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/applePay/validateSession</span><syntaxhighlight lang="json" line="1">
headers

--header "Content-Type: application/json"
--header "AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209"
--header "PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760"
--header "PartnerKey: easypay-test"
--header "locale: ua"

body
{
"url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
"merchantIdentifier": "string", /ідентифікатор мерчанту в Apple/
"displayName": "test", /ідентифікатор магазина/послуги/товару (латиниці) ; буде відображатися в toolBar/
"initiative": "web", /Канал оплати/
"initiativeContext": "string" /Доменне ім’я, Доменное имя, пов'язане із сертифікатом Apple Identity/
}

</syntaxhighlight><blockquote>*response з цього методу передається в сесію Apple, після чого при успішній авторизації платежу, повернеться до необхідний для завершення платежу.</blockquote>4. Приклад відповіді ApplePay<syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>5. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token</code> в Easypay ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Перед цим потрібно викликати метод EasyPayApi CreateApp.

'''Приклад запиту createOrder:'''<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{YOUR_MERCHANT_ID}"
}
}

</syntaxhighlight>

== Інтеграція з GooglePay ==
----'''Вимоги'''
# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитися з [https://payments.developers.google.com/terms/sellertos умовами надання] послуг GooglePay.
# Необхідно укласти договір із Easypay.ua.

Google Pay™ - це миттєвий спосіб оплати від Google, який дозволяє просто та швидко сплатити карткою, без необхідності вводити дані для кожного платежу. Ці картки надійно зберігаються в Google. Даний метод доступний для оплати в мобільних програмах на будь-яких пристроях Android і при здійсненні платежу в браузері Chrome.

• '''Документація'''

# [https://developers.google.com/pay/api/android Для додатків]
# [https://developers.google.com/pay/api/web Для веб-сайтів]

• '''Вимоги щодо брендування'''

# [https://developers.google.com/pay/api/android/guides/brand-guidelines Для додатків]
# [https://developers.google.com/pay/api/web/guides/brand-guidelines Для веб-сайтів]

<br>
=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка GooglePay відображається на сторінці оплати EasyPay.

=== Отримання токена GooglePay для оплати ===
----<nowiki>*</nowiki>Використовуйте бойове середовище GooglePay для отримання PaymentData

Для отримання PaymentData. Як параметри скрипта вкажіть:

# Доступні методи платежу: var allowedPaymentMethods = ['CARD', 'TOKENIZED_CARD'];
# Тип токенізації- PAYMENT_GATEWAY: tokenizationType: 'PAYMENT_GATEWAY';
# Параметр gateway: easypay;
# Параметр gatewayMerchantId: Ваш бойовий merchantAccount от Google, який повідомляє в EasyPay.

Якщо з вашого боку інтеграція виконана правильно, Ви на своєму сайті/додатку отримаєте кнопку

Після натискання кнопки на пристрої з підключеним Google Pay з'явиться спливаюче вікно або форма вибору прив'язаної картки.

'''Приклад відповіді від GooglePay Api'''<syntaxhighlight lang="json">
{
"apiVersionMinor":0,
"apiVersion":2,
"paymentMethodData":{
"description":"Mastercard •••• 1164",
"tokenizationData":{
"type":"PAYMENT_GATEWAY",
"token":"{"signature":"MEUCeretMPEQPUMnvMOnDAgZsOLVnFnfjmo5ALe/1D6o7hdzAiEA94L1GfNWW84kbUdHHn+l6B6n18VgIA3sdkPqKL36tqk\u003d","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEem3biYxltOBuMV+Dd9g+ZhV3VEzP2vAlFXvb9tJoYGLtetxDYWTUqnXPvKGDeAnSNrkPo8hu5kLtxN0QXCYkqQ\\u003d\\u003d\",\"keyExpiration\":\"1551385212256\"}","signatures":["MEYCIQD/TWKunZJhG/u3iL2H5P3i9r0rCbpw1/+z9dr/yGytvwIhAPfV2zF5cqP/L+42W+JKv6fgQKBEc67HTtfderefdghJ"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"OidSptk8w+I3FnR1VFmiVswXaZ7ADnmMP1MQelp6GSg0/3aVpAXeLRH/fT1wN7gpxNPy7tFITeQenrJm3QG19tAPuVhcAVM26DMU6LAmZPyPXALktpnYrUj6etCjvWWM/1LkhjDBSjtkmpWRiHIyqj5aud/j8rxFEk06GhwqPWbnJwdCgNf32LJP7bSpUWvHOioaZIV1vdeV6d7iQ6EDWWAS/z9pXWkqpW//M/TVTrcKFXh4C2TI2O+qyBD9VzK3TqU6wS5VsYL69W9/4xzV5L5irpp/wzNfPHkJd8QIwcsIPuNWBtGm3v+JCaqIA3oK9Sw/5o/gZp/pnOhUdax0VjGEvmbGXs2+ufBChCkh+/BpobbpzVS9T/DZSlUO2FLANMjSaEQzh74ymtDgP4x9O64RAdySW+V7lVZMa7FVZ3PFnTfa8W89pzIgo6ocSGHQPBFnExTmSbDpUU0L12wzHkAcZSyngPAljqg\\u003d\",\"ephemeralPublicKey\":\"BBKgbSbykNy1111QYRmGJEhnCorkt+VoDYlYbAlg0a5WO2uV/M50XqOSG0uxWAvUqrZolQuEX6yZ+dvvufLEZtI\\u003d\",\"tag\":\"p9ItvOfsQVTzhTPHq6ycYjKX1TtozP/yym4QWWVRVCk\\u003d\"}"}"
},
"type":"CARD",
"info":{
"cardNetwork":"MASTERCARD",
"cardDetails":"1164",
"billingAddress":{
"phoneNumber":"+380 93 000 00 11",
"address3":"",
"sortingCode":"",
"address2":"",
"countryCode":"UA",
"address1":"ул. ",
"postalCode":"49107",
"name":"Super 1",
"locality":"Київ",
"administrativeArea":"Київська область"
}
}
},
"email":"test@easypay.ua"
}

</syntaxhighlight>

=== Передача токена для оплати ===
Надішліть дані з поля token з відповіді від '''GooglePay Api''' у поле '''userPaymentInstrument/token''' у Easypay (розділ [[MerchantAPI#Створення замовлення|Створення замовлення]])

Перед цим потрібно викликати метод '''EasyPayApi [[MerchantAPI#Реєстрація точки та створення сесії|createApp.]]'''

'''Приклад запиту'''
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span><syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210000-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"GooglePay",
"token":"{\"signature\":\"MEQCIFTFadYw15Cqfk7+YiM9pp5zEvyTI7oWVZCNFKr1cMthAiAFMv+nt0PWOEhj6LmmMNTByP9E4OhGrSoE7rDvzLDIZw\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEsrkMsOBN8N0xL8AsTVUIETODhCva5PpGFxvPm56pWmI5MG2HKKHXjsdhdvcP6N3d40x90E0rZzDrxBC2ywERXg\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1618591579000\\\"}\",\"signatures\":[\"MEUCIHX0SawuKctPUEjdFu2sDiE81aSSdf8i0KNvdg1dlsWoAiEAye8TEWpPk4sp7EjTovN7DichK6YxY1DajYN9/ArHDYI\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"vlLmhIBndM4a/GWFsvbFZrZOygjAwUao/NlvlJlhAQ3kdprI3gubAcQxAau8L74dkzGJh8w7AD2E77XOHycdwG91NUvsJ0xiXuMCXHJ9NPMhp7k49OUIJjOpJG+RqUM9/SPBgx69eDD7skhG+axZYr/m36LFjIlk5WhmumQgIrfojm02uRm0nOcZ2wbvrwQKZyL1IeTv/txqcYMuQqYWzs/FPkIEbiQ80z6dRhVszrEXcHLKcfBmNmcn/Vk90ArXCotOD52V0JS/Q+Mf9mCoe9G2bABo9R9PAYT/FrKIEOQEhzLCI7m4/vyIlCMf69d6PjigP3AOGxykbS0Kvsxqoh+HYRFCSLCd+8O2Us2wCYD09/OBqcQi78/fs2vwyg4nrWQQJ6ZGwTKHHxVRY8VGAUUnMFr18HPsN1BQNuz08M4t6Qx6X0nEZ3hseSIcUMVcBm+NyvL2T/XSWqTh2poDuQ4B+UJ59gMrsPapzouxk2iC/+vS1Bs/2sSf77Nsqr7BhE7SMgnZ/a2LF+Shx2aOKSIGflMz+MjVSzpMg2AUh43pbcsi8g\\\\u003d\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BDJpYzoN9XPVKrHIxwNes83HbR0/AOUPpQgAwi3fTzR+TIB8/VAc9CdI9guWX8Pjvii/T+WxwcByuo9pzJC7518\\\\u003d\\\",\\\"tag\\\":\\\"LFOOTwd5Crtn60KnT0J6MHuFlGE0+EYL3D7IrWrPsRA\\\\u003d\\\"}\"}",
}
}

</syntaxhighlight>

== Створення підпису ==
----Формування підпису Sign (основний варіант для POST – запитів)<syntaxhighlight lang="text">
Sign = base64(sha256(secretKey + requestBody))

</syntaxhighlight>'''Де:'''
* <code>secretKey</code> – секретний ключ.
* <code>requestBody</code> – тіло запиту у форматі JSON (ідентичне формату EasyPay).
<br>

=== Приклади коду ===
----'''C#'''

<code>Convert.ToBase64String(SHA256.Create().ComputeHash(Encoding.UTF8.GetBytes(data)))</code>

'''PHP'''

<code>base64_encode(hash('sha256', ($secretKey.$requestbody), true))</code>

<br>
== Можливі варіанти інструментів оплати ==
----

===== Оплата <span style=" display: inline-block; padding: 4px 16px; border: 2px solid #0033A0; /* Темно-синій колір рамки */ background-color: #0033A0; /* Темно-синій фон */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ ">VISA</span> <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid transparent; /* Прозора рамка для градієнту */ background: linear-gradient(to right, #FF5F00, #FFBF00); /* Градієнт від червоного до оранжевого */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">MasterCarD</span> =====
<syntaxhighlight lang="json" line="1">
"paymentInstrumentsTypes": [
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 200,
"additionalParams": {}
}
]
]
},
{
"instrumentType": "RCard",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>
===== Мобільні гроші <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #00A3E0; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #00A3E0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Київстар</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #F7E300; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #0033A0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Lifecell</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #E60012; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #E60012; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Vodafone</span> =====

<syntaxhighlight lang="json" line="1">
{
"instrumentType": "KSMoney",
"commission": 0.0,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4958975,
"instrumentType": "KSMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.0,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 1,
"additionalParams": {}
}
]
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 6000.00,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]

</syntaxhighlight>

===== Картки лояльності <span style=" display: inline-block; padding: 8px 20px; border: 2px solid #FF0000; /* Червона рамка */ background-color: #FF0000; /* Червоний фон */ color: white; /* Білий текст*/ font-family: Arial, sans-serif; /* Шрифт Arial */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Розмір шрифта */ ">Fishka</span> =====
<syntaxhighlight lang="json" line="1">
]
},
{
"instrumentType": "FishkaB2B",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},
{
"instrumentType": "FishkaB2C",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>

===== Оплата <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #000000; /* Темно-синій колір рамки */ background:FFFFFF ; /* Темно-синій фон */ color: #000000; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">ApplePay</span> <span style=" display: inline-block; padding: 8px 20px; border-style: solid; border-width: 4px; border-color: #4285F4 #EA4335 #FABB05 #34A853; /* Чітке розмежування кольорів */ background-color: #FFFFFF; /* Білий фон всередині */ color: #000000; /* Колір тексту */ font-family: Arial, sans-serif; font-weight: bold; text-transform: uppercase; font-size: 16px; border-radius: 24px; /* Закруглені краї */ ">GPAY</span> =====
<syntaxhighlight lang="json" line="1">
{
"instrumentType": "ApplePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958126,
"instrumentType": "ApplePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"instrumentType": "GooglePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958137,
"instrumentType": "GooglePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams":
{
"PublicKey": "BKdzipvJvJzcbTMm3dO0LEh1AXFr8qfSiPjwrI7vv9F6hqhDJB1M="
}
}
]
}
]

</syntaxhighlight>

=== Управління інструментами оплати ===
----Управління інструментами оплати на сторінці оплати EasyPay здійснюється при створенні замовлення. Параметр <code>allowedInstruments</code> визначає, які інструменти оплати будуть відображатися на сторінці платіжного шлюзу.
<br>
<syntaxhighlight lang="json" line="1">
"userInfo": {
"phone": "string"
},

Обов'язкові параметри:
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)
"allowedInstruments": [ "string" ]
</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>allowedInstruments</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр в якому передаються інструменти оплати, які будуть відображені на сторінці </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* RCard
* Card
* EBank
* FishkaB2C
* ApplePay
* GooglePay</td>
</tr></table>
'''<br>
Поведінка системи'''
# '''Якщо параметр''' <code>allowedInstruments</code> '''не передано або він порожній''': На сторінці оплати будуть відображені всі доступні інструменти, які підключені для партнера.
# '''Якщо з переданих інструментів немає доступних для оплати''': Повертається помилка: <code>PAYMENTINSTRUMENT_NOT_FOUND</code>
# '''Приклад помилки''': У разі, якщо у партнера активні ApplePay і Card, а в запиті передається GooglePay, повертається помилка <code>PAYMENTINSTRUMENT_NOT_FOUND</code>.
# '''Якщо передані доступні інструменти оплати''': У разі, якщо партнер передає, наприклад, GooglePay та Card, але GooglePay не активний для цього партнера, система поверне посилання з активним інструментом Card.
<br>

== Технічна підтримка ==
----За потреби консультацій з питань реалізації API можна написати запит на ''merchant.api.support@easypay.ua''

MerchantAPI

2025-05-16T14:18:44Z

Vadim.fedorchuk: додав тест карти

== Загальні відомості ==
----Протокол призначено для торговців, які є одержувачами платежів. Продавець підписує договір про прийняття платежів або анкету-акцепт до публічної оферти.

Щоб отримати платежі, ви можете використовувати web, мобільні версії сайтів, а також мобільні програми. У разі використання цього протоколу не здійснюється перевірка даних для ідентифікації замовлення або облікового запису. EasyPay завжди приймає дані, надіслані та створені продавцем.

=== Заголовки запитів ===
----

Для надсилання запиту та отримання відповіді у форматі JSON, необхідно передати такі обов’язкові заголовки у запиті.<syntaxhighlight lang="jsonml+bst" line="1">
--header 'Content-Type: application/json'

--header 'AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209'

--header 'PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760'

--header 'PartnerKey: easypay-test'

--header 'locale: ua'

--header 'Sign: bS+vPOwu1Sif1Iz47Cdh+z1RAi0s6X21C3uU0YNBNWE='
</syntaxhighlight>

=== URL ===
----<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Посилання</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>

<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>https://merchantapi.easypay.ua</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Production</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">в т.ч. для надсилання тестових запитів</td>
</tr>
</table>

<br>
=== Налаштування безпеки ===
----Партнер надає IP, з яких будуть здійснюватися запити.
<br>
<br>
=== Реєстрація партнера в системі EasyPay ===
----Реєстрація нового торговця передбачає отримання унікального ідентифікатора '''PartnerKey'''.

===== Характеристика параметрів реєстрації =====
<div style="overflow-x: auto; display: block; width: unset !important; height: auto !important; border: none;">
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор партнера (продавця) у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор сервісу торговця у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>SecretKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">секретний ключ для формування підпису</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>
<br>

=== Тестові параметри ===
----Для тестових запитів використовуються такі параметри:<br><syntaxhighlight lang="pl">
PartnerKey = easypay-test
ServiceKey = MERCHANT-TEST
SecretKey = test

</syntaxhighlight>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
На даний момент відсутня можливість тестування з використанням фейкових оплат / тестових карток.
Платежі тільки реальні, їх можна відмінити в день оплати методом
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">cancelOrder</span>
([[MerchantAPI#Скасування платежу|Скасування платежу]])
</p>

===== Тестове середовище =====

Перед початком використання тестового середовища необхідно надати ір з яких будуть надходити запити, для відкриття доступу. На тестовому середовищі використовуються методи аналогічні Merchant Api.

'''Тестові дані:'''

* PartnerKey:credit-test
* SecretKey: credit-test

* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-TO-CARD - виплата
* Надсилання колбеків з Iр: 195.230.131.50 <br>
<br>
'''Тестові картки для верифікації/виплат:'''

Код підтвердження для 2дс при верифікації картки: 123456

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5167803258208169</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4235751329985326</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4111111111111111</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна без створення транзакції
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4999999999990011</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата з затримкою статусу 5 хв</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4217198608967728</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата з затримкою статусу 5 хв
</td>
</tr></table>
<br>
'''Тестові картки для оплати:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5168752081922117</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0128/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4909150002132451</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0129/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна 2ДС оплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>4300380058021820</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0130/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Не успішна з 3ДС + помилка PAYMENT_ALFABANK_116
</td>
</tr><tr><td><code>'''5567217349220669'''</code></td><td>0130/111</td><td>Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td></tr></table>
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
У разі отримання помилки <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">APPID_NOT_FOUND</span>
у відповідь на будь-який метод, необхідно повторити запит
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">createApp</span>
до отримання точки ІД.
</p>
<br>

== Основні запити/відповіді ==
<hr color="#d3d3d3" size="1" noshade>

=== Реєстрація точки та створення сесії ===
Цей метод слід викликати, коли користувач вперше звертається до платіжної сторінки. Якщо браузер або пристрій змінюються, метод знову з'являється
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createApp</span>
</p>
'''Request'''<syntaxhighlight line="1" lang="json">
headers:

"PartnerKey": "partnerName",
"locale": "ua"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json-object" line="1">
body:

{
<br>
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": "https://cdn.easypay.ua/hint_images/",
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "f3f2b678-a3c4-45ba-a865-a136fe4a62bd",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> '''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>

<br>
=== Створення сесії ===
----Даний метод створює новий екземпляр сеансу для користувача , <code>PageId</code>.
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createPage</span>
</p>'''Request'''<syntaxhighlight line="1" lang="json">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": null,
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "29bd7237-6b8d-4048-b028-6efc23d05988",
"requestedSessionId": "fa3595d3-52de-4744-9fc6-ec2d3507d5a5",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">За замовчуванням, якщо не було активності за запитами, час життя PageId - 20 хвилин. З кожним запитом життя PageId автоматично продовжується.</td>
</tr>
</table>
<br>

=== Створення замовлення ===
----Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Для кожного нового запиту <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">CreateOrder</span> потрібно використовувати унікальний <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">PageID</span>.
</p>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/createOrder</span>
</p>

</p><syntaxhighlight lang="markdown" line="1">
headers

'Content-Type': 'application/json'
'PartnerKey': 'partnerName'
'locale': 'ua'
'AppId': 'a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId': '2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign': 'e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

<br>
</syntaxhighlight><syntaxhighlight lang="json" line="1">
{
"userInfo": {
"phone": "string"
},
Обов'язкові параметри:

"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)

Необов'язкові параметри:
"paymentOperation":"PaymentTokenization",
"additionalItems": {},
"expire": "2019-04-15T07:49:20",
"isOneTimePay": true,
"fields": [
{
"fieldName": "string",
"fieldValue": "string",
"fieldKey": "string",
}
]
},
"urls": {
"success": "string",
"failed": "string",
"back": "string",
},
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string",
"id": "string"
},
"narrative": {
"name": "string"
}
},

"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string”
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true
}
]
},
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid",
"pan": "string",
"expire": "MM/YY",
"cvv": "string",
},
"partnerInfo": {
"id": "string",
"name": "string",
"account": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги мерчанта (видає EasyPay)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>description</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення (до 120 символів)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення, роздільник - точка </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип платіжного процесу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* '''PaymentTokenization -''' використовується для токенізації картки, якою буде сплачено це замовлення.
* '''Працює лише для інструмента “карта”'''. Повинен бути заповнений ідентифікатор клієнта '''"userInfo": { "phone": "string"}'''
* Якщо передано URL для колбеку, то після успішної оплати відправляється колбек про платіж та колбек про токенізацію (приклади колбеків про оплату - в [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]], про [[MerchantAPI#Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна)|токенізацію]].
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>userInfo/phone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер телефону (або ідентифікатор) клієнта </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Номер телефону необхідний:

* для отримання списку карток MasterPass гаманця
* для отримання списку токенізованих карток (інформація буде в масиві StoredCards)
* при оплаті із зазначенням токена картки
* для токенізації картки після успішної оплати разом із параметром
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>expire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення заданого часу замовлення сплатити неможливо. Час життя сторінки може відображатися на платіжній сторінці у вигляді таймера (за замовчуванням таймер вимкнено). Значення має бути більшим за поточний час на 6 хвилин.
'''Значення за замовчуванням - 3 дні'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>sOneTimePay</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">включає можливість успішно оплатити замовлення лише 1 раз за конкретним forwardUrl </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Значення:

* True - за замовчуванням;
* False - оплатити замовлення по тому самому ''forwardUrl'' можна буде кілька разів;</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>urls</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
*'''back -''' URL для повернення на вказану сторінку з фінальної сторінки успіху EasyPay.
* '''success -''' URL сторінки успіху, для редиректу клієнта у разі успішної оплати.
* '''failed -''' URL сторінки помилки для редиректу клієнта у разі неуспішної оплати</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''back -''' На фінальній сторінці EasyPay вгорі зліва з'явиться кнопка “Повернутись назад” з посиланням на вказану URL-адресу. Параметр не може бути порожнім і повинен відповідати формату URL.
* '''success''' - у разі, якщо не було передано urls{success,failed} для редиректу після оплати. Після оплати клієнт може не дочекатися редиректу на цей url, тому редирект не можна використовувати як індикатор успішної оплати, отримання оповіщення про успішний платіж - '''див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
* '''faild -''' приклад get-параметрів, які приходять на '''url.failed та url.succes''' (те ж, але без ''errorCode''):

<code>?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=</code>

<code>Тестове+описання+замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&''errorCode=PAYMENT_ALFABANK_-2006''&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</table>

<br>
===== Необов'язкові додаткові поля =====
'''<code>additionalItems</code> –''' необов'язкові додаткові параметри, наприклад:
<br>
<syntaxhighlight lang="json" line="1">
"additionalItems":{
"PayerEmail":"client@i.ua",
"PayerPhone":"380930007603",
"Merchant.UrlNotify":"https://notify.url",
"Merchant.Param1":"CustomValue",
"CurrencyAmountLabel":"123.56$"
},
</syntaxhighlight>'''Опис параметрів<br>'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerEmail</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">емейл клієнта для оповіщення його у разі неоплаченого замовлення та для автоматичного заповнення поля “Надіслати квитанцію на email” на сторінці оплати. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається – він не може бути порожнім і має відповідати формату email.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerPhone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">телефон клієнта, на який протягом 15-20 хв після виклику CreateOrder відправиться нагадування про неоплачене замовлення (смс або вайбер). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається, він не може бути порожнім і повинен відповідати формату телефону.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.UrlNotify</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL для надсилання нотифікації за успішним платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Параметр не може бути порожнім і має відповідати формату URL.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.Param1</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">індивідуальний параметр партнера Param1 узгоджується з EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>
</table>

<br>
'''<code>reccurentPayment</code> -''' інформація для створення рекурентного платежу на основі поточного. Рекурентний платіж буде створений за розкладом, якщо основний платіж виконаний за допомогою інструментів card, Rcard, Vcard, LifeMoney
<br><syntaxhighlight lang="json-object" line="1">
"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>cronRule</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">правило у cron-форматі, з якою періодичністю повторювати рекурентний платіж, наприклад 10 20 15 * * (кожного 15 числа місяця о 20:10). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо ця властивість порожня, значить рекурентний платіж виконуватиметься на вимогу продавця.
'''Плануйте перше виконання рекуренту щонайменше 20 хвилин від дати успішного платежу.'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateExpire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата, після якої не проводити рекурентний платіж.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateRun</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата першого запуску рекурентного платежу (опціонально). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо не заданий, перший запуск розраховується за '''recurrent/cronRule'''
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>properties</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри (опціонально) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''reccurent/properties/amount -''' сума кожного рекурентного платежу, наступного після основної оплати (опціонально)
* '''reccurent/properties/failedCount -''' ккількість поспіль неуспішних викликів рекурентних оплат, після чого рекурентний платіж видаляється (опціонально). За замовчуванням - 4 спроби: при неуспіху - повторюється спроба кожні 20-30 хвилин, 4 неуспішних спроби поспіль по одному recurrentId - і рекурент відключається. Якщо після 3 неуспішних спроб була 1 успішна, то лічильник неуспішних для цього рекурента скидається.
* '''reccurent/properties/failedRule -''' cron-правило (період) повтору при неуспішному виклику рекурента (опціонально)
* '''reccurent/properties/UrlNotify''' - URL для надсилання нотифікації за успішним '''рекурентним''' платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
</td>
</table>
<br>
'''<code>bankingDetails</code> -''' передача банківських реквізитів для перерахування коштів у випадку, якщо банківські реквізити можуть змінюватися щодо різних платежів одного сервісу продавця. На стороні EasyPay має бути увімкнено режим "Отримувати реквізити із запиту".
<br>
<syntaxhighlight lang="json" line="1">
{
"bankingDetails": {
"payee": {
"id": "123664578",
"name": "департамент патрульної поліції",
"bank": {
"name": "пат пумб",
"mfo": "330556",
"account": "123654778889"
}
},
"payer": { "name": "Иванова Мария" },
"narrative": { "name": "Переказ коштів згідно договору з ФК № 111/11-П від 11.11.1111 р. за виключенням винагороди за їх переказ згідно реєстру від [work_date]р." }
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/ID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">код одержувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">ЄДРПОУ або ІПН</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">одержувач </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банк отримувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Mfo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">МФО банку </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">може не заповнюватися, якщо Payee/Bank/Account містить IBAN</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Account</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">р/р одержувача або IBAN </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payer/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">платник </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Narrative/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">призначення платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 157 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">повну структуру bankingDetails можна не передавати, для цього достатньо передати </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">

ідентифікатор банківських реквізитів із довідника, який узгоджений із конкретним партнером та перебуває в системі EasyPay.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">

</td>
</table>

'''Splitting''' - інформація щодо сплітування (розщеплення) платежу.

Частина загальної суми з order/amount розподіляється відповідно до інформації в splitting/items/value, а залишок - йде на основні реквізити з bankingDetails (або bankingDetailsId). На стороні EasyPay має бути увімкнено режим “Отримувати реквізити із запиту

Структура '''items''' це масив. Основний платіж буде розщеплений стільки платежів, скільки міститься у цьому масиві плюс залишок. Кожен розщеплений платіж буде надіслано на відповідні банківські реквізити <code>items/bankingDetails</code>. Залишок коштів буде надіслано на реквізити основного платежу з <code>BankingDetails</code> або <code>bankingDetailsId,</code> які потрібно обов'язково вказувати під час сплітування.
<br>
<syntaxhighlight lang="json" line="1">
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string"
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>

 <tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор послуги, за якою ініціюється зарахування спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/orderId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор внутрішнього замовлення Мерчант для маркування конкретного спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/bankingDetails</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банківські реквізити кожного розщепленого платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/unit</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">може бути '''Amount''' (сума розщепленого платежу в грн.) або '''Percent''' (сума розщепленого платежу вважається відсотком від загального). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/value</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">значення у цифрах. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/withCommission - true/false</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Вказує з якого з одержувачів слід утримати внутрішню комісію. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Сума комісії розраховується із загальної суми платежу, а утримується - з першого одержувача зі '''splitting,''' у якого '''withCommission=true'''. Якщо ні в кого з '''splitting''' не зазначено '''withCommission=true''', то комісія втікає з “основного” одержувача, вказаного в bankingDetails.
Якщо у всіх значення '''withCommission=false''' (або не передали), то комісія утримається з "основного одержувача", вказаного в параметрі '''bankingDetails'''

Якщо всі значення '''withCommission=true,''' то комісія утримається з першого одержувача, зазначеного в splitting. Залишок буде надіслано на реквізити основного платежу з '''bankingDetails''' або '''bankingDetailsId.'''

При встановленому сервісом Типі розрахунків “За актами", одержувачам перераховується повна сума, без відрахування комісії, незалежно від значення WithComission.
</td>
</tr>

</table>
<br>

Після виконання сплітування під кожен спліт (частини) платежу на стороні EasyPay створюється фінансова транзакція з унікальним transactionID.
<br>
* Якщо списання грошей з картки пройшло успішно і всі реквізити для спліту вказані корректно (доступні) - всі транзакції набувають успішного статусу і по кожній транзакції відправляється колбек.
* Якщо списання грошей з картки пройшло неуспішно – запит відхиляється з кодом фінансової помилки;
* Якщо списання грошей з картки пройшло успішно, але хоча б один із реквізитів зазначено неправильно – всі транзакції спліту (частини) платежу – будуть відхилені.
<br>
Після проведення успішного списання та сплітування по кожній фінансовій транзакції в рамках спліту направляється колбек (нотифікація) про успішний платіж. Приклад коллбека (нотифікації) вказаний у [[MerchantAPI#Повідомлення про платіж|повідомлення про платіж]]'''''.'''''

<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Якщо параметр <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">userPaymentInstrument</span> не є порожнім, створення платежу буде відбуватися автоматично.
</p>

Для різних інструментів передаються такі параметри:

'''userPaymentInstrument –''' інструмент оплати.

'''*Картка (PCI DSS)'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "Card",
"pan": "5168123456780123",
"expire": "MM/YY",
"cvv": "string" }

</syntaxhighlight>

'''*Токенізована Карта'''<syntaxhighlight lang="json" line="1">
{"userInfo":{"phone":"380935207603"}, /Phone,під яким токенізована карта/
…
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid", /токен картки/
}
}

</syntaxhighlight>
'''MasterPass'''<syntaxhighlight lang="json">
{"userInfo":{"phone":"380935207603"}, /телефон реєстрації гаманця MasterPass/
…
"userPaymentInstrument": {
"instrumentType": "MasterPass",
"alias": "string",/Аліас карти в гаманці MasterPass/
}
}

</syntaxhighlight>
'''Kyivstar Money/Life Money /VodafoneMoney'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "KSMoney / LifeMoney / VodafoneMoney",
"phone": "380xxYYYYYYY" }

</syntaxhighlight>'''ApplePay/GooglePay'''
<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "ApplePay / GooglePay",
"token": “string”/Токен, отриманий від Apple | Google /
}

</syntaxhighlight>

* '''partnerInfo –''' інформація про партнера
* '''partnerInfo.name –''' найменування партнера
* '''partnerInfo.id –''' ВД (ЄДРПОУ) партнера
* '''partnerInfo.account –''' рахунок партнера (особовий рахунок/IBAN…)

*

<br>

==== Параметры BrowseInfo при 3DS оплаті ====
У зв'язку з переходом банків - екваєрів на модель роботи 3D Secure 2.x, при створенні замовлення з одночасною передачею інструменту оплати в запиті (карта, токен карти, токен Apple / Google Pay), необхідно передавати додаткові параметри пристрою (браузера) клієнта в заголовках і в тілі запиту createOrder, у прикладі вони виділені:
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p><syntaxhighlight lang="json" line="1">
headers:
[ "appId: b15c4b64-8964-4c80-852e-df59a0e0d9b6",
"pageId: 607514b8-1da5-490a-bdf3-0c6883131625",
"partnerKey: easypay-test",
"sign: XJ3roGhTLwAZXigBp/iVRdsXlZYdTSen3xSM+29GaRg=",
"Content-Type:application/json",
"AcceptHeader:*/*",
"User-Agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"
]

body:
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_3ds2x",
"additionalItems":{
"Merchant.UrlNotify":"http://url.noti.fy"
},
"description":"Easy test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"Card",
"pan":"4444444444444444",
"expire":"0599",
"cvv":"123"
},
"browserInfo":{
"colorDepth":"24",
"screenHeight":"824",
"screenWidth":"1536",
"language":"uk-UA",
"javaEnabled":"false",
"javascriptEnabled": "true"
"timeZone":"-180"
}
}

</syntaxhighlight>'''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AcceptHeader:*/*</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте без змін</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>User-Agent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте клієнтський User-Agent </td></tr></table>

'''Приклад, як збирати дані на JS:'''<syntaxhighlight lang="markdown" line="1">
getBrowserInfo() {
let browserInfoModel = {};
browserInfoModel.colorDepth = window.screen.colorDepth.toString();
browserInfoModel.screenHeight = window.screen.height.toString();
browserInfoModel.screenWidth = window.screen.width.toString();
browserInfoModel.language = window.navigator.language;
browserInfoModel.javaEnabled = window.navigator.javaEnabled();
browserInfoModel.timeZone = (new Date()).getTimezoneOffset().toString();
return browserInfoModel;
}

</syntaxhighlight>Якщо все передано правильно, то отримайте відповідь як нижче у прикладі '''"Якщо передано userPaymentInstrument (для випадку з 3DSecure)",''' або помилку оплати з картки, наприклад, "Недостатньо коштів".

У випадку, якщо додаткові параметри передані неправильно, отримайте помилку платіжного сервісу, наприклад:<syntaxhighlight lang="markdown">
"errorCode":"PAYMENT_PUMB_SERVICE_FAILURE",
"errorMessage":"Технічна помилка екваєра. Зверніться до служби підтримки EasyPay, або спробуйте пізніше"

</syntaxhighlight>'''Відповідь (RESPONSE)''':<syntaxhighlight lang="json" line="1">
header:
відсутній

body:
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},

{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b,
"error": null,
}

Якщо передано userPaymentInstrument (для випадку з 3DSecure):
{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form action='https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type='hidden' name='PaReq' value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":860094566,
"retrievalReferenceNo":null,
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів які не мають сертифікатів PCI DSS для обробки карткових даних. Або якщо партнер не має платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">на сторінці оплати можемо відключати елементи інтерфейсу:
- логотип EasyPay можемо приховувати

- лічильник часу, що залишився до оплати, може бути відображений/прихований

- поле "Призначення" (можемо вимкнути, або за замовчуванням зробити відкритим/закритим)

- рядок з логотипом партнера та назвою можемо приховати

- поле введення імейл сховати / відобразити

- рядок з "Номер замовлення" приховати/показати
</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструменти '''Emoney''', vcard та '''RCard''' видаємо тільки для користувачів, які авторизовані в системі EasyPay. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType'''
* Emoney – гаманець EasyPay
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
* ApplePay – оплата через ApplePay
* GooglePay – оплата через GooglePay
* MasterPass – гаманець MASTERPASS
* QrMasterpass
* LifeMoney – мобільні гроші Лайф.
* KsMoney – мобільні гроші Київстар
* VodafoneMoney – мобільні гроші Водафон
* картки лояльності Fishka
</td>
</tr>
<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>masterPassWalletStatus</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус гаманця MASTERPASS. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення див. у [[MerchantAPI#Створення замовлення на перекази між картами|Створення замовлення на перекази між картами]]
</td>
</tr>
<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>masterPassCommission</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">розмір комісії при оплаті MASTERPASS. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType'''
* Emoney – гаманець EasyPay
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
* ApplePay – оплата через ApplePay
* GooglePay – оплата через GooglePay
* MasterPass – гаманець MASTERPASS
* QrMasterpass
* LifeMoney – мобільні гроші Лайф.
* KsMoney – мобільні гроші Київстар
* VodafoneMoney – мобільні гроші Водафон
* картки лояльності Fishka
</td>
</tr>

</table>

'''3DSecure / mobile payments case:'''<syntaxhighlight lang="json">
Якщо передано userPaymentInstrument (для випадку з 3DSecure):

{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form" action="https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type="hidden" name="PaReq" value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":"860094566",
"retrievalReferenceNo":"null",
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>

<br>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Confirmed''' - платіж підтверджений (кінцевий статус, якщо "status": "done")
* '''WaitConfirm''' - платіж у статусі "обробляється", необхідно додатково запросити фінальний статус платежу
* '''WaitVerify''' - від клієнта очікується підтвердження (наприклад, якщо "status": "Need3Ds" - необхідно пройти перевірку 3D Secure) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Done''' - додаткові дії не потрібні, якщо при цьому "зберіганнядержави":"затверджено", означає платіж повністю успішний. При іншому значенні paymentState- платіж не прийняв кінцевий статус, необхідно запросити статус ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]).
* '''Need3Ds''' - необхідно підтвердження 3D Secure від клієнта ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedConfirmCode''' - необхідно надіслати код перевірки зі смс методом confirmCodeVerification ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedLookup''' - необхідно надіслати код перевірки з смс '''''методом confirmCodeVerification ('''''[[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]]) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionType</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип наступної дії:

* '''"FormRedirect"''' - необхідно створити сторінку (форму) з html-коду, який передано у параметрі "actionContent" :'''"<html>...</html>",''' відкрити її клієнту, наприклад, для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl".'''
* Після проходження перевірки клієнт буде передресовано на фінальну сторінку EasyPay або на

<code>"urls": {</code>

<code>"success": "string",</code>

<code>"failed": "string"</code>

<code>}</code>

* '''"UrlRedirect"''' - переадресувати клієнта на посилання з "action" або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".'''
* '''"ConfirmCode"''' -необхідно надіслати код перевірки з смс методом '''confirmCodeVerification''' ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])

'''"None"''' - можливий при використанні інструменту гаманець '''("instrumentType": "EMoney"),''' кошти успішно списані з гаманця, партнеру надсилається повідомлення про списання. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"<html>...</html>"''' - html форма сторінки банку для введення коду 3DS. Сформувати сторінку з коду та відкрити її клієнту. Після підтвердження платежу відбудеться 302-й редирект на ваші "urls" із запиту createOrder, або на фінальну сторінку EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції в EasyPay </td></tr></table>

'''<br />2DSecure case:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Confirmed"''' та '''"status": "Done"''' - платіж пройшов успішно. При інших значеннях необхідно перевірити статус '''''платежу''''' '''('''[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]''')''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Done" -'''платіж завершено, додаткові дії не потрібні. При '''"paymentState":'''

* '''"Confirmed"''' - означає, що транзакція на стороні EasyPay прийнята (http - оповіщення успішно доставлено партнеру) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції до EasyPay </td></tr></table>

<br>
==== Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки ====
----У випадку "<code>actionType</code>": "<code>ConfirmCode</code>", клієнту прийде код підтвердження, який потрібно передати до EasyPay
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/confirmCodeVerification</span>
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"code": "string"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{ }
</syntaxhighlight>Якщо "status":"Need3Ds", то клієнту потрібно пройти 3DS перевірку в залежності від значення '''"actionType".'''
<br>
'''Опис параметрів:''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>FormRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно СТВОРИТИ сторінку (форму) з html-коду, який передано у параметрі </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">"<html>...</html>", відкрити її клієнту для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl"''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>UrlRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно переадресувати клієнта на посилання з '''"action"''' або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".''' Відобразиться форма банку емітента картки для перевірки 3D Secure. Після введення коду клієнта переадресує на сторінку успіху чи помилки. Адреси сторінок передаються на етапі створення замовлення.

<code>"urls": {</code>

<code> "success": "string",</code>

<code> "failed": "string"</code>

<code>}</code> </td></tr></table>

<br>

==== Перевірка статусу платежу ====
----

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/orderState</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers:
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20240524-0015",
"transactionId":"1413668587"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers:
відсутній

body:
"merchantKey":"easypay-test",
"transactionId":1413668587,
"orderId":"test_20240524-0015",
"amount":3.000000,
"paymentState":"declined",
"refundTransactionId":1413673292,
"":
"paymentsList":[

],
"refunds":[
{
"refundTransactionId":1413669380,
"paymentState":"accepted",
"refundAmount":1.10,
"dateAccepted":"2024-05-24T16:14:45+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:14:39+03:00"
},
{
"refundTransactionId":1413673292,
"paymentState":"accepted",
"refundAmount":1.90,
"dateAccepted":"2024-05-24T16:19:40+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:19:33+03:00"
}
],
"error":null
}

</syntaxhighlight>
'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;"></th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Фінальний'''
'''статус?'''</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Значення/ подальші дії'''</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accepted</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"> '''так'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж прийнято</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>declined</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">так</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж відхилений
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pending</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ні</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж знаходиться в обробці, необхідно повторити запит статусу пізніше
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>none</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">- </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">статус платежу не визначено, необхідно повторити запит статусу до отримання кінцевого статусу</td>
</tr></table>

'''Нетипові відповіді запит статусу:'''

* Якщо платіж не знайдено, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"error":{
"errorCode":"MERCHANT_ORDERID_NOT_FOUND",
"title":null,
"description":null,
"errorMessage":"MERCHANT_ORDERID_NOT_FOUND",
"fieldErrors":[ ]
}

</syntaxhighlight>

* Якщо платіж (сторінка, замовлення) не були відкриті клієнтом або не було спроби оплати, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId2",
"amount": 0,
"paymentState": "pending",
"refundTransactionId": null,
"paymentsList": [],
"error": null
}

</syntaxhighlight>

* Якщо отримано помилку на замовлення на етапі визначення реквізитів:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId",
"amount": 0,
"paymentState": "declined",
"refundTransactionId": null,
"paymentsList": [],
"error": {
"errorCode": "PROVIDER_ACCOUNT_INVALID", (ерор код може (має) відрізнятися від того, що в прикладі)
"title": "Помилка системи",
"description": "Акаунт не знайдено",
"errorMessage": "string"
}
}

</syntaxhighlight>

При виконанні запиту статусу на замовлення, у яких є спліт (платіжна опція) - повертається наступна модель:

'''Request:'''<syntaxhighlight lang="json" line="1">
headers:

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"easypay-test",
"orderId":"full_split_11",
"transactionId":""
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey": "easypay-test",
"transactionId": 991379504,
"orderId": "full_split_11",
"amount": 3.150000,
"paymentState": "accepted",
"refundTransactionId": null,
"paymentsList": [
{
"merchantKey": "easypay-test",
"transactionId": 991379509,
"orderId": "full_split_11",
"amount": 1.030000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379508,
"orderId": "full_split_11",
"amount": 0.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379507,
"orderId": "full_split_11",
"amount": 1.020000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379506,
"orderId": "full_split_11ID",
"amount": 1.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
}
],
"error": null
}

</syntaxhighlight>

'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentsList</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список платежів у структурі спліту з деталізацією. </td></tr></table>

У випадку зі сплітованими платежами, в основному тілі відповіді '''OrderState''' - параметру '''transactionId''' присвоюється внутрішній технічний номер (нефінансової) операції.<syntaxhighlight lang="json" line="1">
"urls": {
"success": "string",
"failed": "string"
}

</syntaxhighlight>

==== Скасування платежу ====
----Метод викликається '''лише''' для платежів у статусі '''"accepted".''' Для успішного скасування має бути достатньо суми прийнятих платежів у день скасування. Можна скасовувати платежі, які не старші 30 днів. Успішне повернення після цього терміну – не гарантується, залежить від умов банків-еквайєрів.

Повернення суми на картку відбувається в строк 0-3 робочих дні, в окремих випадках – до 30 робочих днів. Це залежить від умов банку-еквайєра, через який пройшов основний платіж, а також банку-емітента.

===== Скасування звичайного платежу =====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "MERCHANT-TEST",
"orderId": "test_20210217-121843",
"transactionId": "913141164",
"amount":"1"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
body
{
"merchantKey":"easypay-test",
"transactionId":913141164,
"refundTransactionId":913141464,
"orderId":"test_20210217-121843",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>

'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">скасована сума </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">для часткового скасування - передається із сумою, яку потрібно скасувати.
для скасування повної суми - параметр amount не передається
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">транзакція рефанду (скасування)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування). Можливі значення: </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* a'''ccepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* p'''ending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен повертати '''"'''<code>paymentState</code>'''":"'''<code>declined</code>'''",''' а запит статусу транзакції скасування - '''"'''<code>paymentState</code>'''": "'''<code>accepted</code>'''"'''

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація ([[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]), на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром "<code>action</code>": "<code>refund</code>'''"''' та сумою (amount), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Скасування платежу (замовлення зі Splitting параметрами) =====
----Скасування платежу (Замовлення) можна робити:

* на всю суму платежу (замовлення)
* на суму одного спліту (Часткова скасування платежу (замовлення))
* на суму меншу від суми спліту (Часткова скасування спліту)
<br>

===== Скасування повної суми платежу (замовлення зі Splitting параметрами) =====
----
* Для скасування повної суми Splitting транзакції необхідно виконати запит статусу транзакції згідно з розділом "[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]'''"''' використовуючи основний <code>OrderID</code>
* Отриманий у відповіді кореневий <code>transactionID</code> використовувати у запиті [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]]
* У відповідь на запит [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]] буде отримано відповідь зі статусом скасування, а також буде отримано коллбек по кожній транзакції, яка входила до Splitting транзакції.
* Коллбек на загальну суму Splitting транзакції не надходить.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379504,
}
</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId": 991379504,
"refundTransactionId":913141464,
"orderId":"full_split_11",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''Pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</tr>

</table>Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати <code>"paymentState"''':"'''declined'''"'''</code> як для основної так і для окремих транзакцій, а запит статусу транзакції скасування - <code>"paymentState":"accepted".</code>

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром <code>"action": "refund"</code> та сумою (<code>amount</code>), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Часткове скасування (повернення) платежу (замовлення зі Splitting параметрами) =====
Для часткового скасування платежу необхідно виконати запит <code>cancelCurder</code> використовуючи <code>transactionID</code> який був отриманий в коллбеку (параметр payment_id), а також вказавши суму скасування (вона має бути меншою або дорівнює сумі транзакції, що скасовується).

* У відповідь на запит <code>cancelOrder</code> буде отримано відповідь зі статусом скасування, а також буде отримано коллбек про успішне скасування цієї транзакції.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379509,
"amount":1.00
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr></table>

'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId":"991379509",
"refundTransactionId":"913141464",
"orderId":"full_split_11",
"amount":"1.000000",
"paymentState":"accepted",
"error":"null"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування)
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>

</tr></table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати "paymentState":"declined", а запит статусу транзакції скасування - "paymentState":"accepted"
При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде одноразово надіслано POST - запит із параметром '''"action": "refund"''' та сумою '''(amount)''', яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

=== Повідомлення про платіж ===
----
# Партнер обов'язково вибирає 1 або кілька способів сповіщення та повідомляє його в EasyPay. Партнер зазначає платіж успішним на своїй стороні лише після отримання цього повідомлення
# Ми надсилаємо HTTP - колек з IP 93.183.196.26 методом POST з інформацією про платіж.
# Запит надсилає EasyPay партнеру після того, як транзакція набула фінального статусу (Accepted, Declined).
# URL для повідомлень '''(UrlNotify)''' партнер направляє у запиті '''createOrder''' у параметрі:
<br>
<syntaxhighlight lang="json" line="1">
"order":{
"additionalItems":{
"Merchant.UrlNotify":"https://notify.url"
}
}
</syntaxhighlight>
<br>
"Merchant.UrlNotify" Параметр не може бути порожнім і має відповідати формату URL.
<br>

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Якщо у відповіді не отримано <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">HTTP StatusCode 200</span>, запит нотифікації буде надіслано повторно протягом <strong>1-10 хвилин</strong>.
Повторення може продовжуватися визначену кількість разів (за замовчуванням – <strong>50 разів</strong>), поки не буде отримано статусу <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #198754;">"200 ОК"</span>.
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Sign": "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
body
{
"OperationType": "Payment",
"PartnerKey": "groshi-com",
"ServiceKey": "GROSHI-COM-GOOGLEPAY",
"TransactionStatus": "Accepted",
"MerchantOrderId": "3127194_28_450866",
"DateTime": "2023-12-09T14:00:48",
"Amount": 2059.08,
"Commission": 28.83,
"TransactionId": 1336448544,
"AdditionalItems": {
"Merchant.Inn": "3178404189",
"Merchant.Details": ";0;0;;4;",
"Merchant.UrlNotify": "https://testpartner.ua/callback",
"Merchant.ClientFullName": "Іванов Дмитро"
"Acquirer.MerchantId":"12345678"
"Acquirer.TerminalId":"E1234567"
"Card.BrandType":"Visa"
"AuthCode":"012345"
}
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>OperationType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)

'''refund -''' про успішне скасування платежу (відправляється разово)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionStatus</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>MerchantOrderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.MerchantId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торговц'''я''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.TerminalId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор платіжного пристрою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Card.BrandType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">найменування платіжної системи, платіжний інструмент якої використовується </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AuthCode</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Код авторизації </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>DateTime</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">якщо партнер не відповість статусом 200 на запит з action:payment, то в наступному запиті час буде новим</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ID транзакції на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>

</table>
<br>Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.
Для правильного обчислення підпису, тіло з нотифай потрібно брати як є, без перетворень та форматувань.
У випадку, якщо підпис notify не перевірено, всі фінансові ризики перекладаються на партнера.

==== Отримання інформації про рекурентний платіж ====
----
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/info</span></p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="
queryParams
"serviceKey": "string"
"orderId": "string"
"reccurentId": "0"
"dateFrom": 2025-03-10
"dateTo": 2025-03-17
"isEnabled": true|false
"pageNumber": 1
"countPerPage": 3

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"merchantReccurentPaymentDetails":[
{
"recurrentId":14433854,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601+url",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:38:02+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:42+02:00",
"properties":{
"failedCount":"1",
"urlNotify":"http://109.251.205.8:9987/merch/notifysigncheckexample.php"
}
},
{
"recurrentId":14433852,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:37:25+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:03+02:00",
"properties":{
"failedCount":"1"
}
}
],
"totalCount":2,
"totalFilteredCount":2,
"pageFilteredCount":2,
"currentPageNumber":1,
"numberOfPages":1,
"error":null
}

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>reccurentId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекурента </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateFrom</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента з.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateTo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента по.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isEnabled</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити лише активні / або неактивні рекуренти </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pageNumber</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити сторінку номер.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>countPerPage</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">кількість записів на сторінці </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>templateId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекуренту (reccurentId) </td></tr></table><br>

==== Виклик рекурентного платежу ====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/payment</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"reccurentId": 0,
"amount": 0
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"reccurentId": 0,
"transactionId": 0,
"transactionStatus": "None",
"error": {
"errorCode": "string",
"title": "string",
"description": "string",
"errorMessage": "string",
"fieldErrors": [
{
"fieldName": "string",
"errorCode": "string",
"errorMessage": "string"
}
]
}
}

</syntaxhighlight>Також буде надіслано нотифікацію у разі успішного платежу. Створення рекурентного платежу на операцію, у структурі якої є спліт – не підтримується.

<br>

=== Видалення рекурентного платежу ===
----
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/reccurent/delete/{id}</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
відсутній
</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

-

body

-
</syntaxhighlight>

== Перекази та «безпечна угода» ==
----

=== Створення замовлення на перекази між картами ===
Призначений для перевірки створення переказів між картами та реалізації функціоналу безпечної угоди на ресурсах мерчанта. Перед викликом цього методу потрібно:

# мати доступні AppID та PageID, отримані за методами: CreateApp ([[MerchantAPI#Реєстрація точки та створення сесії|Реєстрація точки та створення сесії]]) та CreatePage ([[MerchantAPI#Створення сесії|Створення сесії]]);
# отримати serviceKey, який підтримує операції переказів з картки на картку;
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span><syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1001.0,
"paymentOperation":"Hold",
"additionalItems": {},
"expire": "2019-04-15T07:49:20",
"fields": [
{
"fieldName": "Pan",
"fieldValue": "5555444433332222",
"fieldKey": " bb37c1ef-3345-412e-8e76-4a6a48f64f70",
}
]
},
"urls": {
"success": "string",
"failed": "string"
}
</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги Мерчант</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">видає EasyPay</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>description</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 120 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення, роздільник – точка </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип платіжного процесу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalItems</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язкові додаткові параметри
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">наприклад:
<code>"additionalItems":{ "Merchant.Param1":"CustomValue" }</code>,
де Merchant.Param1 - індивідуальний параметр партнера Param1
узгоджується з EasyPay;
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldName</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Pan''' – значення параметра для ініціювання списання перекладу карту. Обов'язкове заповнення;
* '''fieldValue: "5555444433332222"''' – вказується номер картки, куди потрібно зарахувати переказ (опціонально, альтернатива fieldKey);
* '''fieldKey''': " bb37c1ef-3385-412e-8e76-4a9448f64f70" –вказується GUID токена, куди слід зарахувати переказ (опціонально, альтернатива fieldValue);
* '''expire -''' час життя замовлення. Після закінчення заданого часу замовлення сплатити неможливо. Час життя сторінки може відображатися на платіжній сторінці у вигляді таймера (за замовчуванням таймер вимкнено). Значення має бути більшим за поточний час на 6 хвилин. Значення за замовчуванням – 3 дні. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>urls</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''success -''' url сторінки успіху, для редиректу клієнта у разі успішної оплати (після оплати клієнт може не дочекатися редиректу на цей url, тому редирект '''не можна використовувати як індикатор успішної оплати,''' отримання оповіщення про успішний платіж - '''див. п. 2.7)'''
* '''failed''' - url сторінки помилки для редиректу клієнта у разі неуспішної оплати. Приклад get-параметрів, які приходять на url.failed та url.succes (те ж, але без errorCode): </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=
Тестове+описання+замовлення&transactionId=722443797&date=2019-0611T14:49:07&recurrentId=&''errorCode=PAYMENT_ALFABANK_-2006''&sign=
eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</td>

</tr></table>

'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
"forwardUrl": "https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b",
"error": "null",
</syntaxhighlight>Для введення даних картки на платіжній сторінці користувач повинен бути переадресований за '''forwardUrl.'''

Після введення клієнтом даних картки на платіжній сторінці та завершення успішного списання коштів з картки – платіж буде поставлений у статус захолдованого. Перевірка статусу здійснюється викликом методу OrderState ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]). Для завершення переказу на картку (перерахування на картку Одержувача) необхідно викликати метод [[MerchantAPI#Завершення переказу на карту Одержувача|Завершення переказу на карту Одержувача]]

При необхідності скасувати переказ (повернути суму відправнику) – потрібно викликати метод CancelOrder ([[MerchantAPI#Скасування платежу|Скасування платежу]]). Скасування частини суми переказу – неможливе. Лише скасування на повну суму.
<br>
<p style="border: 1px solid #E67E22; background-color: rgba(230, 126, 34, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
<strong style="color: #E67E22;">Важливо!</strong> Завершення переказу ([[MerchantAPI#Завершення переказу на карту Одержувача|Завершення переказу на карту Одержувача]]) або повне скасування переказу ([[MerchantAPI#Скасування платежу|Скасування платежу]]) мають бути виконані протягом 30 днів з дати створення переказу ([[MerchantAPI#Створення замовлення на перекази між картами|Створення замовлення на перекази між картами]]).
</p>

=== Завершення переказу на карту Одержувача ===
----Призначений для завершення перекладу після створення за методом [[MerchantAPI#Створення замовлення на перекази між картами|Створення замовлення на перекази між картами]]

Перед викликом цього методу потрібно мати доступні AppID та PageID, отримані за методами CreateApp ([[MerchantAPI#Реєстрація точки та створення сесії|Реєстрація точки та створення сесії]]) та CreatePage ([[MerchantAPI#Створення сесії|Створення сесії]])

<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">api/merchant/unHoldOrder</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order": {
"serviceKey": "string",
"orderId": "string",
"transactionID": "string",
"fields": [
{
"fieldName": "Pan",
"fieldValue": "1111222233334444"
"fieldKey": "af27c751-1b8b-47a8-94b3-14507e93b44a"}
</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги Мерчант</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">видає EasyPay</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний номер транзакції у системі EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 120 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldName</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''Pan –''' значення параметра для ініціювання списання перекладу карту. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldValue</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''5555444433332222''' – вказується номер картки, куди потрібно зарахувати переклад (опціонально, альтернатива fieldKey) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"bb37c1ef-3385-412e-8e76-4a9448f64f70"''' – вказується GUID токена, куди слід зарахувати переклад (опціонально, альтернатива fieldValue).
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''
</td>
</tr></table>

'''Response''' <syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"paymentState": "pending",
"orderId": "Test Hold134",
"amount": 1.05,
"transactionId": 1046180773,
"error": null
}
</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума завершеного переказу</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>error</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">код помилки </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 120 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний номер транзакції у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі paymentState:

* '''accepted (фінальний статус) - переказ успішно завершено;'''
* '''declined (фінальнильнй статус) -переказ не завершено;'''
* '''pending (не фінальний статус) - платіж знаходиться в обробці, необхідно повторити запит статусу пізніше;'''
* '''paymentHold (не фінальний статус) - гроші з картки Відправника списано, але переказ не завершено на картку Одержувача;'''
* '''none (-) - статус платежу не визначено, необхідно повторити запит статусу до отримання кінцевого статусу;'''</td>
</tr></table>

Для отримання актуального статусу переказу потрібно викликати OrderState ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]])

== Робота з токенізованими картами ==
----

=== Токенізація карти ===
Метод призначений для токенізації (збереження) картки для ідентифікатора користувача під конкретним торговцем.

===== Токенізація з передачею даних картки у запиті (заборонено без PCI:DSS сертифікації мерчанта) =====
Перед викликом цього методу. Потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]

'''-''' [[MerchantAPI#Створення сесії|CreatePage]] <br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCard</span></p>
<br>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "380501002030ws",
"pan": "4874120123567889",
"expire": "1222",
"cvv": "012",
"vсode": "123654"
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"activateCodeType": "code|amount",
"cardGuid: "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan”: "48741201****1234",
"expire”: "1222"
"error": "null"
}

</syntaxhighlight>Токенізація картки - процес двоетапний.

На першому етапі у запиті йдуть параметри картки та номер телефону користувача. У відповіді, залежно від '''activateCodeType''', може бути активація за кодом підтвердження з виписки або SMS або за сумою списання.

З другого краю етапі до всіх параметрів додається ще vcode – код верифікації. При успішному відповіді прийдуть параметри токенізованої карти чи помилка.

===== Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна) =====
Перед викликом цього методу, потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]];

'''-''' [[MerchantAPI#Створення сесії|CreatePage]];
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">api/merchant/tokenCard/create</span></p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type: application/json"
"PartnerKey: partnerName"
"locale: ua"
"AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "8888",
"expire": "2020-12-06T12:54:32.043Z",
"urls": {
"success": "https://test.ua",
"failed": "https://test1.ua",
"notify": "https://test2.ua",
"back": "https://test3.ua"
},
"description": "testtts",
"checkExistingToken": false
"operationType":"SingleToken | createToken | ExistingToken"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"forwardUrl": "https://easypay.ua/ua/tokencard/cae16afc-be56-4a39-8ce1-5de4f4142e76",
"error": null
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>description</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |опис, який відобразиться на сторінці токенізації
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час життя сторінки токенізації (по дефолту - 15 хвилин)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережеться картка (будь-які літери, цифри, GUID.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |'''Не повинен містити символ ‘+’'''
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>urls</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |містить інформацію про:

* сторінці успіху партнера (success) для переадресації клієнта після успішної токенізації, потрібно обов'язково передавати
* сторінці помилки ('''failed''') для переадресації клієнта у разі помилки
* адреса для відправки callback-запиту з деталями при успішній токенізації ('''notify''')
* адресу для повернення назад зі сторінки токенізації ('''back''')
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>forwardUrl</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |сторінка для додавання картки (токенізації)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>checkExistingToken</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |перевірка наявності токена по карті, що вводиться у даного партнера.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |Параметр може набувати значення:

* true - проводити валідацію на наявність раніше створеного токена по цій карті;
* false - валідація відсутня;
* null - валідація відсутня;

Якщо параметру '''checkExistingToken''' присвоєно значення true, слід очікувати наступних сценаріїв поведінки:

* “checkExistingToken” : '''true,''' і в системі '''немає раніше створених токенів''' під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''true,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) - користувачу відкривається сторінка успіху, додаткова верифікація (надсилання коду верифікації не відбувається), токен не створюється, а в callback вказується '''масив раніше створених токенів''';
* “checkExistingToken” : '''false / null,''' і в системі немає раніше створених токенів під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''false / null,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) – формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену.
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>operationType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |''(Новий параметр) задає тип операції токенізації''
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
* '''SingleToken''' - для однієї карти завжди повертається той самий токен. Логіка така:

* перевіряємо чи є токен для цієї картки під '''partnerKey''' із запиту

* якщо є 1 або більше токенів - беремо останній з них, створюємо новий запис з цим токеном для переданого ідентифікатора клієнта '''(phone)''', відправляємо цей токен в callback у кореневому параметрі '''cardGuid'''
* якщо токенів немає - створюємо новий для цього '''phone''' і відправляємо його в callback в кореневому параметрі '''cardGuid''' (один і той же '''cardGuid''' може бути прив'язаний до різних phone)

* '''createToken''' - значення за замовчуванням, звичайне створення токена (можна не передавати)
* '''ExistingToken''' - поведінка аналогічна '''checkExistingToken:true'''
|}
'''На сторінці токенізації можемо керувати інтерфейсом (на стороні EasyPay):'''
* відображати/сховати логотип EasyPay
* відображати/приховати логотип та назву партнера
* відображати/приховати опис з деталями токенізації
* відображати опис у згорнутому/розгорнутому вигляді

'''Приклад callback - запит з IP адреси 93.183.196.26 після успішної токенізації:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers

Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"partnerName",
"phone":"test989",
"cardGuid":"2ad57b2e-eb5b-4a99-ad05-788cf589b8af",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-02-24T17:32:07.447",
"codeType":"Mpi3Ds"
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережено картку
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>cardGuid</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |токен збереженої карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>pan</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |маскований номер картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |термін дії карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>datePost</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час додавання картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>codeType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ознака типу верифікації картки. Mpi3Ds – з використанням 3ds.
|}

'''Приклад callback - запит з IP адреси 93.183.196.26 з параметром ExistingToken:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers
Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":null,
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:41:53.152",
"codeType":"Code",
"existingTokens":[
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"bac4f855-xxxx-xxxx-bece-14cdf23c6c52",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:28:23.840",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"6338e8b4-xxxx-xxxx-a3e5-f46ad0cb0efa",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:34:25.733",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"18e3c35e-xxxx-xxxx-ba59-9506154394c0",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:39:42.010",
"codeType":"Mpi3Ds"
}
]
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>existingTokens</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |масив з даними раніше створених токенів по цій карті під даного партнера '''(partnerKey)'''
|}

===== Отримання списку токенізованих карт =====
----Метод призначений для отримання списку токенізованих карток за номером телефону (ознакою) користувача.
<br>
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCards/get</span></p>
'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams
phone = string
cardGuid= Guid
</syntaxhighlight>'''Response''' <syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"tokenCards": [
{
"cardGuid": "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan": "48741234****1234",
"expire”: "1222"
}],
"error": "null"
}

</syntaxhighlight>Якщо передати тільки ідентифікатор клієнта (параметр phone) - у відповіді будуть всі карти поточного клієнта. Якщо передати <code>phone</code> та <code>cardGuid</code> - у відповіді буде одна карта поточного клієнта.

<br>

===== Видалення токенізованих карт =====
----Метод призначений для видалення токенізованих карток за номером телефону. Якщо у клієнта під одним номером кілька карток, всі картки будуть видалені.
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone</span>

<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone?CardGuid=Guid</span></p>'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams

cardGuid= Guid

</syntaxhighlight>'''Response'''<syntaxhighlight lang="markdown" line="1">
headers
відсутній

body
відсутній
</syntaxhighlight>

===== Видача кредиту (переказ на картку користувача) =====
Метод призначений для переказу на картку користувача суми кредиту.
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateAPP]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
'''Request:'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order":{
"serviceKey":"CARD-FILL",
"description":"test top up card",
"amount":1.12, (decimal)
"orderId":"test",
"fields":[
{
"fieldName":"Pan",
"fieldValue":"4102321200001111",
"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"
},
{
"fieldName":"Phone",
"fieldValue":"38093520000"
}
],
"additionalItems": {
"Merchant.ClientFullName": "Иванов Петр Сергеевич",
"Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32",
"Merchant.Inn": "3334445823"
}
},
"userPaymentInstrument":{
"instrumentType":"Vcash"
}
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"redirectUrl": null,
"action": null,
"paymentState": "Confirmed",
"status": "Done",
"actionType": "UrlRedirect",
"transactionId": "766934634",
"retrievalReferenceNo": "null",
"responseItems": "null",
"error": "null"
}

</syntaxhighlight>'''Опис параметрів'''
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |paymentState
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |
* '''Confirmed''' оплата пройшла успішно
* '''WaitConfirm ''' очікується підтвердження платежу
* '''Rejected''' і '''Refunded''' платіж відхинело
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>transactionId</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" | ідентифікатор платежу в системі Easypay
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |У об'єкти поля передається інформація для поповнення карти. Номер картки можна вказувати:

* для випадку з PCI DSS сертифікацією: у відкритому вигляді

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldValue":"4102321200001111",</code>'''

* для випадку без PCI DSS сертифікації: у вигляді токена (як отримати токен картки - див. [[MerchantAPI#Токенізація карти|Токенізація карти]]):

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"</code>'''

Також потрібно вказати:

- номер телефону клієнта:

'''<code>"fieldName":"Phone",</code>'''

'''<code>"fieldValue":"38093520000"</code>'''

- ПІБ та адреса клієнта АБО ПІБ та ІПН клієнта:

'''<code>"additionalItems": {</code>'''

'''<code> "Merchant.ClientFullName": "Іванов Петро Сергійович"</code>'''

'''<code> "Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32"</code>'''

'''<code> "Merchant.Inn": "3334445862"</code>'''

'''<code> }</code>'''
|}

'''Статус видачі кредиту:'''

* Якщо у відповіді отримано кінцевий статус <code>(paymentState = Confirmed / Rejected / Refunded)</code> - необхідно присвоїти його платежу.
* Якщо кінцевий статус у відповіді не отримано <code>(paymentState = WaitConfirm)</code>, '''у тому числі при серверних, мережевих та будь-яких інших відповідях та помилках''' - необхідно запросити статус платежу методом '''orderState''' ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]) до отримання кінцевого статусу.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Важливо врахувати, що нотифікація про оплату не надсилається (якщо партнер/мерчант не повідомив про необхідність такого налаштування).<br><br>
Скасування транзакції не передбачено.
</p>
<br>

Response (Приклади відповідей при помилках: status code = 400)<syntaxhighlight lang="json" line="1">
{
"error": {
"errorCode": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"title": null,
"description": null,
"errorMessage": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"fieldErrors": [
{
"fieldName": "Order.Fields[0]",
"errorCode": "SERVICE_FIELDS_VALIDATION_EXCEPTION",
"errorMessage": "Вказана умова не була виконана для значення поля."
}
]
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pv2",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Обслуговуються тільки карти емітовані українськими банками",
"fieldErrors": []
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pa8",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Необхідно уточнити реквізити картки одержувача у банку емітента",
"fieldErrors": []
}
}

</syntaxhighlight>

===== Нотифікації (колбеки) щодо операцій поповнення карток =====
Дані колбеки є опціональним (додатковим) способом отримання інформації від EasyPay про результат виконання запиту на поповнення картки.

Для активації отримання колбеків мерчант (партнер) повинен повідомити EasyPay про таку необхідність, після чого EasyPay включає цю опцію.

Спосіб відправки колбека - '''HTTP - з IP 93.183.196.26''' буде надіслано '''POST''' запит з інформацією про платіж на вказаний <code>urlNotify</code>.

<code>urlNotify</code> прописується на стороні EasyPay і використовується за замовчуванням, якщо партнер не передав його у своєму запиті.

URL для повідомлень ('''UrlNotify''') повідомляє партнер (мерчант).

Партнер може передавати '''UrlNotify''' у запиті '''createOrder''' у параметрі:

<code>"order":{</code>

<code>"additionalItems":{</code>

<code>"Merchant.UrlNotify":"<nowiki>https://notify.url</nowiki>"</code>

<code>}</code>

<code>}</code>

"Merchant.UrlNotify" параметр не може бути порожнім і повинен відповідати формату URL.

Якщо у відповідь не отримано HTTP StatusCode 200 - запит нотифі буде надіслано повторно, доки не отримано статусу “200 ОК”.

Коли нотифікацію (колбек) успішно доставлено (отримано статус 200 ОК), повторне відправлення колбеків припиняється.

Відправлення колбеків можливе за двома сценаріями:

1) лише за успішними операціями (транзакціями);

2) за операціями (транзакціями) у фінальному статусі (успішні та відхилені).

Надання фінального статусу операції (транзакції) асинхронно з процесом відправки колбека (фінансова транзакція набуває фінального статусу незалежно від статусу прийняття колбека партнером).

'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

"Sign: "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
"User-Agent": "EasyPay.MerchantNotifyService"

body

{
"action": "payment",
"merchant_id": 5347,
"order_id": "5",
"date": "2019-06-19T15:38:10.7802613+03:00",
"details": {
"amount": 1.00,
"desc": "Wooden tables x 10",
"payment_id": 724502946,
"recurrent_id": null
},
"additionalitems": {
"BankName": "CB PRIVATBANK",
"Card.Pan": "414962******1234",
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>action</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>merchant_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер сервісу партнера на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>order_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>date</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>details</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">детальна інформація про платіжну операцію (транзакцію) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''payment_id -''' ID детальна інформація про платіжну операцію (транзакцію):
* '''amount''' - сума фінансової операції;
* '''desc''' - опис замовлення, отриманий під час запиту CreateOrder;
* '''recurrent_id''' - ознака реккурентного платежу (завжди за замовчуванням на операціях поповнення картки – null);</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalitems</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">блок додаткових параметрів, до якого можуть включатися додаткові айтеми, отримані в запиті CreateOrder:
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''BankName''' - назва банку власника картки;
* '''Card.Pan -''' номер картки у маскованому вигляді.</td>
</tr></table>

Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> У випадку, якщо підпис <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">notify</span> не перевірено, всі фінансові ризики перекладаються на партнера.
</p>

== Інтеграція з ApplePay ==
----Вимоги

# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитись з умовами надання послуг Apple Pay.
# Необхідно укласти договір із Easypay.ua.
<br>Apple Pay надає простий та безпечний спосіб проведення платежів у додатках iOS, watchOS та сайтах Safari. Використовуючи Face ID, Touch ID або двічі клацнувши Apple Watch, користувачі можуть швидко та безпечно передавати свої платіжні дані для оплати.

=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка Apple Pay буде відображена на сторінці оплати EasyPay

=== Оплата ApplePay з додатку ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], в який потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимоги до брендування].

<br>
==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.

''Примітка: * - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).''

# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay

==== Технічна інтеграція з ApplePay ====

# Щоб інтегрувати Apple Pay у мобільний додаток, дотримуйтесь інструкцій за посиланням: https://developer.apple.com/documentation/passkit/apple_pay.

'''Приклад відповіді ApplePay'''<syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>2. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token в Easypay</code> ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Приклад запиту '''createOrder''':<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{ApplePayMerchantId}"
}
}

</syntaxhighlight>

=== Оплата із сайту ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], до якого потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимог до брендування].

==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).</em>
</p>
<br>
# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay
# Зареєструйте та підтвердіть свій домен:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі "Merchant Domains" натисніть "Add Domain".
## Введіть ім'я домену та натисніть "Continue" *.
## Завантажте файл apple-developer-merchantid-domain-association.txt.
## Збережіть файл на сервері від Apple.
## Натисніть Verify.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - домен повинен підтримувати HTTPS.</em>
</p>
<br>
# Створіть Apple Pay Merchant Identity Certificate:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Merchant Identity Certificate натисніть Create Certificate.
## Виконайте дії, описані на сайті Apple, а потім натисніть «Continue».
## Скопіюйте згенерований CSR-файл, вибравши Choose File, а потім Continue.
## Завантажте згенерований сертифікат (merchant_id.cer) і відкрийте його у програмі Keychain Access на комп'ютері Mac.
## У Keychain Access виберіть сертифікат, що імпортується, та експортувати його у формат .p12 (Personal Information Exchange).
## Виконайте команду: openssl pkcs12 -in merchant_id.p12 -out merchant_id.pem -nodes -clcerts
## Скопіюйте створений сертифікат у форматі PEM на сервер. Це буде потрібно для створення [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/requesting_an_apple_pay_payment_session Apple Pay Payment Session] в процесі [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/providing_merchant_validation перевірки магазину].

<br>
==== Технічна інтеграція з ApplePay ====
Для створення сертифікату (-ів) від Партнера потрібні:

# Country Name (2 letter code) [AU]: ?
# State or Province Name (full name) [Some-State]: ?
# Locality Name (eg, city) []: ?
# Organization Name (eg, company) [Internet Widgits Pty Ltd]: ?
# Organizational Unit Name (eg, section) []: ?
# Common Name (e.g. server FQDN or YOUR name) []: ?
# Email Address []: ?

Повідомте, чи буде оплата тільки в додатку, або також і на WEB.

Щоб інтегрувати Apple Pay на сайт, дотримуйтесь інструкцій за [https://developer.apple.com/documentation/apple_pay_on_the_web. посиланням]

# Перевірте можливість оплати з Apple Pay. Виконується перевірка, підтримує або браузер оплату з Apple Pay, а також є у Wallet картку, якою можна оплачувати.
<syntaxhighlight lang="markdown" line="1">
if (window.ApplePaySession) {
var promise = ApplePaySession.canMakePaymentsWithActiveCard({YOUR_MERCHANT_ID});
promise.then(function(canMakePayments) {
if (canMakePayments)
});
} else {
}

</syntaxhighlight>
2. Сформуйте структуру платежу для сесії<syntaxhighlight lang="markdown">
document.getElementById("apple-pay-button").onclick = function(event) {
var paymentRequest = {
currencyCode: 'UAH',
countryCode: 'UA',
total: {
label: {PRODUCT_NAME},
amount: {PAYMENT_AMOUNT}
},
merchantCapabilities: ['supports3DS'],
supportedNetworks: ['masterCard', 'visa']
};

var session = new ApplePaySession(3, paymentRequest)

</syntaxhighlight>
3. Відкрити платіжну сесію з Apple, отримати від них paymentData:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/applePay/validateSession</span><syntaxhighlight lang="json" line="1">
headers

--header "Content-Type: application/json"
--header "AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209"
--header "PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760"
--header "PartnerKey: easypay-test"
--header "locale: ua"

body
{
"url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
"merchantIdentifier": "string", /ідентифікатор мерчанту в Apple/
"displayName": "test", /ідентифікатор магазина/послуги/товару (латиниці) ; буде відображатися в toolBar/
"initiative": "web", /Канал оплати/
"initiativeContext": "string" /Доменне ім’я, Доменное имя, пов'язане із сертифікатом Apple Identity/
}

</syntaxhighlight><blockquote>*response з цього методу передається в сесію Apple, після чого при успішній авторизації платежу, повернеться до необхідний для завершення платежу.</blockquote>4. Приклад відповіді ApplePay<syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>5. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token</code> в Easypay ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Перед цим потрібно викликати метод EasyPayApi CreateApp.

'''Приклад запиту createOrder:'''<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{YOUR_MERCHANT_ID}"
}
}

</syntaxhighlight>

== Інтеграція з GooglePay ==
----'''Вимоги'''
# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитися з [https://payments.developers.google.com/terms/sellertos умовами надання] послуг GooglePay.
# Необхідно укласти договір із Easypay.ua.

Google Pay™ - це миттєвий спосіб оплати від Google, який дозволяє просто та швидко сплатити карткою, без необхідності вводити дані для кожного платежу. Ці картки надійно зберігаються в Google. Даний метод доступний для оплати в мобільних програмах на будь-яких пристроях Android і при здійсненні платежу в браузері Chrome.

• '''Документація'''

# [https://developers.google.com/pay/api/android Для додатків]
# [https://developers.google.com/pay/api/web Для веб-сайтів]

• '''Вимоги щодо брендування'''

# [https://developers.google.com/pay/api/android/guides/brand-guidelines Для додатків]
# [https://developers.google.com/pay/api/web/guides/brand-guidelines Для веб-сайтів]

<br>
=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка GooglePay відображається на сторінці оплати EasyPay.

=== Отримання токена GooglePay для оплати ===
----<nowiki>*</nowiki>Використовуйте бойове середовище GooglePay для отримання PaymentData

Для отримання PaymentData. Як параметри скрипта вкажіть:

# Доступні методи платежу: var allowedPaymentMethods = ['CARD', 'TOKENIZED_CARD'];
# Тип токенізації- PAYMENT_GATEWAY: tokenizationType: 'PAYMENT_GATEWAY';
# Параметр gateway: easypay;
# Параметр gatewayMerchantId: Ваш бойовий merchantAccount от Google, який повідомляє в EasyPay.

Якщо з вашого боку інтеграція виконана правильно, Ви на своєму сайті/додатку отримаєте кнопку

Після натискання кнопки на пристрої з підключеним Google Pay з'явиться спливаюче вікно або форма вибору прив'язаної картки.

'''Приклад відповіді від GooglePay Api'''<syntaxhighlight lang="json">
{
"apiVersionMinor":0,
"apiVersion":2,
"paymentMethodData":{
"description":"Mastercard •••• 1164",
"tokenizationData":{
"type":"PAYMENT_GATEWAY",
"token":"{"signature":"MEUCeretMPEQPUMnvMOnDAgZsOLVnFnfjmo5ALe/1D6o7hdzAiEA94L1GfNWW84kbUdHHn+l6B6n18VgIA3sdkPqKL36tqk\u003d","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEem3biYxltOBuMV+Dd9g+ZhV3VEzP2vAlFXvb9tJoYGLtetxDYWTUqnXPvKGDeAnSNrkPo8hu5kLtxN0QXCYkqQ\\u003d\\u003d\",\"keyExpiration\":\"1551385212256\"}","signatures":["MEYCIQD/TWKunZJhG/u3iL2H5P3i9r0rCbpw1/+z9dr/yGytvwIhAPfV2zF5cqP/L+42W+JKv6fgQKBEc67HTtfderefdghJ"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"OidSptk8w+I3FnR1VFmiVswXaZ7ADnmMP1MQelp6GSg0/3aVpAXeLRH/fT1wN7gpxNPy7tFITeQenrJm3QG19tAPuVhcAVM26DMU6LAmZPyPXALktpnYrUj6etCjvWWM/1LkhjDBSjtkmpWRiHIyqj5aud/j8rxFEk06GhwqPWbnJwdCgNf32LJP7bSpUWvHOioaZIV1vdeV6d7iQ6EDWWAS/z9pXWkqpW//M/TVTrcKFXh4C2TI2O+qyBD9VzK3TqU6wS5VsYL69W9/4xzV5L5irpp/wzNfPHkJd8QIwcsIPuNWBtGm3v+JCaqIA3oK9Sw/5o/gZp/pnOhUdax0VjGEvmbGXs2+ufBChCkh+/BpobbpzVS9T/DZSlUO2FLANMjSaEQzh74ymtDgP4x9O64RAdySW+V7lVZMa7FVZ3PFnTfa8W89pzIgo6ocSGHQPBFnExTmSbDpUU0L12wzHkAcZSyngPAljqg\\u003d\",\"ephemeralPublicKey\":\"BBKgbSbykNy1111QYRmGJEhnCorkt+VoDYlYbAlg0a5WO2uV/M50XqOSG0uxWAvUqrZolQuEX6yZ+dvvufLEZtI\\u003d\",\"tag\":\"p9ItvOfsQVTzhTPHq6ycYjKX1TtozP/yym4QWWVRVCk\\u003d\"}"}"
},
"type":"CARD",
"info":{
"cardNetwork":"MASTERCARD",
"cardDetails":"1164",
"billingAddress":{
"phoneNumber":"+380 93 000 00 11",
"address3":"",
"sortingCode":"",
"address2":"",
"countryCode":"UA",
"address1":"ул. ",
"postalCode":"49107",
"name":"Super 1",
"locality":"Київ",
"administrativeArea":"Київська область"
}
}
},
"email":"test@easypay.ua"
}

</syntaxhighlight>

=== Передача токена для оплати ===
Надішліть дані з поля token з відповіді від '''GooglePay Api''' у поле '''userPaymentInstrument/token''' у Easypay (розділ [[MerchantAPI#Створення замовлення|Створення замовлення]])

Перед цим потрібно викликати метод '''EasyPayApi [[MerchantAPI#Реєстрація точки та створення сесії|createApp.]]'''

'''Приклад запиту'''
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span><syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210000-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"GooglePay",
"token":"{\"signature\":\"MEQCIFTFadYw15Cqfk7+YiM9pp5zEvyTI7oWVZCNFKr1cMthAiAFMv+nt0PWOEhj6LmmMNTByP9E4OhGrSoE7rDvzLDIZw\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEsrkMsOBN8N0xL8AsTVUIETODhCva5PpGFxvPm56pWmI5MG2HKKHXjsdhdvcP6N3d40x90E0rZzDrxBC2ywERXg\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1618591579000\\\"}\",\"signatures\":[\"MEUCIHX0SawuKctPUEjdFu2sDiE81aSSdf8i0KNvdg1dlsWoAiEAye8TEWpPk4sp7EjTovN7DichK6YxY1DajYN9/ArHDYI\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"vlLmhIBndM4a/GWFsvbFZrZOygjAwUao/NlvlJlhAQ3kdprI3gubAcQxAau8L74dkzGJh8w7AD2E77XOHycdwG91NUvsJ0xiXuMCXHJ9NPMhp7k49OUIJjOpJG+RqUM9/SPBgx69eDD7skhG+axZYr/m36LFjIlk5WhmumQgIrfojm02uRm0nOcZ2wbvrwQKZyL1IeTv/txqcYMuQqYWzs/FPkIEbiQ80z6dRhVszrEXcHLKcfBmNmcn/Vk90ArXCotOD52V0JS/Q+Mf9mCoe9G2bABo9R9PAYT/FrKIEOQEhzLCI7m4/vyIlCMf69d6PjigP3AOGxykbS0Kvsxqoh+HYRFCSLCd+8O2Us2wCYD09/OBqcQi78/fs2vwyg4nrWQQJ6ZGwTKHHxVRY8VGAUUnMFr18HPsN1BQNuz08M4t6Qx6X0nEZ3hseSIcUMVcBm+NyvL2T/XSWqTh2poDuQ4B+UJ59gMrsPapzouxk2iC/+vS1Bs/2sSf77Nsqr7BhE7SMgnZ/a2LF+Shx2aOKSIGflMz+MjVSzpMg2AUh43pbcsi8g\\\\u003d\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BDJpYzoN9XPVKrHIxwNes83HbR0/AOUPpQgAwi3fTzR+TIB8/VAc9CdI9guWX8Pjvii/T+WxwcByuo9pzJC7518\\\\u003d\\\",\\\"tag\\\":\\\"LFOOTwd5Crtn60KnT0J6MHuFlGE0+EYL3D7IrWrPsRA\\\\u003d\\\"}\"}",
}
}

</syntaxhighlight>

== Оплата за QR MasterPass ==
----<blockquote>Для мерчантів, які мають пряму інтеграцію з MasterPass. </blockquote>QR MasterPass - оплата з гаманця MasterPass із використанням Qr code.

<br>
=== Отримання даних для QR-code ===
----Потрібно створити сесію ([[MerchantAPI#Створення сесії|Створення сесії]]). Після цього необхідно створити замовлення ([[MerchantAPI#Створення замовлення|Створення замовлення]]).
У відповіді в <code>paymentInstrumentsTypes => instrumentType: "QrMasterpass"</code> об'єкт, який містить інформацію для формування QR code. У '''<code>instrumentvalue</code>''' буде рядок, з якого потрібно генерувати QR code.

Приклад '''paymentInstrumentsTypes''' => '''instrumentType: "QrMasterpass"'''
<br>
<syntaxhighlight lang="json">
{
"instrumentType":"QrMasterpass",
"commission":0.0,
"amountMin":1.00,
"amountMax":14999.00,
"userPaymentInstruments":[
{
"instrumentId":8499910,
"instrumentType":"QrMasterpass",
"instrumentValue":"00020101021252040000530398054034005802UA5909
EasyPayUa6004Kiev64190002UK0109EasyPayUa80850017ua.
mastercard.www010200020840703434032003434180702054456177041211109354874205020181500017
ua.mastercard.www011720191111093548742020499996223030443590603391070410036304AF79",
"alias":null,
"commission":0.0,
"loyaltyCommission":null,
"actionsKeys":null,
"priorityIndex":0,
"additionalParams":{
"OrderId":"4825209b-1caa-472e-b530-dc3e8efd541c"
}
}
]
}

</syntaxhighlight>

=== Перевірка статусу QR code ===
----Метод повертає інформацію про поточний статус QR code.

<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">//api/payment/qrPaymentCheck</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

queryParams

headers
відсутній

body
{
"status": "Generated",
"transactionId": null,
"error": null
}

</syntaxhighlight>Можливі значення '''"status":'''

* <code>Generated</code>
* <code>Scanned</code>
* <code>PaymentStarted</code>
* <code>PaymentFinished</code>
* <code>PaymentFinished</code>
<br>
'''"transactionId"''' – ідентифікатор платежу в системі EasyPay.

=== Оплата за QR code ===
----Метод для оплати за QR кодом. Працює тільки з QR кодами, які були отримання від EasyPay.
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/create/qr</span>
</p>

'''Request''' <syntaxhighlight lang="json">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"

body
{
"qrCode": "string",
"amount": 1,
"userPaymentInstrument": {
"instrumentId": 8499910,
"instrumentType": "QrMasterpass",
"alias": "Mycard",
"pan": "4102*******4441"
},
"resultUrl": "string"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"paymentState": "Confirmed",
"status": "Done",
"retrievalReferenceNo": 11111111,
"error": null
}

</syntaxhighlight>

Можливі значення “'''paymentState'''”

* Сonfirmed
* Rejected

<br>

== Створення підпису ==
----Формування підпису Sign (основний варіант для POST – запитів)<syntaxhighlight lang="text">
Sign = base64(sha256(secretKey + requestBody))

</syntaxhighlight>'''Де:'''
* <code>secretKey</code> – секретний ключ.
* <code>requestBody</code> – тіло запиту у форматі JSON (ідентичне формату EasyPay).
<br>

=== Приклади коду ===
----'''C#'''

<code>Convert.ToBase64String(SHA256.Create().ComputeHash(Encoding.UTF8.GetBytes(data)))</code>

'''PHP'''

<code>base64_encode(hash('sha256', ($secretKey.$requestbody), true))</code>

<br>
== Можливі варіанти інструментів оплати ==
----

===== Оплата <span style=" display: inline-block; padding: 4px 16px; border: 2px solid #0033A0; /* Темно-синій колір рамки */ background-color: #0033A0; /* Темно-синій фон */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ ">VISA</span> <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid transparent; /* Прозора рамка для градієнту */ background: linear-gradient(to right, #FF5F00, #FFBF00); /* Градієнт від червоного до оранжевого */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">MasterCarD</span> =====
<syntaxhighlight lang="json" line="1">
"paymentInstrumentsTypes": [
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 200,
"additionalParams": {}
}
]
]
},
{
"instrumentType": "RCard",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>
===== Мобільні гроші <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #00A3E0; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #00A3E0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Київстар</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #F7E300; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #0033A0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Lifecell</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #E60012; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #E60012; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Vodafone</span> =====

<syntaxhighlight lang="json" line="1">
{
"instrumentType": "KSMoney",
"commission": 0.0,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4958975,
"instrumentType": "KSMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.0,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 1,
"additionalParams": {}
}
]
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 6000.00,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]

</syntaxhighlight>

===== Картки лояльності <span style=" display: inline-block; padding: 8px 20px; border: 2px solid #FF0000; /* Червона рамка */ background-color: #FF0000; /* Червоний фон */ color: white; /* Білий текст*/ font-family: Arial, sans-serif; /* Шрифт Arial */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Розмір шрифта */ ">Fishka</span> =====
<syntaxhighlight lang="json" line="1">
]
},
{
"instrumentType": "FishkaB2B",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},
{
"instrumentType": "FishkaB2C",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>

===== Оплата <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #000000; /* Темно-синій колір рамки */ background:FFFFFF ; /* Темно-синій фон */ color: #000000; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">ApplePay</span> <span style=" display: inline-block; padding: 8px 20px; border-style: solid; border-width: 4px; border-color: #4285F4 #EA4335 #FABB05 #34A853; /* Чітке розмежування кольорів */ background-color: #FFFFFF; /* Білий фон всередині */ color: #000000; /* Колір тексту */ font-family: Arial, sans-serif; font-weight: bold; text-transform: uppercase; font-size: 16px; border-radius: 24px; /* Закруглені краї */ ">GPAY</span> =====
<syntaxhighlight lang="json" line="1">
{
"instrumentType": "ApplePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958126,
"instrumentType": "ApplePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"instrumentType": "GooglePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958137,
"instrumentType": "GooglePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams":
{
"PublicKey": "BKdzipvJvJzcbTMm3dO0LEh1AXFr8qfSiPjwrI7vv9F6hqhDJB1M="
}
}
]
}
]

</syntaxhighlight>

=== Управління інструментами оплати ===
----Управління інструментами оплати на сторінці оплати EasyPay здійснюється при створенні замовлення. Параметр <code>allowedInstruments</code> визначає, які інструменти оплати будуть відображатися на сторінці платіжного шлюзу.
<br>
<syntaxhighlight lang="json" line="1">
"userInfo": {
"phone": "string"
},

Обов'язкові параметри:
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)
"allowedInstruments": [ "string" ]
</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>allowedInstruments</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр в якому передаються інструменти оплати, які будуть відображені на сторінці </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* RCard
* Card
* EBank
* FishkaB2C
* ApplePay
* GooglePay</td>
</tr></table>
'''<br>
Поведінка системи'''
# '''Якщо параметр''' <code>allowedInstruments</code> '''не передано або він порожній''': На сторінці оплати будуть відображені всі доступні інструменти, які підключені для партнера.
# '''Якщо з переданих інструментів немає доступних для оплати''': Повертається помилка: <code>PAYMENTINSTRUMENT_NOT_FOUND</code>
# '''Приклад помилки''': У разі, якщо у партнера активні ApplePay і Card, а в запиті передається GooglePay, повертається помилка <code>PAYMENTINSTRUMENT_NOT_FOUND</code>.
# '''Якщо передані доступні інструменти оплати''': У разі, якщо партнер передає, наприклад, GooglePay та Card, але GooglePay не активний для цього партнера, система поверне посилання з активним інструментом Card.
<br>

== Технічна підтримка ==
----За потреби консультацій з питань реалізації API можна написати запит на ''merchant.api.support@easypay.ua''

MerchantAPI

2025-05-15T13:16:56Z

Vadim.fedorchuk: Зміна даних по тестовій карті

== Загальні відомості ==
----Протокол призначено для торговців, які є одержувачами платежів. Продавець підписує договір про прийняття платежів або анкету-акцепт до публічної оферти.

Щоб отримати платежі, ви можете використовувати web, мобільні версії сайтів, а також мобільні програми. У разі використання цього протоколу не здійснюється перевірка даних для ідентифікації замовлення або облікового запису. EasyPay завжди приймає дані, надіслані та створені продавцем.

=== Заголовки запитів ===
----

Для надсилання запиту та отримання відповіді у форматі JSON, необхідно передати такі обов’язкові заголовки у запиті.<syntaxhighlight lang="jsonml+bst" line="1">
--header 'Content-Type: application/json'

--header 'AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209'

--header 'PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760'

--header 'PartnerKey: easypay-test'

--header 'locale: ua'

--header 'Sign: bS+vPOwu1Sif1Iz47Cdh+z1RAi0s6X21C3uU0YNBNWE='
</syntaxhighlight>

=== URL ===
----<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Посилання</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>

<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>https://merchantapi.easypay.ua</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Production</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">в т.ч. для надсилання тестових запитів</td>
</tr>
</table>

<br>
=== Налаштування безпеки ===
----Партнер надає IP, з яких будуть здійснюватися запити.
<br>
<br>
=== Реєстрація партнера в системі EasyPay ===
----Реєстрація нового торговця передбачає отримання унікального ідентифікатора '''PartnerKey'''.

===== Характеристика параметрів реєстрації =====
<div style="overflow-x: auto; display: block; width: unset !important; height: auto !important; border: none;">
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор партнера (продавця) у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор сервісу торговця у системі EasyPay.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>SecretKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">секретний ключ для формування підпису</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>
<br>

=== Тестові параметри ===
----Для тестових запитів використовуються такі параметри:<br><syntaxhighlight lang="pl">
PartnerKey = easypay-test
ServiceKey = MERCHANT-TEST
SecretKey = test

</syntaxhighlight>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
На даний момент відсутня можливість тестування з використанням фейкових оплат / тестових карток.
Платежі тільки реальні, їх можна відмінити в день оплати методом
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">cancelOrder</span>
([[MerchantAPI#Скасування платежу|Скасування платежу]])
</p>

===== Тестове середовище =====

Перед початком використання тестового середовища необхідно надати ір з яких будуть надходити запити, для відкриття доступу. На тестовому середовищі використовуються методи аналогічні Merchant Api.

'''Тестові дані:'''

* PartnerKey:credit-test
* SecretKey: credit-test

* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-PAYMENT - погашення
* serviceKey:TEST-CREDIT-TO-CARD - виплата
* Надсилання колбеків з Iр: 195.230.131.50 <br>
<br>
'''Тестові картки для верифікації/виплат:'''

Код підтвердження для 2дс при верифікації картки: 123456

<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5167803258208169</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4235751329985326</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4111111111111111</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна без створення транзакції
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4999999999990011</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна виплата з затримкою статусу 5 хв</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4217198608967728</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0525/111 </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Неуспішна виплата з затримкою статусу 5 хв
</td>
</tr></table>
<br>
'''Тестові картки для оплати:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Pan</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Card.Expire/CVV</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Статус виплати </th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>5168752081922117</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0128/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна оплата з 3ДС/ або не успішна оплата з 3ДС</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>4909150002132451</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0129/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Успішна 2ДС оплата
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"><code>4300380058021820</code></td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">0130/111</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Не успішна з 3ДС + помилка PAYMENT_ALFABANK_116
</td>
</tr></table>
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
У разі отримання помилки <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">APPID_NOT_FOUND</span>
у відповідь на будь-який метод, необхідно повторити запит
<span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">createApp</span>
до отримання точки ІД.
</p>
<br>

== Основні запити/відповіді ==
<hr color="#d3d3d3" size="1" noshade>

=== Реєстрація точки та створення сесії ===
Цей метод слід викликати, коли користувач вперше звертається до платіжної сторінки. Якщо браузер або пристрій змінюються, метод знову з'являється
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createApp</span>
</p>
'''Request'''<syntaxhighlight line="1" lang="json">
headers:

"PartnerKey": "partnerName",
"locale": "ua"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json-object" line="1">
body:

{
<br>
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": "https://cdn.easypay.ua/hint_images/",
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "f3f2b678-a3c4-45ba-a865-a136fe4a62bd",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> '''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID</td>
</tr>
</table>

<br>
=== Створення сесії ===
----Даний метод створює новий екземпляр сеансу для користувача , <code>PageId</code>.
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/system/createPage</span>
</p>'''Request'''<syntaxhighlight line="1" lang="json">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
body:

{
"logoPath": "https://cdn.easypay.ua/logo/",
"hintImagesPath": null,
"apiVersion": "1.0",
"appId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1",
"pageId": "29bd7237-6b8d-4048-b028-6efc23d05988",
"requestedSessionId": "fa3595d3-52de-4744-9fc6-ec2d3507d5a5",
"error": null
}

</syntaxhighlight>'''Характеристика параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"> <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AppId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торгової точки партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">за замовчуванням, якщо не було активності за запитами,
час життя AppId - 3 місяці. З кожним запитом життя AppId автоматично продовжується.
</td>
</tr>


<tr>
<td style="border: none; padding-right: 10px; text-align: left;">'''<code>PageId</code>'''</td>
<td style="border: none; padding-right: 10px; text-align: left;">ідентифікатор сесії </td>
<td style="border: none; text-align: left;">За замовчуванням, якщо не було активності за запитами, час життя PageId - 20 хвилин. З кожним запитом життя PageId автоматично продовжується.</td>
</tr>
</table>
<br>

=== Створення замовлення ===
----Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Для кожного нового запиту <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">CreateOrder</span> потрібно використовувати унікальний <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">PageID</span>.
</p>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/createOrder</span>
</p>

</p><syntaxhighlight lang="markdown" line="1">
headers

'Content-Type': 'application/json'
'PartnerKey': 'partnerName'
'locale': 'ua'
'AppId': 'a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId': '2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'Sign': 'e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

<br>
</syntaxhighlight><syntaxhighlight lang="json" line="1">
{
"userInfo": {
"phone": "string"
},
Обов'язкові параметри:

"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)

Необов'язкові параметри:
"paymentOperation":"PaymentTokenization",
"additionalItems": {},
"expire": "2019-04-15T07:49:20",
"isOneTimePay": true,
"fields": [
{
"fieldName": "string",
"fieldValue": "string",
"fieldKey": "string",
}
]
},
"urls": {
"success": "string",
"failed": "string",
"back": "string",
},
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string",
"id": "string"
},
"narrative": {
"name": "string"
}
},

"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string”
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true
}
]
},
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid",
"pan": "string",
"expire": "MM/YY",
"cvv": "string",
},
"partnerInfo": {
"id": "string",
"name": "string",
"account": "string"
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги мерчанта (видає EasyPay)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>description</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення (до 120 символів)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">відомий лише торговцю та EasyPay
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення, роздільник - точка </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)</td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип платіжного процесу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* '''PaymentTokenization -''' використовується для токенізації картки, якою буде сплачено це замовлення.
* '''Працює лише для інструмента “карта”'''. Повинен бути заповнений ідентифікатор клієнта '''"userInfo": { "phone": "string"}'''
* Якщо передано URL для колбеку, то після успішної оплати відправляється колбек про платіж та колбек про токенізацію (приклади колбеків про оплату - в [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]], про [[MerchantAPI#Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна)|токенізацію]].
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>userInfo/phone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер телефону (або ідентифікатор) клієнта </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Номер телефону необхідний:

* для отримання списку карток MasterPass гаманця
* для отримання списку токенізованих карток (інформація буде в масиві StoredCards)
* при оплаті із зазначенням токена картки
* для токенізації картки після успішної оплати разом із параметром
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>expire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час життя замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Після закінчення заданого часу замовлення сплатити неможливо. Час життя сторінки може відображатися на платіжній сторінці у вигляді таймера (за замовчуванням таймер вимкнено). Значення має бути більшим за поточний час на 6 хвилин.
'''Значення за замовчуванням - 3 дні'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>sOneTimePay</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">включає можливість успішно оплатити замовлення лише 1 раз за конкретним forwardUrl </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Значення:

* True - за замовчуванням;
* False - оплатити замовлення по тому самому ''forwardUrl'' можна буде кілька разів;</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>urls</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
*'''back -''' URL для повернення на вказану сторінку з фінальної сторінки успіху EasyPay.
* '''success -''' URL сторінки успіху, для редиректу клієнта у разі успішної оплати.
* '''failed -''' URL сторінки помилки для редиректу клієнта у разі неуспішної оплати</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''back -''' На фінальній сторінці EasyPay вгорі зліва з'явиться кнопка “Повернутись назад” з посиланням на вказану URL-адресу. Параметр не може бути порожнім і повинен відповідати формату URL.
* '''success''' - у разі, якщо не було передано urls{success,failed} для редиректу після оплати. Після оплати клієнт може не дочекатися редиректу на цей url, тому редирект не можна використовувати як індикатор успішної оплати, отримання оповіщення про успішний платіж - '''див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
* '''faild -''' приклад get-параметрів, які приходять на '''url.failed та url.succes''' (те ж, але без ''errorCode''):

<code>?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=</code>

<code>Тестове+описання+замовлення&transactionId=722443797&date=2019-06-11T14:49:07&recurrentId=&''errorCode=PAYMENT_ALFABANK_-2006''&sign=</code>

<code>eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</code>
</td>
</table>

<br>
===== Необов'язкові додаткові поля =====
'''<code>additionalItems</code> –''' необов'язкові додаткові параметри, наприклад:
<br>
<syntaxhighlight lang="json" line="1">
"additionalItems":{
"PayerEmail":"client@i.ua",
"PayerPhone":"380930007603",
"Merchant.UrlNotify":"https://notify.url",
"Merchant.Param1":"CustomValue",
"CurrencyAmountLabel":"123.56$"
},
</syntaxhighlight>'''Опис параметрів<br>'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerEmail</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">емейл клієнта для оповіщення його у разі неоплаченого замовлення та для автоматичного заповнення поля “Надіслати квитанцію на email” на сторінці оплати. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається – він не може бути порожнім і має відповідати формату email.</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PayerPhone</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">телефон клієнта, на який протягом 15-20 хв після виклику CreateOrder відправиться нагадування про неоплачене замовлення (смс або вайбер). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр передається, він не може бути порожнім і повинен відповідати формату телефону.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.UrlNotify</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL для надсилання нотифікації за успішним платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Параметр не може бути порожнім і має відповідати формату URL.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Merchant.Param1</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">індивідуальний параметр партнера Param1 узгоджується з EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>
</table>

<br>
'''<code>reccurentPayment</code> -''' інформація для створення рекурентного платежу на основі поточного. Рекурентний платіж буде створений за розкладом, якщо основний платіж виконаний за допомогою інструментів card, Rcard, Vcard, LifeMoney
<br><syntaxhighlight lang="json-object" line="1">
"reccurent": {
"cronRule": "string",
"dateExpire": "2019-01-21T08:24:38.741Z",
"dateRun": "2019-01-20T08:24:38.741Z",
"properties":
{
"failedCount":0,
"failedRule":"string",
"amount":1.0,
"UrlNotify":"http://notify.url"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>cronRule</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">правило у cron-форматі, з якою періодичністю повторювати рекурентний платіж, наприклад 10 20 15 * * (кожного 15 числа місяця о 20:10). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо ця властивість порожня, значить рекурентний платіж виконуватиметься на вимогу продавця.
'''Плануйте перше виконання рекуренту щонайменше 20 хвилин від дати успішного платежу.'''</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateExpire</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата, після якої не проводити рекурентний платіж.</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateRun</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата першого запуску рекурентного платежу (опціонально). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо не заданий, перший запуск розраховується за '''recurrent/cronRule'''
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>properties</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткові параметри (опціонально) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''reccurent/properties/amount -''' сума кожного рекурентного платежу, наступного після основної оплати (опціонально)
* '''reccurent/properties/failedCount -''' ккількість поспіль неуспішних викликів рекурентних оплат, після чого рекурентний платіж видаляється (опціонально). За замовчуванням - 4 спроби: при неуспіху - повторюється спроба кожні 20-30 хвилин, 4 неуспішних спроби поспіль по одному recurrentId - і рекурент відключається. Якщо після 3 неуспішних спроб була 1 успішна, то лічильник неуспішних для цього рекурента скидається.
* '''reccurent/properties/failedRule -''' cron-правило (період) повтору при неуспішному виклику рекурента (опціонально)
* '''reccurent/properties/UrlNotify''' - URL для надсилання нотифікації за успішним '''рекурентним''' платежем (callback), див. [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]
</td>
</table>
<br>
'''<code>bankingDetails</code> -''' передача банківських реквізитів для перерахування коштів у випадку, якщо банківські реквізити можуть змінюватися щодо різних платежів одного сервісу продавця. На стороні EasyPay має бути увімкнено режим "Отримувати реквізити із запиту".
<br>
<syntaxhighlight lang="json" line="1">
{
"bankingDetails": {
"payee": {
"id": "123664578",
"name": "департамент патрульної поліції",
"bank": {
"name": "пат пумб",
"mfo": "330556",
"account": "123654778889"
}
},
"payer": { "name": "Иванова Мария" },
"narrative": { "name": "Переказ коштів згідно договору з ФК № 111/11-П від 11.11.1111 р. за виключенням винагороди за їх переказ згідно реєстру від [work_date]р." }
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/ID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">код одержувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">ЄДРПОУ або ІПН</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>payee/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">одержувач </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банк отримувача</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 38 символів

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Mfo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">МФО банку </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">може не заповнюватися, якщо Payee/Bank/Account містить IBAN</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payee/Bank/Account</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">р/р одержувача або IBAN </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Payer/Name</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">платник </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Narrative/Name</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">призначення платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 157 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">повну структуру bankingDetails можна не передавати, для цього достатньо передати </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>bankingDetailsId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">

ідентифікатор банківських реквізитів із довідника, який узгоджений із конкретним партнером та перебуває в системі EasyPay.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">

</td>
</table>

'''Splitting''' - інформація щодо сплітування (розщеплення) платежу.

Частина загальної суми з order/amount розподіляється відповідно до інформації в splitting/items/value, а залишок - йде на основні реквізити з bankingDetails (або bankingDetailsId). На стороні EasyPay має бути увімкнено режим “Отримувати реквізити із запиту

Структура '''items''' це масив. Основний платіж буде розщеплений стільки платежів, скільки міститься у цьому масиві плюс залишок. Кожен розщеплений платіж буде надіслано на відповідні банківські реквізити <code>items/bankingDetails</code>. Залишок коштів буде надіслано на реквізити основного платежу з <code>BankingDetails</code> або <code>bankingDetailsId,</code> які потрібно обов'язково вказувати під час сплітування.
<br>
<syntaxhighlight lang="json" line="1">
},
"splitting": {
"items": [
{
"serviceKey": "string",
"orderId": "string"
"bankingDetailsId": "string",
"bankingDetails": {
"payee": {
"id": "string",
"name": "string",
"bank": {
"name": "string",
"mfo": "string",
"account": "string"
}
},
"payer": {
"name": "string"
},
"narrative": {
"name": "string"
}
},
"unit": "Amount|Percent",
"value": 0,
"withCommission": false|true

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>

 <tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/serviceKey</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор послуги, за якою ініціюється зарахування спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/orderId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язковий параметр. Ідентифікатор внутрішнього замовлення Мерчант для маркування конкретного спліту (частини) платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/bankingDetails</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">банківські реквізити кожного розщепленого платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/unit</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">може бути '''Amount''' (сума розщепленого платежу в грн.) або '''Percent''' (сума розщепленого платежу вважається відсотком від загального). </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/value</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">значення у цифрах. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>items/withCommission - true/false</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Вказує з якого з одержувачів слід утримати внутрішню комісію. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Сума комісії розраховується із загальної суми платежу, а утримується - з першого одержувача зі '''splitting,''' у якого '''withCommission=true'''. Якщо ні в кого з '''splitting''' не зазначено '''withCommission=true''', то комісія втікає з “основного” одержувача, вказаного в bankingDetails.
Якщо у всіх значення '''withCommission=false''' (або не передали), то комісія утримається з "основного одержувача", вказаного в параметрі '''bankingDetails'''

Якщо всі значення '''withCommission=true,''' то комісія утримається з першого одержувача, зазначеного в splitting. Залишок буде надіслано на реквізити основного платежу з '''bankingDetails''' або '''bankingDetailsId.'''

При встановленому сервісом Типі розрахунків “За актами", одержувачам перераховується повна сума, без відрахування комісії, незалежно від значення WithComission.
</td>
</tr>

</table>
<br>

Після виконання сплітування під кожен спліт (частини) платежу на стороні EasyPay створюється фінансова транзакція з унікальним transactionID.
<br>
* Якщо списання грошей з картки пройшло успішно і всі реквізити для спліту вказані корректно (доступні) - всі транзакції набувають успішного статусу і по кожній транзакції відправляється колбек.
* Якщо списання грошей з картки пройшло неуспішно – запит відхиляється з кодом фінансової помилки;
* Якщо списання грошей з картки пройшло успішно, але хоча б один із реквізитів зазначено неправильно – всі транзакції спліту (частини) платежу – будуть відхилені.
<br>
Після проведення успішного списання та сплітування по кожній фінансовій транзакції в рамках спліту направляється колбек (нотифікація) про успішний платіж. Приклад коллбека (нотифікації) вказаний у [[MerchantAPI#Повідомлення про платіж|повідомлення про платіж]]'''''.'''''

<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Якщо параметр <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">userPaymentInstrument</span> не є порожнім, створення платежу буде відбуватися автоматично.
</p>

Для різних інструментів передаються такі параметри:

'''userPaymentInstrument –''' інструмент оплати.

'''*Картка (PCI DSS)'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "Card",
"pan": "5168123456780123",
"expire": "MM/YY",
"cvv": "string" }

</syntaxhighlight>

'''*Токенізована Карта'''<syntaxhighlight lang="json" line="1">
{"userInfo":{"phone":"380935207603"}, /Phone,під яким токенізована карта/
…
"userPaymentInstrument": {
"instrumentType": "Card",
"cardGuid": "guid", /токен картки/
}
}

</syntaxhighlight>
'''MasterPass'''<syntaxhighlight lang="json">
{"userInfo":{"phone":"380935207603"}, /телефон реєстрації гаманця MasterPass/
…
"userPaymentInstrument": {
"instrumentType": "MasterPass",
"alias": "string",/Аліас карти в гаманці MasterPass/
}
}

</syntaxhighlight>
'''Kyivstar Money/Life Money /VodafoneMoney'''<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "KSMoney / LifeMoney / VodafoneMoney",
"phone": "380xxYYYYYYY" }

</syntaxhighlight>'''ApplePay/GooglePay'''
<syntaxhighlight lang="json" line="1">
"userPaymentInstrument": {
"instrumentType": "ApplePay / GooglePay",
"token": “string”/Токен, отриманий від Apple | Google /
}

</syntaxhighlight>

* '''partnerInfo –''' інформація про партнера
* '''partnerInfo.name –''' найменування партнера
* '''partnerInfo.id –''' ВД (ЄДРПОУ) партнера
* '''partnerInfo.account –''' рахунок партнера (особовий рахунок/IBAN…)

*

<br>

==== Параметры BrowseInfo при 3DS оплаті ====
У зв'язку з переходом банків - екваєрів на модель роботи 3D Secure 2.x, при створенні замовлення з одночасною передачею інструменту оплати в запиті (карта, токен карти, токен Apple / Google Pay), необхідно передавати додаткові параметри пристрою (браузера) клієнта в заголовках і в тілі запиту createOrder, у прикладі вони виділені:
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p><syntaxhighlight lang="json" line="1">
headers:
[ "appId: b15c4b64-8964-4c80-852e-df59a0e0d9b6",
"pageId: 607514b8-1da5-490a-bdf3-0c6883131625",
"partnerKey: easypay-test",
"sign: XJ3roGhTLwAZXigBp/iVRdsXlZYdTSen3xSM+29GaRg=",
"Content-Type:application/json",
"AcceptHeader:*/*",
"User-Agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"
]

body:
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_3ds2x",
"additionalItems":{
"Merchant.UrlNotify":"http://url.noti.fy"
},
"description":"Easy test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"Card",
"pan":"4444444444444444",
"expire":"0599",
"cvv":"123"
},
"browserInfo":{
"colorDepth":"24",
"screenHeight":"824",
"screenWidth":"1536",
"language":"uk-UA",
"javaEnabled":"false",
"javascriptEnabled": "true"
"timeZone":"-180"
}
}

</syntaxhighlight>'''Параметри''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"><tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AcceptHeader:*/*</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте без змін</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>User-Agent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">передавайте клієнтський User-Agent </td></tr></table>

'''Приклад, як збирати дані на JS:'''<syntaxhighlight lang="markdown" line="1">
getBrowserInfo() {
let browserInfoModel = {};
browserInfoModel.colorDepth = window.screen.colorDepth.toString();
browserInfoModel.screenHeight = window.screen.height.toString();
browserInfoModel.screenWidth = window.screen.width.toString();
browserInfoModel.language = window.navigator.language;
browserInfoModel.javaEnabled = window.navigator.javaEnabled();
browserInfoModel.timeZone = (new Date()).getTimezoneOffset().toString();
return browserInfoModel;
}

</syntaxhighlight>Якщо все передано правильно, то отримайте відповідь як нижче у прикладі '''"Якщо передано userPaymentInstrument (для випадку з 3DSecure)",''' або помилку оплати з картки, наприклад, "Недостатньо коштів".

У випадку, якщо додаткові параметри передані неправильно, отримайте помилку платіжного сервісу, наприклад:<syntaxhighlight lang="markdown">
"errorCode":"PAYMENT_PUMB_SERVICE_FAILURE",
"errorMessage":"Технічна помилка екваєра. Зверніться до служби підтримки EasyPay, або спробуйте пізніше"

</syntaxhighlight>'''Відповідь (RESPONSE)''':<syntaxhighlight lang="json" line="1">
header:
відсутній

body:
{
"accountInfo": null,
"bankingDetails": null,
"amount": 1,
"amountMax": 4999,
"amountMin": 0.01,
"paymentInstrumentsTypes": [
{
"instrumentType": "EMoney",
"commission": 0,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "RCard",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},

{
"walletStatus": "NotRegistered",
"instrumentType": "MasterPass",
"commission": 2,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": []
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 4999,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
}
],
"forwardUrl": https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b,
"error": null,
}

Якщо передано userPaymentInstrument (для випадку з 3DSecure):
{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form action='https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type='hidden' name='PaReq' value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":860094566,
"retrievalReferenceNo":null,
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accountInfo</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">додаткова інформація про послугу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення ServiceKey з тіла запиту CreateOrder'''.'''

</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Якщо параметр відсутній, використовується значення OrderId, передане в тілі запиту CreateOrder.</td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMax</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">максимальна сума платежу за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amountMin</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">мінімальна сума за послугою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>forwardUrl</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">URL сторінки оплати, для партнерів які не мають сертифікатів PCI DSS для обробки карткових даних. Або якщо партнер не має платіжної сторінки. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">на сторінці оплати можемо відключати елементи інтерфейсу:
- логотип EasyPay можемо приховувати

- лічильник часу, що залишився до оплати, може бути відображений/прихований

- поле "Призначення" (можемо вимкнути, або за замовчуванням зробити відкритим/закритим)

- рядок з логотипом партнера та назвою можемо приховати

- поле введення імейл сховати / відобразити

- рядок з "Номер замовлення" приховати/показати
</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentInstrumentsTypes</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список інструментів оплати. Інструменти '''Emoney''', vcard та '''RCard''' видаємо тільки для користувачів, які авторизовані в системі EasyPay. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType'''
* Emoney – гаманець EasyPay
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
* ApplePay – оплата через ApplePay
* GooglePay – оплата через GooglePay
* MasterPass – гаманець MASTERPASS
* QrMasterpass
* LifeMoney – мобільні гроші Лайф.
* KsMoney – мобільні гроші Київстар
* VodafoneMoney – мобільні гроші Водафон
* картки лояльності Fishka
</td>
</tr>
<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>masterPassWalletStatus</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус гаманця MASTERPASS. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення див. у [[MerchantAPI#Створення замовлення на перекази між картами|Створення замовлення на перекази між картами]]
</td>
</tr>
<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>masterPassCommission</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">розмір комісії при оплаті MASTERPASS. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
Можливі значення '''instrumentType'''
* Emoney – гаманець EasyPay
* Card – платіжна картка
* RCard – платіжна картка, підв'язана в системі EasyPay
* ApplePay – оплата через ApplePay
* GooglePay – оплата через GooglePay
* MasterPass – гаманець MASTERPASS
* QrMasterpass
* LifeMoney – мобільні гроші Лайф.
* KsMoney – мобільні гроші Київстар
* VodafoneMoney – мобільні гроші Водафон
* картки лояльності Fishka
</td>
</tr>

</table>

'''3DSecure / mobile payments case:'''<syntaxhighlight lang="json">
Якщо передано userPaymentInstrument (для випадку з 3DSecure):

{
"paymentState":"WaitVerify",
"action":"https://merchantapi.easypay.ua/api/payment/redirect/4df828bf-379b-4e88-8868-f667f12d74a9",
"actionContent":"<html><head></head><body><form" action="https://acs.monobank.com.ua/PaReqVISA.jsp' method='post' id='submitForm'><input type="hidden" name="PaReq" value='eJxVUsluwjAQ/RWUY6VgO2RFg1FoqJpDUgThwNF1XAglS7NUpF9fm4alt3nzxvNm3hjm5/w0+hZ1k5XFTCNjrI1Ewcs0K/YzbZu86K42p5AcaiGCjeBdLShEomnYXoyydKY5mGNuWh966mKmm6lH9HcHY91zLeZMmGkT19EorPy1+KIwCFGpMzYAXaHsWPMDK1oKjH8twpiaBBumBWiAkIs6DCgh9oQ4rmsRW2pgQH9pKFgu6NLf7Fb+7ikIN8k6XGyT8C0GdKGAl13R1j21zQmgK4CuPtFD21bNFCHBmr5i/bhjCJAiAN2HWnUqamSjc5bS+Mj7+Pg5iY5LIwp8HCe7nyjZ4igJZ4BUBaSsFdTABsYecUfEmxIyteQ6lzywXE1AidpgiKFSEv4D8ZgA6Xstz9JTz5XUDYE4V2UhZIU08xYDus/7/Kos5a0yz7Kx6dgWNpStl5R6n0knDBNblwYKAFKP0HAxNBxbRv8+wS+7NLXc' /><input type='hidden' name='TermUrl' value='https://merchantapi.easypay.ua/api/payment/confirm/185ff3c7-8daa-4715-af1a-23f7554d19bb,0e101596-2a6a-4a0e-92e2-dac1e7a5c69d,-1' /><input type='hidden' name='MD' value='ee6eda7e-6252-41af-a696-825e85b34878' /></form><script>document.getElementById('submitForm').submit();</script> </body></html>",
"actionType":"FormRedirect",
"status":"Need3Ds", "alternativeRedirectUrl":"https://merchantapi.easypay.ua/api/payment/altredirect/00f9befe-a200-4e4d-ae27-0a4bdbc443fc",
"transactionId":"860094566",
"retrievalReferenceNo":"null",
"responseItems":{
"SessionId":"a9692063-2db5-4d25-8a66-e62b4476d1e4",
"MerchantOpertion":"CheckPaymentOperationOrder",
"Operation":"CheckPayment",
"BankingDetails":""
},
"error":null
}

Якщо передано userPaymentInstrument (для випадку без 3DSecure):
{
"redirectUrl":null,
"action":null,
"paymentState":"Confirmed",
"status":"Done",
"actionType":"UrlRedirect",
"transactionId":847870521,
"retrievalReferenceNo":null,
"responseItems": null,
"error":null
}

</syntaxhighlight>

<br>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Confirmed''' - платіж підтверджений (кінцевий статус, якщо "status": "done")
* '''WaitConfirm''' - платіж у статусі "обробляється", необхідно додатково запросити фінальний статус платежу
* '''WaitVerify''' - від клієнта очікується підтвердження (наприклад, якщо "status": "Need3Ds" - необхідно пройти перевірку 3D Secure) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Done''' - додаткові дії не потрібні, якщо при цьому "зберіганнядержави":"затверджено", означає платіж повністю успішний. При іншому значенні paymentState- платіж не прийняв кінцевий статус, необхідно запросити статус ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]).
* '''Need3Ds''' - необхідно підтвердження 3D Secure від клієнта ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedConfirmCode''' - необхідно надіслати код перевірки зі смс методом confirmCodeVerification ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])
* '''NeedLookup''' - необхідно надіслати код перевірки з смс '''''методом confirmCodeVerification ('''''[[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]]) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionType</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип наступної дії:

* '''"FormRedirect"''' - необхідно створити сторінку (форму) з html-коду, який передано у параметрі "actionContent" :'''"<html>...</html>",''' відкрити її клієнту, наприклад, для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl".'''
* Після проходження перевірки клієнт буде передресовано на фінальну сторінку EasyPay або на

<code>"urls": {</code>

<code>"success": "string",</code>

<code>"failed": "string"</code>

<code>}</code>

* '''"UrlRedirect"''' - переадресувати клієнта на посилання з "action" або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".'''
* '''"ConfirmCode"''' -необхідно надіслати код перевірки з смс методом '''confirmCodeVerification''' ([[MerchantAPI#Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки|Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки]])

'''"None"''' - можливий при використанні інструменту гаманець '''("instrumentType": "EMoney"),''' кошти успішно списані з гаманця, партнеру надсилається повідомлення про списання. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"<html>...</html>"''' - html форма сторінки банку для введення коду 3DS. Сформувати сторінку з коду та відкрити її клієнту. Після підтвердження платежу відбудеться 302-й редирект на ваші "urls" із запиту createOrder, або на фінальну сторінку EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції в EasyPay </td></tr></table>

'''<br />2DSecure case:'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Confirmed"''' та '''"status": "Done"''' - платіж пройшов успішно. При інших значеннях необхідно перевірити статус '''''платежу''''' '''('''[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]''')''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>status</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"Done" -'''платіж завершено, додаткові дії не потрібні. При '''"paymentState":'''

* '''"Confirmed"''' - означає, що транзакція на стороні EasyPay прийнята (http - оповіщення успішно доставлено партнеру) </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції до EasyPay </td></tr></table>

<br>
==== Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки ====
----У випадку "<code>actionType</code>": "<code>ConfirmCode</code>", клієнту прийде код підтвердження, який потрібно передати до EasyPay
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/confirmCodeVerification</span>
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"code": "string"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{ }
</syntaxhighlight>Якщо "status":"Need3Ds", то клієнту потрібно пройти 3DS перевірку в залежності від значення '''"actionType".'''
<br>
'''Опис параметрів:''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>FormRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно СТВОРИТИ сторінку (форму) з html-коду, який передано у параметрі </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>actionContent</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">"<html>...</html>", відкрити її клієнту для проходження ним 3D-secure перевірки. Альтернативним варіантом є переадресація клієнта за посиланням параметра '''"alternativeRedirectUrl"''' </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>UrlRedirect</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необхідно переадресувати клієнта на посилання з '''"action"''' або переадресувати клієнта за посиланням з '''"alternativeRedirectUrl".''' Відобразиться форма банку емітента картки для перевірки 3D Secure. Після введення коду клієнта переадресує на сторінку успіху чи помилки. Адреси сторінок передаються на етапі створення замовлення.

<code>"urls": {</code>

<code> "success": "string",</code>

<code> "failed": "string"</code>

<code>}</code> </td></tr></table>

<br>

==== Перевірка статусу платежу ====
----

<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/orderState</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers:
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20240524-0015",
"transactionId":"1413668587"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers:
відсутній

body:
"merchantKey":"easypay-test",
"transactionId":1413668587,
"orderId":"test_20240524-0015",
"amount":3.000000,
"paymentState":"declined",
"refundTransactionId":1413673292,
"":
"paymentsList":[

],
"refunds":[
{
"refundTransactionId":1413669380,
"paymentState":"accepted",
"refundAmount":1.10,
"dateAccepted":"2024-05-24T16:14:45+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:14:39+03:00"
},
{
"refundTransactionId":1413673292,
"paymentState":"accepted",
"refundAmount":1.90,
"dateAccepted":"2024-05-24T16:19:40+03:00",
"dateDeclined":null,
"datePost":"2024-05-24T16:19:33+03:00"
}
],
"error":null
}

</syntaxhighlight>
'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;"></th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Фінальний'''
'''статус?'''</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">'''Значення/ подальші дії'''</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>accepted</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;"> '''так'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж прийнято</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>declined</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">так</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж відхилений
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pending</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ні</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">платіж знаходиться в обробці, необхідно повторити запит статусу пізніше
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>none</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">- </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">статус платежу не визначено, необхідно повторити запит статусу до отримання кінцевого статусу</td>
</tr></table>

'''Нетипові відповіді запит статусу:'''

* Якщо платіж не знайдено, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"error":{
"errorCode":"MERCHANT_ORDERID_NOT_FOUND",
"title":null,
"description":null,
"errorMessage":"MERCHANT_ORDERID_NOT_FOUND",
"fieldErrors":[ ]
}

</syntaxhighlight>

* Якщо платіж (сторінка, замовлення) не були відкриті клієнтом або не було спроби оплати, прийде відповідь:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId2",
"amount": 0,
"paymentState": "pending",
"refundTransactionId": null,
"paymentsList": [],
"error": null
}

</syntaxhighlight>

* Якщо отримано помилку на замовлення на етапі визначення реквізитів:
<syntaxhighlight lang="json" line="1">
{
"merchantKey": "easypay-test",
"transactionId": 0,
"orderId": "Some orderId",
"amount": 0,
"paymentState": "declined",
"refundTransactionId": null,
"paymentsList": [],
"error": {
"errorCode": "PROVIDER_ACCOUNT_INVALID", (ерор код може (має) відрізнятися від того, що в прикладі)
"title": "Помилка системи",
"description": "Акаунт не знайдено",
"errorMessage": "string"
}
}

</syntaxhighlight>

При виконанні запиту статусу на замовлення, у яких є спліт (платіжна опція) - повертається наступна модель:

'''Request:'''<syntaxhighlight lang="json" line="1">
headers:

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey":"easypay-test",
"orderId":"full_split_11",
"transactionId":""
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey": "easypay-test",
"transactionId": 991379504,
"orderId": "full_split_11",
"amount": 3.150000,
"paymentState": "accepted",
"refundTransactionId": null,
"paymentsList": [
{
"merchantKey": "easypay-test",
"transactionId": 991379509,
"orderId": "full_split_11",
"amount": 1.030000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379508,
"orderId": "full_split_11",
"amount": 0.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379507,
"orderId": "full_split_11",
"amount": 1.020000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
},
{
"merchantKey": "easypay-test",
"transactionId": 991379506,
"orderId": "full_split_11ID",
"amount": 1.050000,
"paymentState": "accepted",
"refundTransactionId": null,
"date": "2021-09-15T14:07:38+03:00",
"error": null
}
],
"error": null
}

</syntaxhighlight>

'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentsList</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">список платежів у структурі спліту з деталізацією. </td></tr></table>

У випадку зі сплітованими платежами, в основному тілі відповіді '''OrderState''' - параметру '''transactionId''' присвоюється внутрішній технічний номер (нефінансової) операції.<syntaxhighlight lang="json" line="1">
"urls": {
"success": "string",
"failed": "string"
}

</syntaxhighlight>

==== Скасування платежу ====
----Метод викликається '''лише''' для платежів у статусі '''"accepted".''' Для успішного скасування має бути достатньо суми прийнятих платежів у день скасування. Можна скасовувати платежі, які не старші 30 днів. Успішне повернення після цього терміну – не гарантується, залежить від умов банків-еквайєрів.

Повернення суми на картку відбувається в строк 0-3 робочих дні, в окремих випадках – до 30 робочих днів. Це залежить від умов банку-еквайєра, через який пройшов основний платіж, а також банку-емітента.

===== Скасування звичайного платежу =====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "MERCHANT-TEST",
"orderId": "test_20210217-121843",
"transactionId": "913141164",
"amount":"1"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
body
{
"merchantKey":"easypay-test",
"transactionId":913141164,
"refundTransactionId":913141464,
"orderId":"test_20210217-121843",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>

'''<br />Опис параметрів'''
<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">скасована сума </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">для часткового скасування - передається із сумою, яку потрібно скасувати.
для скасування повної суми - параметр amount не передається
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">магазину чи послуги
передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">транзакція рефанду (скасування)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування). Можливі значення: </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* a'''ccepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* p'''ending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен повертати '''"'''<code>paymentState</code>'''":"'''<code>declined</code>'''",''' а запит статусу транзакції скасування - '''"'''<code>paymentState</code>'''": "'''<code>accepted</code>'''"'''

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація ([[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]), на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром "<code>action</code>": "<code>refund</code>'''"''' та сумою (amount), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Скасування платежу (замовлення зі Splitting параметрами) =====
----Скасування платежу (Замовлення) можна робити:

* на всю суму платежу (замовлення)
* на суму одного спліту (Часткова скасування платежу (замовлення))
* на суму меншу від суми спліту (Часткова скасування спліту)
<br>

===== Скасування повної суми платежу (замовлення зі Splitting параметрами) =====
----
* Для скасування повної суми Splitting транзакції необхідно виконати запит статусу транзакції згідно з розділом "[[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]'''"''' використовуючи основний <code>OrderID</code>
* Отриманий у відповіді кореневий <code>transactionID</code> використовувати у запиті [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]]
* У відповідь на запит [[MerchantAPI#Скасування платежу|<code>cancelOrder</code>]] буде отримано відповідь зі статусом скасування, а також буде отримано коллбек по кожній транзакції, яка входила до Splitting транзакції.
* Коллбек на загальну суму Splitting транзакції не надходить.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379504,
}
</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId": 991379504,
"refundTransactionId":913141464,
"orderId":"full_split_11",
"amount":1.000000,
"paymentState":"accepted",
"error":null
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус транзакції рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''Pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>
</tr>

</table>Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати <code>"paymentState"''':"'''declined'''"'''</code> як для основної так і для окремих транзакцій, а запит статусу транзакції скасування - <code>"paymentState":"accepted".</code>

При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде '''одноразово''' надіслано POST - запит із параметром <code>"action": "refund"</code> та сумою (<code>amount</code>), яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

===== Часткове скасування (повернення) платежу (замовлення зі Splitting параметрами) =====
Для часткового скасування платежу необхідно виконати запит <code>cancelCurder</code> використовуючи <code>transactionID</code> який був отриманий в коллбеку (параметр payment_id), а також вказавши суму скасування (вона має бути меншою або дорівнює сумі транзакції, що скасовується).

* У відповідь на запит <code>cancelOrder</code> буде отримано відповідь зі статусом скасування, а також буде отримано коллбек про успішне скасування цієї транзакції.
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;"> /api/merchant/cancelOrder</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"serviceKey": "easypay-test",
"orderId": "full_split_11",
"transactionId": 991379509,
"amount":1.00
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер транзакції, що скасовується, приходить при отриманні коллбека за оплаченим замовленням (параметр payment_id)</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, що скасовується:
для '''часткового''' скасування - передається із сумою, яку потрібно скасувати.
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr></table>

'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"merchantKey":"easypay-test",
"transactionId":"991379509",
"refundTransactionId":"913141464",
"orderId":"full_split_11",
"amount":"1.000000",
"paymentState":"accepted",
"error":"null"
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">оригінальна транзакція, яка була відправлена у запиті cancelOrder</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>refundTransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування)
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"> </td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума, яка була скасована</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">транзакція рефанду (скасування) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''accepted''' - скасування успішне. Створено транзакцію рефанду з негативною сумою
* '''declined''' - скасування пройшло неуспішно
* '''pending''' або будь-який інший статус – вимагає перевірки статусу основної транзакції перед повторним запитом скасування.
</td>

</tr></table>

Якщо скасування пройшло успішно, запит статусу оригінальної транзакції повинен тепер повертати "paymentState":"declined", а запит статусу транзакції скасування - "paymentState":"accepted"
При успішному скасуванні платежу, якщо налаштована HTTP - нотифікація '''(див.''' [[MerchantAPI#Повідомлення про платіж|Повідомлення про платіж]]''')''', на Merchant.UrlNotify буде одноразово надіслано POST - запит із параметром '''"action": "refund"''' та сумою '''(amount)''', яка була скасована. Нотифікація надсилається одноразово без повторних спроб, статус у відповідь код нами не перевіряється.

=== Повідомлення про платіж ===
----
# Партнер обов'язково вибирає 1 або кілька способів сповіщення та повідомляє його в EasyPay. Партнер зазначає платіж успішним на своїй стороні лише після отримання цього повідомлення
# Ми надсилаємо HTTP - колек з IP 93.183.196.26 методом POST з інформацією про платіж.
# Запит надсилає EasyPay партнеру після того, як транзакція набула фінального статусу (Accepted, Declined).
# URL для повідомлень '''(UrlNotify)''' партнер направляє у запиті '''createOrder''' у параметрі:
<br>
<syntaxhighlight lang="json" line="1">
"order":{
"additionalItems":{
"Merchant.UrlNotify":"https://notify.url"
}
}
</syntaxhighlight>
<br>
"Merchant.UrlNotify" Параметр не може бути порожнім і має відповідати формату URL.
<br>

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> Якщо у відповіді не отримано <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">HTTP StatusCode 200</span>, запит нотифікації буде надіслано повторно протягом <strong>1-10 хвилин</strong>.
Повторення може продовжуватися визначену кількість разів (за замовчуванням – <strong>50 разів</strong>), поки не буде отримано статусу <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #198754;">"200 ОК"</span>.
</p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Sign": "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
body
{
"OperationType": "Payment",
"PartnerKey": "groshi-com",
"ServiceKey": "GROSHI-COM-GOOGLEPAY",
"TransactionStatus": "Accepted",
"MerchantOrderId": "3127194_28_450866",
"DateTime": "2023-12-09T14:00:48",
"Amount": 2059.08,
"Commission": 28.83,
"TransactionId": 1336448544,
"AdditionalItems": {
"Merchant.Inn": "3178404189",
"Merchant.Details": ";0;0;;4;",
"Merchant.UrlNotify": "https://testpartner.ua/callback",
"Merchant.ClientFullName": "Іванов Дмитро"
"Acquirer.MerchantId":"12345678"
"Acquirer.TerminalId":"E1234567"
"Card.BrandType":"Visa"
"AuthCode":"012345"
}
}

</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">

<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>OperationType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''Можливі значення:'''
'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)

'''refund -''' про успішне скасування платежу (відправляється разово)
</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>PartnerKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>ServiceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionStatus</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>MerchantOrderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.MerchantId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор торговц'''я''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Acquirer.TerminalId</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор платіжного пристрою </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>Card.BrandType</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">найменування платіжної системи, платіжний інструмент якої використовується </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>AuthCode</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">Код авторизації </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>DateTime</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">якщо партнер не відповість статусом 200 на запит з action:payment, то в наступному запиті час буде новим</td>
</tr>


<tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>TransactionId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ID транзакції на стороні EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr>

</table>
<br>Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.
Для правильного обчислення підпису, тіло з нотифай потрібно брати як є, без перетворень та форматувань.
У випадку, якщо підпис notify не перевірено, всі фінансові ризики перекладаються на партнера.

==== Отримання інформації про рекурентний платіж ====
----
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/info</span></p>

'''Request'''<syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="
queryParams
"serviceKey": "string"
"orderId": "string"
"reccurentId": "0"
"dateFrom": 2025-03-10
"dateTo": 2025-03-17
"isEnabled": true|false
"pageNumber": 1
"countPerPage": 3

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"merchantReccurentPaymentDetails":[
{
"recurrentId":14433854,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601+url",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:38:02+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:42+02:00",
"properties":{
"failedCount":"1",
"urlNotify":"http://109.251.205.8:9987/merch/notifysigncheckexample.php"
}
},
{
"recurrentId":14433852,
"orderDescription":"Easy payment",
"serviceName":"Мерчант Тест UA",
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20250312-153601",
"amount":1.000000,
"croneRule":"* 17 * * *",
"dateCreate":"2025-03-12T16:37:25+02:00",
"dateRun":"2025-03-13T17:00:00+02:00",
"dateLastPayment":"2025-03-12T19:47:05+02:00",
"isEnabled":true,
"dateExpire":"2025-03-12T21:37:03+02:00",
"properties":{
"failedCount":"1"
}
}
],
"totalCount":2,
"totalFilteredCount":2,
"pageFilteredCount":2,
"currentPageNumber":1,
"numberOfPages":1,
"error":null
}

</syntaxhighlight><table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ІД сервісу партнера у системі EasyPay </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>reccurentId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекурента </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateFrom</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента з.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>dateTo</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">дата створення рекурента по.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>isEnabled</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити лише активні / або неактивні рекуренти </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>pageNumber</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">відобразити сторінку номер.. </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>countPerPage</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">кількість записів на сторінці </td></tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>templateId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер рекуренту (reccurentId) </td></tr></table><br>

==== Виклик рекурентного платежу ====
----
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/reccurent/payment</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"reccurentId": 0,
"amount": 0
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"reccurentId": 0,
"transactionId": 0,
"transactionStatus": "None",
"error": {
"errorCode": "string",
"title": "string",
"description": "string",
"errorMessage": "string",
"fieldErrors": [
{
"fieldName": "string",
"errorCode": "string",
"errorMessage": "string"
}
]
}
}

</syntaxhighlight>Також буде надіслано нотифікацію у разі успішного платежу. Створення рекурентного платежу на операцію, у структурі якої є спліт – не підтримується.

<br>

=== Видалення рекурентного платежу ===
----
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/reccurent/delete/{id}</span>
</p>

'''Request''' <syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
відсутній
</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers

-

body

-
</syntaxhighlight>

== Перекази та «безпечна угода» ==
----

=== Створення замовлення на перекази між картами ===
Призначений для перевірки створення переказів між картами та реалізації функціоналу безпечної угоди на ресурсах мерчанта. Перед викликом цього методу потрібно:

# мати доступні AppID та PageID, отримані за методами: CreateApp ([[MerchantAPI#Реєстрація точки та створення сесії|Реєстрація точки та створення сесії]]) та CreatePage ([[MerchantAPI#Створення сесії|Створення сесії]]);
# отримати serviceKey, який підтримує операції переказів з картки на картку;
<br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span><syntaxhighlight lang="json" line="1">
headers
"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1001.0,
"paymentOperation":"Hold",
"additionalItems": {},
"expire": "2019-04-15T07:49:20",
"fields": [
{
"fieldName": "Pan",
"fieldValue": "5555444433332222",
"fieldKey": " bb37c1ef-3345-412e-8e76-4a6a48f64f70",
}
]
},
"urls": {
"success": "string",
"failed": "string"
}
</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги Мерчант</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">видає EasyPay</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>description</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">опис замовлення </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 120 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума замовлення, роздільник – точка </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentOperation</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип платіжного процесу </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalItems</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">необов'язкові додаткові параметри
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">наприклад:
<code>"additionalItems":{ "Merchant.Param1":"CustomValue" }</code>,
де Merchant.Param1 - індивідуальний параметр партнера Param1
узгоджується з EasyPay;
</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldName</code>''' </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''Pan''' – значення параметра для ініціювання списання перекладу карту. Обов'язкове заповнення;
* '''fieldValue: "5555444433332222"''' – вказується номер картки, куди потрібно зарахувати переказ (опціонально, альтернатива fieldKey);
* '''fieldKey''': " bb37c1ef-3385-412e-8e76-4a9448f64f70" –вказується GUID токена, куди слід зарахувати переказ (опціонально, альтернатива fieldValue);
* '''expire -''' час життя замовлення. Після закінчення заданого часу замовлення сплатити неможливо. Час життя сторінки може відображатися на платіжній сторінці у вигляді таймера (за замовчуванням таймер вимкнено). Значення має бути більшим за поточний час на 6 хвилин. Значення за замовчуванням – 3 дні. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>urls</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">
* '''success -''' url сторінки успіху, для редиректу клієнта у разі успішної оплати (після оплати клієнт може не дочекатися редиректу на цей url, тому редирект '''не можна використовувати як індикатор успішної оплати,''' отримання оповіщення про успішний платіж - '''див. п. 2.7)'''
* '''failed''' - url сторінки помилки для редиректу клієнта у разі неуспішної оплати. Приклад get-параметрів, які приходять на url.failed та url.succes (те ж, але без errorCode): </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">?serviceKey=merchanttest-5310&orderId=re9r9er94jr&amount=1.20&description=
Тестове+описання+замовлення&transactionId=722443797&date=2019-0611T14:49:07&recurrentId=&''errorCode=PAYMENT_ALFABANK_-2006''&sign=
eYkFYixpB3wnKoZDzkAiqWgdMkeHETDWmDsFMCaPO44=</td>

</tr></table>

'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
"forwardUrl": "https://easypay.ua/whitepage/81b14a73-730c-40d4-8064-ce1c10e0c53b",
"error": "null",
</syntaxhighlight>Для введення даних картки на платіжній сторінці користувач повинен бути переадресований за '''forwardUrl.'''

Після введення клієнтом даних картки на платіжній сторінці та завершення успішного списання коштів з картки – платіж буде поставлений у статус захолдованого. Перевірка статусу здійснюється викликом методу OrderState ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]). Для завершення переказу на картку (перерахування на картку Одержувача) необхідно викликати метод [[MerchantAPI#Завершення переказу на карту Одержувача|Завершення переказу на карту Одержувача]]

При необхідності скасувати переказ (повернути суму відправнику) – потрібно викликати метод CancelOrder ([[MerchantAPI#Скасування платежу|Скасування платежу]]). Скасування частини суми переказу – неможливе. Лише скасування на повну суму.
<br>
<p style="border: 1px solid #E67E22; background-color: rgba(230, 126, 34, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
<strong style="color: #E67E22;">Важливо!</strong> Завершення переказу ([[MerchantAPI#Завершення переказу на карту Одержувача|Завершення переказу на карту Одержувача]]) або повне скасування переказу ([[MerchantAPI#Скасування платежу|Скасування платежу]]) мають бути виконані протягом 30 днів з дати створення переказу ([[MerchantAPI#Створення замовлення на перекази між картами|Створення замовлення на перекази між картами]]).
</p>

=== Завершення переказу на карту Одержувача ===
----Призначений для завершення перекладу після створення за методом [[MerchantAPI#Створення замовлення на перекази між картами|Створення замовлення на перекази між картами]]

Перед викликом цього методу потрібно мати доступні AppID та PageID, отримані за методами CreateApp ([[MerchantAPI#Реєстрація точки та створення сесії|Реєстрація точки та створення сесії]]) та CreatePage ([[MerchantAPI#Створення сесії|Створення сесії]])

<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">api/merchant/unHoldOrder</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order": {
"serviceKey": "string",
"orderId": "string",
"transactionID": "string",
"fields": [
{
"fieldName": "Pan",
"fieldValue": "1111222233334444"
"fieldKey": "af27c751-1b8b-47a8-94b3-14507e93b44a"}
</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>serviceKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">ідентифікатор послуги Мерчант</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">видає EasyPay</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний номер транзакції у системі EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 120 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldName</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''Pan –''' значення параметра для ініціювання списання перекладу карту. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldValue</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''5555444433332222''' – вказується номер картки, куди потрібно зарахувати переклад (опціонально, альтернатива fieldKey) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>fieldKey</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''"bb37c1ef-3385-412e-8e76-4a9448f64f70"''' – вказується GUID токена, куди слід зарахувати переклад (опціонально, альтернатива fieldValue).
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''
</td>
</tr></table>

'''Response''' <syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"paymentState": "pending",
"orderId": "Test Hold134",
"amount": 1.05,
"transactionId": 1046180773,
"error": null
}
</syntaxhighlight>'''Опис параметрів'''<table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>amount</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">сума завершеного переказу</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>error</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">код помилки </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>orderId</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний ідентифікатор номера замовлення у системі партнера </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">до 120 символів</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>transactionID</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">унікальний номер транзакції у системі EasyPay </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>paymentState</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">статус платежу. </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі paymentState:

* '''accepted (фінальний статус) - переказ успішно завершено;'''
* '''declined (фінальнильнй статус) -переказ не завершено;'''
* '''pending (не фінальний статус) - платіж знаходиться в обробці, необхідно повторити запит статусу пізніше;'''
* '''paymentHold (не фінальний статус) - гроші з картки Відправника списано, але переказ не завершено на картку Одержувача;'''
* '''none (-) - статус платежу не визначено, необхідно повторити запит статусу до отримання кінцевого статусу;'''</td>
</tr></table>

Для отримання актуального статусу переказу потрібно викликати OrderState ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]])

== Робота з токенізованими картами ==
----

=== Токенізація карти ===
Метод призначений для токенізації (збереження) картки для ідентифікатора користувача під конкретним торговцем.

===== Токенізація з передачею даних картки у запиті (заборонено без PCI:DSS сертифікації мерчанта) =====
Перед викликом цього методу. Потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]]

'''-''' [[MerchantAPI#Створення сесії|CreatePage]] <br>
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCard</span></p>
<br>
'''Request''' <syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "380501002030ws",
"pan": "4874120123567889",
"expire": "1222",
"cvv": "012",
"vсode": "123654"
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"activateCodeType": "code|amount",
"cardGuid: "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan”: "48741201****1234",
"expire”: "1222"
"error": "null"
}

</syntaxhighlight>Токенізація картки - процес двоетапний.

На першому етапі у запиті йдуть параметри картки та номер телефону користувача. У відповіді, залежно від '''activateCodeType''', може бути активація за кодом підтвердження з виписки або SMS або за сумою списання.

З другого краю етапі до всіх параметрів додається ще vcode – код верифікації. При успішному відповіді прийдуть параметри токенізованої карти чи помилка.

===== Токенізація за допомогою введення даних картки користувачем на сторінці (сертифікація PCI:DSS не потрібна) =====
Перед викликом цього методу, потрібно викликати один із методів:

'''-''' [[MerchantAPI#Реєстрація точки та створення сесії|CreateApp]];

'''-''' [[MerchantAPI#Створення сесії|CreatePage]];
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">api/merchant/tokenCard/create</span></p>
'''Request'''<syntaxhighlight lang="json" line="1">
headers
"Content-Type: application/json"
"PartnerKey: partnerName"
"locale: ua"
"AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"phone": "8888",
"expire": "2020-12-06T12:54:32.043Z",
"urls": {
"success": "https://test.ua",
"failed": "https://test1.ua",
"notify": "https://test2.ua",
"back": "https://test3.ua"
},
"description": "testtts",
"checkExistingToken": false
"operationType":"SingleToken | createToken | ExistingToken"
}

</syntaxhighlight>

'''Response'''<syntaxhighlight lang="json" line="1">
headers

body
{
"forwardUrl": "https://easypay.ua/ua/tokencard/cae16afc-be56-4a39-8ce1-5de4f4142e76",
"error": null
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>description</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |опис, який відобразиться на сторінці токенізації
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час життя сторінки токенізації (по дефолту - 15 хвилин)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережеться картка (будь-які літери, цифри, GUID.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |'''Не повинен містити символ ‘+’'''
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>urls</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |містить інформацію про:

* сторінці успіху партнера (success) для переадресації клієнта після успішної токенізації, потрібно обов'язково передавати
* сторінці помилки ('''failed''') для переадресації клієнта у разі помилки
* адреса для відправки callback-запиту з деталями при успішній токенізації ('''notify''')
* адресу для повернення назад зі сторінки токенізації ('''back''')
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>forwardUrl</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |сторінка для додавання картки (токенізації)
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>checkExistingToken</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |перевірка наявності токена по карті, що вводиться у даного партнера.
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |Параметр може набувати значення:

* true - проводити валідацію на наявність раніше створеного токена по цій карті;
* false - валідація відсутня;
* null - валідація відсутня;

Якщо параметру '''checkExistingToken''' присвоєно значення true, слід очікувати наступних сценаріїв поведінки:

* “checkExistingToken” : '''true,''' і в системі '''немає раніше створених токенів''' під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''true,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) - користувачу відкривається сторінка успіху, додаткова верифікація (надсилання коду верифікації не відбувається), токен не створюється, а в callback вказується '''масив раніше створених токенів''';
* “checkExistingToken” : '''false / null,''' і в системі немає раніше створених токенів під зазначену карту під даним партнером (partnerKey) - формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену;
* “checkExistingToken” : '''false / null,''' і в системі '''є раніше створені токени''' під зазначену карту під даним партнером (partnerKey) – формується запит на верифікацію введених даних картки (надсилання коду верифікації). За результатом успішної верифікації – створюється токен. При неуспішній верифікації – токен не створюється. У callback пишуться дані щодо створеного токену.
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>operationType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |''(Новий параметр) задає тип операції токенізації''
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
* '''SingleToken''' - для однієї карти завжди повертається той самий токен. Логіка така:

* перевіряємо чи є токен для цієї картки під '''partnerKey''' із запиту

* якщо є 1 або більше токенів - беремо останній з них, створюємо новий запис з цим токеном для переданого ідентифікатора клієнта '''(phone)''', відправляємо цей токен в callback у кореневому параметрі '''cardGuid'''
* якщо токенів немає - створюємо новий для цього '''phone''' і відправляємо його в callback в кореневому параметрі '''cardGuid''' (один і той же '''cardGuid''' може бути прив'язаний до різних phone)

* '''createToken''' - значення за замовчуванням, звичайне створення токена (можна не передавати)
* '''ExistingToken''' - поведінка аналогічна '''checkExistingToken:true'''
|}
'''На сторінці токенізації можемо керувати інтерфейсом (на стороні EasyPay):'''
* відображати/сховати логотип EasyPay
* відображати/приховати логотип та назву партнера
* відображати/приховати опис з деталями токенізації
* відображати опис у згорнутому/розгорнутому вигляді

'''Приклад callback - запит з IP адреси 93.183.196.26 після успішної токенізації:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers

Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"partnerName",
"phone":"test989",
"cardGuid":"2ad57b2e-eb5b-4a99-ad05-788cf589b8af",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-02-24T17:32:07.447",
"codeType":"Mpi3Ds"
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>phone</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ідентифікатор клієнта, під яким збережено картку
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>cardGuid</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |токен збереженої карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>pan</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |маскований номер картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>expire</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |термін дії карти
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>datePost</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |час додавання картки
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>codeType</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |ознака типу верифікації картки. Mpi3Ds – з використанням 3ds.
|}

'''Приклад callback - запит з IP адреси 93.183.196.26 з параметром ExistingToken:'''

'''Request'''<syntaxhighlight lang="json" line="1">
headers
Sign : AStbusXxzYdr48vssdr4/VXZCITrad8vr1A/tWhCBP8=

body
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":null,
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:41:53.152",
"codeType":"Code",
"existingTokens":[
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"bac4f855-xxxx-xxxx-bece-14cdf23c6c52",
"pan":"44411122****3558",
"expire":"0524",
"datePost":"2021-05-18T18:28:23.840",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"6338e8b4-xxxx-xxxx-a3e5-f46ad0cb0efa",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:34:25.733",
"codeType":"Mpi3Ds"
},
{
"partnerKey":"easypay-test",
"phone":"380509899549",
"cardGuid":"18e3c35e-xxxx-xxxx-ba59-9506154394c0",
"pan":"44411123****3558",
"expire":"0524",
"datePost":"2021-05-18T18:39:42.010",
"codeType":"Mpi3Ds"
}
]
}

</syntaxhighlight>
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>existingTokens</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |масив з даними раніше створених токенів по цій карті під даного партнера '''(partnerKey)'''
|}

===== Отримання списку токенізованих карт =====
----Метод призначений для отримання списку токенізованих карток за номером телефону (ознакою) користувача.
<br>
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/tokenCards/get</span></p>
'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams
phone = string
cardGuid= Guid
</syntaxhighlight>'''Response''' <syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"tokenCards": [
{
"cardGuid": "55F5118B-B695-43BA-8555-AF8B698C4D2C",
"pan": "48741234****1234",
"expire”: "1222"
}],
"error": "null"
}

</syntaxhighlight>Якщо передати тільки ідентифікатор клієнта (параметр phone) - у відповіді будуть всі карти поточного клієнта. Якщо передати <code>phone</code> та <code>cardGuid</code> - у відповіді буде одна карта поточного клієнта.

<br>

===== Видалення токенізованих карт =====
----Метод призначений для видалення токенізованих карток за номером телефону. Якщо у клієнта під одним номером кілька карток, всі картки будуть видалені.
<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone</span>

<p style="border: 1px solid rgba(255, 0, 0, 0.5); background-color: rgba(255, 0, 0, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 100px;">
<span style="position: absolute; top: 50%; left: 10px; background-color: #FF0000; color: #FFFFFF; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold; border: 2px solid #FF0000; transform: translateY(-50%);">DELETE</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px; color: #333333;">/api/merchant/tokenCards/delete/phone?CardGuid=Guid</span></p>'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

'PartnerKey: partnerName'
'locale: ua'
'AppId: a5806a5f-dbb8-496a-a23f-aab6d2fcbce1'
'PageId: 2ce7dba6-4600-456e-b9c8-f13cacf1c85d'
'TimeStamp: 1554360173'
'Sign: e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4='

queryparams

cardGuid= Guid

</syntaxhighlight>'''Response'''<syntaxhighlight lang="markdown" line="1">
headers
відсутній

body
відсутній
</syntaxhighlight>

===== Видача кредиту (переказ на картку користувача) =====
Метод призначений для переказу на картку користувача суми кредиту.
<p style="border: 1px solid #9ACD32; background-color: rgba(192, 255, 192, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span>
</p>Перед викликом цього методу потрібно викликати один із методів:

* [[MerchantAPI#Реєстрація точки та створення сесії|CreateAPP]]
* [[MerchantAPI#Створення сесії|CreatePage]]
<br>
'''Request:'''<syntaxhighlight lang="json" line="1">
headers

"Content-Type": "application/json"
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

body
{
"order":{
"serviceKey":"CARD-FILL",
"description":"test top up card",
"amount":1.12, (decimal)
"orderId":"test",
"fields":[
{
"fieldName":"Pan",
"fieldValue":"4102321200001111",
"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"
},
{
"fieldName":"Phone",
"fieldValue":"38093520000"
}
],
"additionalItems": {
"Merchant.ClientFullName": "Иванов Петр Сергеевич",
"Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32",
"Merchant.Inn": "3334445823"
}
},
"userPaymentInstrument":{
"instrumentType":"Vcash"
}
}

</syntaxhighlight>'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"redirectUrl": null,
"action": null,
"paymentState": "Confirmed",
"status": "Done",
"actionType": "UrlRedirect",
"transactionId": "766934634",
"retrievalReferenceNo": "null",
"responseItems": "null",
"error": "null"
}

</syntaxhighlight>'''Опис параметрів'''
{| style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;"
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Параметр
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Характеристика
! style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;" |Коментарій
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |paymentState
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |
* '''Confirmed''' оплата пройшла успішно
* '''WaitConfirm ''' очікується підтвердження платежу
* '''Rejected''' і '''Refunded''' платіж відхинело
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |
|-
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" |'''<code>transactionId</code>'''
| style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;" | ідентифікатор платежу в системі Easypay
| style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;" |У об'єкти поля передається інформація для поповнення карти. Номер картки можна вказувати:

* для випадку з PCI DSS сертифікацією: у відкритому вигляді

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldValue":"4102321200001111",</code>'''

* для випадку без PCI DSS сертифікації: у вигляді токена (як отримати токен картки - див. [[MerchantAPI#Токенізація карти|Токенізація карти]]):

'''<code>"fieldName":"Pan",</code>'''

'''<code>"fieldKey":"b95d541a-c11f-49bc-9042-295dbf74ccn6"</code>'''

Також потрібно вказати:

- номер телефону клієнта:

'''<code>"fieldName":"Phone",</code>'''

'''<code>"fieldValue":"38093520000"</code>'''

- ПІБ та адреса клієнта АБО ПІБ та ІПН клієнта:

'''<code>"additionalItems": {</code>'''

'''<code> "Merchant.ClientFullName": "Іванов Петро Сергійович"</code>'''

'''<code> "Merchant.Address": "04080, Київ, вул.Межигірська 82а корп.Б, кв.32"</code>'''

'''<code> "Merchant.Inn": "3334445862"</code>'''

'''<code> }</code>'''
|}

'''Статус видачі кредиту:'''

* Якщо у відповіді отримано кінцевий статус <code>(paymentState = Confirmed / Rejected / Refunded)</code> - необхідно присвоїти його платежу.
* Якщо кінцевий статус у відповіді не отримано <code>(paymentState = WaitConfirm)</code>, '''у тому числі при серверних, мережевих та будь-яких інших відповідях та помилках''' - необхідно запросити статус платежу методом '''orderState''' ([[MerchantAPI#Перевірка статусу платежу|Перевірка статусу платежу]]) до отримання кінцевого статусу.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Важливо врахувати, що нотифікація про оплату не надсилається (якщо партнер/мерчант не повідомив про необхідність такого налаштування).<br><br>
Скасування транзакції не передбачено.
</p>
<br>

Response (Приклади відповідей при помилках: status code = 400)<syntaxhighlight lang="json" line="1">
{
"error": {
"errorCode": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"title": null,
"description": null,
"errorMessage": "MERCHANT_CREATEORDER_VALIDATION_EXCEPTION",
"fieldErrors": [
{
"fieldName": "Order.Fields[0]",
"errorCode": "SERVICE_FIELDS_VALIDATION_EXCEPTION",
"errorMessage": "Вказана умова не була виконана для значення поля."
}
]
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pv2",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Обслуговуються тільки карти емітовані українськими банками",
"fieldErrors": []
}
}

{
"error": {
"errorCode": "PAYMENT_ALFABANK_CASH2CARD_C2Pa8",
"title": "Платіжна помилка",
"description": "Платіжна помилка",
"errorMessage": "Необхідно уточнити реквізити картки одержувача у банку емітента",
"fieldErrors": []
}
}

</syntaxhighlight>

===== Нотифікації (колбеки) щодо операцій поповнення карток =====
Дані колбеки є опціональним (додатковим) способом отримання інформації від EasyPay про результат виконання запиту на поповнення картки.

Для активації отримання колбеків мерчант (партнер) повинен повідомити EasyPay про таку необхідність, після чого EasyPay включає цю опцію.

Спосіб відправки колбека - '''HTTP - з IP 93.183.196.26''' буде надіслано '''POST''' запит з інформацією про платіж на вказаний <code>urlNotify</code>.

<code>urlNotify</code> прописується на стороні EasyPay і використовується за замовчуванням, якщо партнер не передав його у своєму запиті.

URL для повідомлень ('''UrlNotify''') повідомляє партнер (мерчант).

Партнер може передавати '''UrlNotify''' у запиті '''createOrder''' у параметрі:

<code>"order":{</code>

<code>"additionalItems":{</code>

<code>"Merchant.UrlNotify":"<nowiki>https://notify.url</nowiki>"</code>

<code>}</code>

<code>}</code>

"Merchant.UrlNotify" параметр не може бути порожнім і повинен відповідати формату URL.

Якщо у відповідь не отримано HTTP StatusCode 200 - запит нотифі буде надіслано повторно, доки не отримано статусу “200 ОК”.

Коли нотифікацію (колбек) успішно доставлено (отримано статус 200 ОК), повторне відправлення колбеків припиняється.

Відправлення колбеків можливе за двома сценаріями:

1) лише за успішними операціями (транзакціями);

2) за операціями (транзакціями) у фінальному статусі (успішні та відхилені).

Надання фінального статусу операції (транзакції) асинхронно з процесом відправки колбека (фінансова транзакція набуває фінального статусу незалежно від статусу прийняття колбека партнером).

'''Request'''<syntaxhighlight lang="markdown" line="1">
headers

"Sign: "Bq2d0oaqVGMRWpX5wsGpOlpqLg42pBdDO7TfTPYVmnU="
"User-Agent": "EasyPay.MerchantNotifyService"

body

{
"action": "payment",
"merchant_id": 5347,
"order_id": "5",
"date": "2019-06-19T15:38:10.7802613+03:00",
"details": {
"amount": 1.00,
"desc": "Wooden tables x 10",
"payment_id": 724502946,
"recurrent_id": null
},
"additionalitems": {
"BankName": "CB PRIVATBANK",
"Card.Pan": "414962******1234",
}
}

</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>action</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">тип оповіщення</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">'''payment -''' про успішний платіж (повторюється, якщо у відповідь не отримано статусу 200)</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>merchant_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер сервісу партнера на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>order_id</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">номер замовлення партнера із запиту createOrder; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;"></td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>date</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">час надання платежу статусу на стороні EasyPay; </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">необов'язковий параметр ('''потрібно вказати, якщо потрібно замінити картку Одержувача)'''</td>

</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>details</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">детальна інформація про платіжну операцію (транзакцію) </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''payment_id -''' ID детальна інформація про платіжну операцію (транзакцію):
* '''amount''' - сума фінансової операції;
* '''desc''' - опис замовлення, отриманий під час запиту CreateOrder;
* '''recurrent_id''' - ознака реккурентного платежу (завжди за замовчуванням на операціях поповнення картки – null);</td>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>additionalitems</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">блок додаткових параметрів, до якого можуть включатися додаткові айтеми, отримані в запиті CreateOrder:
</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">
* '''BankName''' - назва банку власника картки;
* '''Card.Pan -''' номер картки у маскованому вигляді.</td>
</tr></table>

Необхідно перевіряти підпис у нашому HTTP notify, налаштувати прийом лише для наших IP 93.183.196.26.

<p style="border: 1px solid #FFA500; background-color: rgba(255, 165, 0, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
⚠️ <strong>Важливо!</strong> У випадку, якщо підпис <span style="background-color: #EDEDED; padding: 2px 5px; border-radius: 4px; font-family: monospace; color: #D63384;">notify</span> не перевірено, всі фінансові ризики перекладаються на партнера.
</p>

== Інтеграція з ApplePay ==
----Вимоги

# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитись з умовами надання послуг Apple Pay.
# Необхідно укласти договір із Easypay.ua.
<br>Apple Pay надає простий та безпечний спосіб проведення платежів у додатках iOS, watchOS та сайтах Safari. Використовуючи Face ID, Touch ID або двічі клацнувши Apple Watch, користувачі можуть швидко та безпечно передавати свої платіжні дані для оплати.

=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка Apple Pay буде відображена на сторінці оплати EasyPay

=== Оплата ApplePay з додатку ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], в який потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимоги до брендування].

<br>
==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.

''Примітка: * - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).''

# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay

==== Технічна інтеграція з ApplePay ====

# Щоб інтегрувати Apple Pay у мобільний додаток, дотримуйтесь інструкцій за посиланням: https://developer.apple.com/documentation/passkit/apple_pay.

'''Приклад відповіді ApplePay'''<syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>2. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token в Easypay</code> ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Приклад запиту '''createOrder''':<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{ApplePayMerchantId}"
}
}

</syntaxhighlight>

=== Оплата із сайту ===
----'''Вимоги:'''

# Необхідно мати акаунт у [https://developer.apple.com/ Apple Developer], до якого потрібно зареєструвати індивідуальний [https://help.apple.com/developer-account/#/devb2e62b839?sub=devf31990e3f Merchant ID].
# Необхідно дотримуватися [https://developer.apple.com/apple-pay/marketing/ вимог до брендування].

==== Реєстрація та перевірка в системі Apple Pay ====

# Зареєструйте MerchantID та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Додайте новий Merchant ID, натиснувши на "+" у верхньому правому куті екрана.
## Заповніть поля * і натисніть «Continue».
## Натисніть Register, щоб підтвердити введені дані.
## Повідомте EasyPay ваш MerchantID.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - Description – опис; Identifier – домен вашого сайту у зворотному порядку, з додаванням «merchant» на початку (наприклад, сайт shop.ua, Identifier – merchant.ua.shop).</em>
</p>
<br>
# Отримайте від EasyPay сформований CSR-файл, який буде необхідний для подальших кроків.
# Сформуйте Apple Pay Payment Processing Certificate та надішліть до EasyPay:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Payment Processing Certificate, натисніть "Create Certificate".
## На наступному екрані натисніть Continue.
## Візьміть отриманий від EasyPay CSR-файл і завантажте його на сайт, натиснувши Choose File, а потім Continue.
## Завантажте згенерований сертифікат.
## Надішліть сертифікат (файл apple_pay.cer) до EasyPay
# Зареєструйте та підтвердіть свій домен:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі "Merchant Domains" натисніть "Add Domain".
## Введіть ім'я домену та натисніть "Continue" *.
## Завантажте файл apple-developer-merchantid-domain-association.txt.
## Збережіть файл на сервері від Apple.
## Натисніть Verify.
<br>
<p style="border: 1px solid #4A90E2; background-color: rgba(74, 144, 226, 0.1); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; color: #333; position: relative;">
Примітка: <em>* - домен повинен підтримувати HTTPS.</em>
</p>
<br>
# Створіть Apple Pay Merchant Identity Certificate:
## Увійдіть до свого облікового запису [https://developer.apple.com/ Apple Developer Account].
## Перейдіть до розділу «Certificates, Identifiers & Profiles».
## У розділі "Identifiers" виберіть "Merchant IDs".
## Виберіть створений вами Merchant ID та натисніть «Edit».
## У розділі Apple Pay Merchant Identity Certificate натисніть Create Certificate.
## Виконайте дії, описані на сайті Apple, а потім натисніть «Continue».
## Скопіюйте згенерований CSR-файл, вибравши Choose File, а потім Continue.
## Завантажте згенерований сертифікат (merchant_id.cer) і відкрийте його у програмі Keychain Access на комп'ютері Mac.
## У Keychain Access виберіть сертифікат, що імпортується, та експортувати його у формат .p12 (Personal Information Exchange).
## Виконайте команду: openssl pkcs12 -in merchant_id.p12 -out merchant_id.pem -nodes -clcerts
## Скопіюйте створений сертифікат у форматі PEM на сервер. Це буде потрібно для створення [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/requesting_an_apple_pay_payment_session Apple Pay Payment Session] в процесі [https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/providing_merchant_validation перевірки магазину].

<br>
==== Технічна інтеграція з ApplePay ====
Для створення сертифікату (-ів) від Партнера потрібні:

# Country Name (2 letter code) [AU]: ?
# State or Province Name (full name) [Some-State]: ?
# Locality Name (eg, city) []: ?
# Organization Name (eg, company) [Internet Widgits Pty Ltd]: ?
# Organizational Unit Name (eg, section) []: ?
# Common Name (e.g. server FQDN or YOUR name) []: ?
# Email Address []: ?

Повідомте, чи буде оплата тільки в додатку, або також і на WEB.

Щоб інтегрувати Apple Pay на сайт, дотримуйтесь інструкцій за [https://developer.apple.com/documentation/apple_pay_on_the_web. посиланням]

# Перевірте можливість оплати з Apple Pay. Виконується перевірка, підтримує або браузер оплату з Apple Pay, а також є у Wallet картку, якою можна оплачувати.
<syntaxhighlight lang="markdown" line="1">
if (window.ApplePaySession) {
var promise = ApplePaySession.canMakePaymentsWithActiveCard({YOUR_MERCHANT_ID});
promise.then(function(canMakePayments) {
if (canMakePayments)
});
} else {
}

</syntaxhighlight>
2. Сформуйте структуру платежу для сесії<syntaxhighlight lang="markdown">
document.getElementById("apple-pay-button").onclick = function(event) {
var paymentRequest = {
currencyCode: 'UAH',
countryCode: 'UA',
total: {
label: {PRODUCT_NAME},
amount: {PAYMENT_AMOUNT}
},
merchantCapabilities: ['supports3DS'],
supportedNetworks: ['masterCard', 'visa']
};

var session = new ApplePaySession(3, paymentRequest)

</syntaxhighlight>
3. Відкрити платіжну сесію з Apple, отримати від них paymentData:
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/applePay/validateSession</span><syntaxhighlight lang="json" line="1">
headers

--header "Content-Type: application/json"
--header "AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209"
--header "PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760"
--header "PartnerKey: easypay-test"
--header "locale: ua"

body
{
"url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
"merchantIdentifier": "string", /ідентифікатор мерчанту в Apple/
"displayName": "test", /ідентифікатор магазина/послуги/товару (латиниці) ; буде відображатися в toolBar/
"initiative": "web", /Канал оплати/
"initiativeContext": "string" /Доменне ім’я, Доменное имя, пов'язане із сертифікатом Apple Identity/
}

</syntaxhighlight><blockquote>*response з цього методу передається в сесію Apple, після чого при успішній авторизації платежу, повернеться до необхідний для завершення платежу.</blockquote>4. Приклад відповіді ApplePay<syntaxhighlight lang="json" line="1">
{
"paymentData":
{
"version":"EC_v1", "data":"FDXK/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ/dGK9UZDP/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp/clv4", "signature":"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=",
"header":
{ "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==",
"publicKeyHash":"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=",
"transactionId":"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4"
}
},
"paymentMethod":
{
"displayName":"MasterCard 5179",
"network":"MasterCard",
"type":"debit"
}, "transactionIdentifier":"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4"
}

</syntaxhighlight>5. Надішліть <code>paymentData</code> в поле <code>userPaymentInstrument / token</code> в Easypay ([[MerchantAPI#Створення замовлення|Створення замовлення]]). Перед цим потрібно викликати метод EasyPayApi CreateApp.

'''Приклад запиту createOrder:'''<syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210309-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"ApplePay",
"token":"{\"paymentData\": {\"version\":\"EC_v1\", \"data\":\"FDXK\/fkIXGh07D5QU5eUK3ZK8BxKk6syu+Hf0DH6DBZ8\/loNHFWHULxsmfIAyaKzvkUjm2dHaR36pS4x8UXuQ3JhzeB7AfDmZsP8JcL16OOyZKZP3JjOwdkUVvzUyPWtjtlrtXDaBmJ5jPcT8bgnLZV\/7RcC9HpRkdmUqVyJ042wAvPNxF7SVt57PcMyMeccVL6yWUk6N2oV7ESFoGVbAeJdpn5zZT8lebigrnhZRhvwoJ5ZJ\/dGK9UZDP\/swhH8nMLjK620Wu9rvidhsSheJCwM2sCH27fKpeEO2x+vWaLlL9ukwDms9ciOGvSyb+tDvRD9MheecGri1XCC6DxQT5JkHDH7mi1vev0QFjjVY6bmh26iNC0lIB4FKVznNv03yjkKNJhEMbp\/clv4\", \"signature\":\"UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\/wQEAwIBBjAQBgoqhkJvjg3qQ0QAAAAAAAA=\",\"header\":{ \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEXaMJN7PRXhkoMa1n1wOnut4KIkIX0WuyXenzRukdDUzo\/GZ+TRqTSPjZDOPoZkisqifaroXUJZP9xCUlJQ3iqQ==\", \"publicKeyHash\":\"48145ri0BI4zYNGguvfW+7qJc3kQlcGdil64a4cg+Ag=\",\"transactionId\":\"cd80b9fc31c9a850c14c697bd4c258aa51e63bf72bba46394eebbc3fae1b58e4\"} }, \"paymentMethod\": { \"displayName\":\"MasterCard 5179\",\"network\":\"MasterCard\",\"type\":\"debit\" }, \"transactionIdentifier\":\"CD80B9FC31C9A850C14C697BD4C258AA51E63BF72BBA46394EEBBC3FAE1B58E4\"}",
"gatewayMerchantId":"{YOUR_MERCHANT_ID}"
}
}

</syntaxhighlight>

== Інтеграція з GooglePay ==
----'''Вимоги'''
# Ваш сайт повинен працювати за схемою HTTPS та підтримувати протокол TLS 1.2.
# Потрібно погодитися з [https://payments.developers.google.com/terms/sellertos умовами надання] послуг GooglePay.
# Необхідно укласти договір із Easypay.ua.

Google Pay™ - це миттєвий спосіб оплати від Google, який дозволяє просто та швидко сплатити карткою, без необхідності вводити дані для кожного платежу. Ці картки надійно зберігаються в Google. Даний метод доступний для оплати в мобільних програмах на будь-яких пристроях Android і при здійсненні платежу в браузері Chrome.

• '''Документація'''

# [https://developers.google.com/pay/api/android Для додатків]
# [https://developers.google.com/pay/api/web Для веб-сайтів]

• '''Вимоги щодо брендування'''

# [https://developers.google.com/pay/api/android/guides/brand-guidelines Для додатків]
# [https://developers.google.com/pay/api/web/guides/brand-guidelines Для веб-сайтів]

<br>
=== Оплата з платіжної сторінки Easypay ===
----При такому способі підключення немає потреби у додаткових інтеграціях. Кнопка GooglePay відображається на сторінці оплати EasyPay.

=== Отримання токена GooglePay для оплати ===
----<nowiki>*</nowiki>Використовуйте бойове середовище GooglePay для отримання PaymentData

Для отримання PaymentData. Як параметри скрипта вкажіть:

# Доступні методи платежу: var allowedPaymentMethods = ['CARD', 'TOKENIZED_CARD'];
# Тип токенізації- PAYMENT_GATEWAY: tokenizationType: 'PAYMENT_GATEWAY';
# Параметр gateway: easypay;
# Параметр gatewayMerchantId: Ваш бойовий merchantAccount от Google, який повідомляє в EasyPay.

Якщо з вашого боку інтеграція виконана правильно, Ви на своєму сайті/додатку отримаєте кнопку

Після натискання кнопки на пристрої з підключеним Google Pay з'явиться спливаюче вікно або форма вибору прив'язаної картки.

'''Приклад відповіді від GooglePay Api'''<syntaxhighlight lang="json">
{
"apiVersionMinor":0,
"apiVersion":2,
"paymentMethodData":{
"description":"Mastercard •••• 1164",
"tokenizationData":{
"type":"PAYMENT_GATEWAY",
"token":"{"signature":"MEUCeretMPEQPUMnvMOnDAgZsOLVnFnfjmo5ALe/1D6o7hdzAiEA94L1GfNWW84kbUdHHn+l6B6n18VgIA3sdkPqKL36tqk\u003d","intermediateSigningKey":{"signedKey":"{\"keyValue\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEem3biYxltOBuMV+Dd9g+ZhV3VEzP2vAlFXvb9tJoYGLtetxDYWTUqnXPvKGDeAnSNrkPo8hu5kLtxN0QXCYkqQ\\u003d\\u003d\",\"keyExpiration\":\"1551385212256\"}","signatures":["MEYCIQD/TWKunZJhG/u3iL2H5P3i9r0rCbpw1/+z9dr/yGytvwIhAPfV2zF5cqP/L+42W+JKv6fgQKBEc67HTtfderefdghJ"]},"protocolVersion":"ECv2","signedMessage":"{\"encryptedMessage\":\"OidSptk8w+I3FnR1VFmiVswXaZ7ADnmMP1MQelp6GSg0/3aVpAXeLRH/fT1wN7gpxNPy7tFITeQenrJm3QG19tAPuVhcAVM26DMU6LAmZPyPXALktpnYrUj6etCjvWWM/1LkhjDBSjtkmpWRiHIyqj5aud/j8rxFEk06GhwqPWbnJwdCgNf32LJP7bSpUWvHOioaZIV1vdeV6d7iQ6EDWWAS/z9pXWkqpW//M/TVTrcKFXh4C2TI2O+qyBD9VzK3TqU6wS5VsYL69W9/4xzV5L5irpp/wzNfPHkJd8QIwcsIPuNWBtGm3v+JCaqIA3oK9Sw/5o/gZp/pnOhUdax0VjGEvmbGXs2+ufBChCkh+/BpobbpzVS9T/DZSlUO2FLANMjSaEQzh74ymtDgP4x9O64RAdySW+V7lVZMa7FVZ3PFnTfa8W89pzIgo6ocSGHQPBFnExTmSbDpUU0L12wzHkAcZSyngPAljqg\\u003d\",\"ephemeralPublicKey\":\"BBKgbSbykNy1111QYRmGJEhnCorkt+VoDYlYbAlg0a5WO2uV/M50XqOSG0uxWAvUqrZolQuEX6yZ+dvvufLEZtI\\u003d\",\"tag\":\"p9ItvOfsQVTzhTPHq6ycYjKX1TtozP/yym4QWWVRVCk\\u003d\"}"}"
},
"type":"CARD",
"info":{
"cardNetwork":"MASTERCARD",
"cardDetails":"1164",
"billingAddress":{
"phoneNumber":"+380 93 000 00 11",
"address3":"",
"sortingCode":"",
"address2":"",
"countryCode":"UA",
"address1":"ул. ",
"postalCode":"49107",
"name":"Super 1",
"locality":"Київ",
"administrativeArea":"Київська область"
}
}
},
"email":"test@easypay.ua"
}

</syntaxhighlight>

=== Передача токена для оплати ===
Надішліть дані з поля token з відповіді від '''GooglePay Api''' у поле '''userPaymentInstrument/token''' у Easypay (розділ [[MerchantAPI#Створення замовлення|Створення замовлення]])

Перед цим потрібно викликати метод '''EasyPayApi [[MerchantAPI#Реєстрація точки та створення сесії|createApp.]]'''

'''Приклад запиту'''
<p style="border: 1px solid #9ACD32; background-color: rgba(144, 238, 144, 0.5); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 80px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: #006400; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">POST</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/merchant/createOrder</span><syntaxhighlight lang="json" line="1">
{
"order":{
"serviceKey":"MERCHANT-TEST",
"orderId":"test_20210000-171148",
"description":"Test payment",
"amount":"1"
},
"userPaymentInstrument":{
"instrumentType":"GooglePay",
"token":"{\"signature\":\"MEQCIFTFadYw15Cqfk7+YiM9pp5zEvyTI7oWVZCNFKr1cMthAiAFMv+nt0PWOEhj6LmmMNTByP9E4OhGrSoE7rDvzLDIZw\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEsrkMsOBN8N0xL8AsTVUIETODhCva5PpGFxvPm56pWmI5MG2HKKHXjsdhdvcP6N3d40x90E0rZzDrxBC2ywERXg\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1618591579000\\\"}\",\"signatures\":[\"MEUCIHX0SawuKctPUEjdFu2sDiE81aSSdf8i0KNvdg1dlsWoAiEAye8TEWpPk4sp7EjTovN7DichK6YxY1DajYN9/ArHDYI\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"vlLmhIBndM4a/GWFsvbFZrZOygjAwUao/NlvlJlhAQ3kdprI3gubAcQxAau8L74dkzGJh8w7AD2E77XOHycdwG91NUvsJ0xiXuMCXHJ9NPMhp7k49OUIJjOpJG+RqUM9/SPBgx69eDD7skhG+axZYr/m36LFjIlk5WhmumQgIrfojm02uRm0nOcZ2wbvrwQKZyL1IeTv/txqcYMuQqYWzs/FPkIEbiQ80z6dRhVszrEXcHLKcfBmNmcn/Vk90ArXCotOD52V0JS/Q+Mf9mCoe9G2bABo9R9PAYT/FrKIEOQEhzLCI7m4/vyIlCMf69d6PjigP3AOGxykbS0Kvsxqoh+HYRFCSLCd+8O2Us2wCYD09/OBqcQi78/fs2vwyg4nrWQQJ6ZGwTKHHxVRY8VGAUUnMFr18HPsN1BQNuz08M4t6Qx6X0nEZ3hseSIcUMVcBm+NyvL2T/XSWqTh2poDuQ4B+UJ59gMrsPapzouxk2iC/+vS1Bs/2sSf77Nsqr7BhE7SMgnZ/a2LF+Shx2aOKSIGflMz+MjVSzpMg2AUh43pbcsi8g\\\\u003d\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BDJpYzoN9XPVKrHIxwNes83HbR0/AOUPpQgAwi3fTzR+TIB8/VAc9CdI9guWX8Pjvii/T+WxwcByuo9pzJC7518\\\\u003d\\\",\\\"tag\\\":\\\"LFOOTwd5Crtn60KnT0J6MHuFlGE0+EYL3D7IrWrPsRA\\\\u003d\\\"}\"}",
}
}

</syntaxhighlight>

== Оплата за QR MasterPass ==
----<blockquote>Для мерчантів, які мають пряму інтеграцію з MasterPass. </blockquote>QR MasterPass - оплата з гаманця MasterPass із використанням Qr code.

<br>
=== Отримання даних для QR-code ===
----Потрібно створити сесію ([[MerchantAPI#Створення сесії|Створення сесії]]). Після цього необхідно створити замовлення ([[MerchantAPI#Створення замовлення|Створення замовлення]]).
У відповіді в <code>paymentInstrumentsTypes => instrumentType: "QrMasterpass"</code> об'єкт, який містить інформацію для формування QR code. У '''<code>instrumentvalue</code>''' буде рядок, з якого потрібно генерувати QR code.

Приклад '''paymentInstrumentsTypes''' => '''instrumentType: "QrMasterpass"'''
<br>
<syntaxhighlight lang="json">
{
"instrumentType":"QrMasterpass",
"commission":0.0,
"amountMin":1.00,
"amountMax":14999.00,
"userPaymentInstruments":[
{
"instrumentId":8499910,
"instrumentType":"QrMasterpass",
"instrumentValue":"00020101021252040000530398054034005802UA5909
EasyPayUa6004Kiev64190002UK0109EasyPayUa80850017ua.
mastercard.www010200020840703434032003434180702054456177041211109354874205020181500017
ua.mastercard.www011720191111093548742020499996223030443590603391070410036304AF79",
"alias":null,
"commission":0.0,
"loyaltyCommission":null,
"actionsKeys":null,
"priorityIndex":0,
"additionalParams":{
"OrderId":"4825209b-1caa-472e-b530-dc3e8efd541c"
}
}
]
}

</syntaxhighlight>

=== Перевірка статусу QR code ===
----Метод повертає інформацію про поточний статус QR code.

<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">//api/payment/qrPaymentCheck</span>
</p>'''Request'''<syntaxhighlight lang="json" line="1">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="

queryParams

headers
відсутній

body
{
"status": "Generated",
"transactionId": null,
"error": null
}

</syntaxhighlight>Можливі значення '''"status":'''

* <code>Generated</code>
* <code>Scanned</code>
* <code>PaymentStarted</code>
* <code>PaymentFinished</code>
* <code>PaymentFinished</code>
<br>
'''"transactionId"''' – ідентифікатор платежу в системі EasyPay.

=== Оплата за QR code ===
----Метод для оплати за QR кодом. Працює тільки з QR кодами, які були отримання від EasyPay.
<p style="border: 1px solid deepskyblue; background-color: rgba(135, 206, 235, 0.2); padding: 10px; border-radius: 8px; font-family: Arial, sans-serif; font-size: 14px; font-weight: normal; position: relative; padding-left: 70px;">
<span style="position: absolute; top: 10px; left: 10px; background-color: deepskyblue; color: white; padding: 2px 12px; border-radius: 4px; font-size: 14px; font-weight: bold;">GET</span>
<span style="margin-left: 5px; font-weight: bold; font-size: 16px;">/api/payment/create/qr</span>
</p>

'''Request''' <syntaxhighlight lang="json">
headers

"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"

body
{
"qrCode": "string",
"amount": 1,
"userPaymentInstrument": {
"instrumentId": 8499910,
"instrumentType": "QrMasterpass",
"alias": "Mycard",
"pan": "4102*******4441"
},
"resultUrl": "string"
}

</syntaxhighlight>
'''Response'''<syntaxhighlight lang="json" line="1">
headers
відсутній

body
{
"paymentState": "Confirmed",
"status": "Done",
"retrievalReferenceNo": 11111111,
"error": null
}

</syntaxhighlight>

Можливі значення “'''paymentState'''”

* Сonfirmed
* Rejected

<br>

== Створення підпису ==
----Формування підпису Sign (основний варіант для POST – запитів)<syntaxhighlight lang="text">
Sign = base64(sha256(secretKey + requestBody))

</syntaxhighlight>'''Де:'''
* <code>secretKey</code> – секретний ключ.
* <code>requestBody</code> – тіло запиту у форматі JSON (ідентичне формату EasyPay).
<br>

=== Приклади коду ===
----'''C#'''

<code>Convert.ToBase64String(SHA256.Create().ComputeHash(Encoding.UTF8.GetBytes(data)))</code>

'''PHP'''

<code>base64_encode(hash('sha256', ($secretKey.$requestbody), true))</code>

<br>
== Можливі варіанти інструментів оплати ==
----

===== Оплата <span style=" display: inline-block; padding: 4px 16px; border: 2px solid #0033A0; /* Темно-синій колір рамки */ background-color: #0033A0; /* Темно-синій фон */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ ">VISA</span> <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid transparent; /* Прозора рамка для градієнту */ background: linear-gradient(to right, #FF5F00, #FFBF00); /* Градієнт від червоного до оранжевого */ color: white; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">MasterCarD</span> =====
<syntaxhighlight lang="json" line="1">
"paymentInstrumentsTypes": [
{
"storedCards": [],
"instrumentType": "Card",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4211698,
"instrumentType": "Card",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 200,
"additionalParams": {}
}
]
]
},
{
"instrumentType": "RCard",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>
===== Мобільні гроші <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #00A3E0; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #00A3E0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Київстар</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #F7E300; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #0033A0; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Lifecell</span><span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #E60012; /* Темно-синій колір рамки */ background:FFFFE0; /* Темно-синій фон */ color: #E60012; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ font-size: 24px; border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">Vodafone</span> =====

<syntaxhighlight lang="json" line="1">
{
"instrumentType": "KSMoney",
"commission": 0.0,
"amountMin": 0.01,
"amountMax": 14000.00,
"userPaymentInstruments": [
{
"instrumentId": 4958975,
"instrumentType": "KSMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.0,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 1,
"additionalParams": {}
}
]
},
{
"instrumentType": "LifeMoney",
"commission": 0.03,
"amountMin": 0.01,
"amountMax": 6000.00,
"userPaymentInstruments": [
{
"instrumentId": 5098216,
"instrumentType": "LifeMoney",
"instrumentValue": null,
"alias": null,
"commission": 0.03,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]

</syntaxhighlight>

===== Картки лояльності <span style=" display: inline-block; padding: 8px 20px; border: 2px solid #FF0000; /* Червона рамка */ background-color: #FF0000; /* Червоний фон */ color: white; /* Білий текст*/ font-family: Arial, sans-serif; /* Шрифт Arial */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Розмір шрифта */ ">Fishka</span> =====
<syntaxhighlight lang="json" line="1">
]
},
{
"instrumentType": "FishkaB2B",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},
{
"instrumentType": "FishkaB2C",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 1000.00,
"userPaymentInstruments": []
},

</syntaxhighlight>

===== Оплата <span style=" display: inline-block; padding: 8px 20px; /* Збільшене відступи для однакового розміру */ border: 2px solid #000000; /* Темно-синій колір рамки */ background:FFFFFF ; /* Темно-синій фон */ color: #000000; /* Білий текст */ font-family: Arial, sans-serif; /* Шрифт */ font-weight: bold; /* Жирний шрифт */ border-radius: 24px; /* Закруглені краї */ text-transform: uppercase; /* Великі літери */ font-size: 16px; /* Однаковий розмір шрифта */ ">ApplePay</span> <span style=" display: inline-block; padding: 8px 20px; border-style: solid; border-width: 4px; border-color: #4285F4 #EA4335 #FABB05 #34A853; /* Чітке розмежування кольорів */ background-color: #FFFFFF; /* Білий фон всередині */ color: #000000; /* Колір тексту */ font-family: Arial, sans-serif; font-weight: bold; text-transform: uppercase; font-size: 16px; border-radius: 24px; /* Закруглені краї */ ">GPAY</span> =====
<syntaxhighlight lang="json" line="1">
{
"instrumentType": "ApplePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958126,
"instrumentType": "ApplePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams": {}
}
]
},
{
"instrumentType": "GooglePay",
"commission": 2.00,
"amountMin": 0.01,
"amountMax": 9999.00,
"userPaymentInstruments": [
{
"instrumentId": 10958137,
"instrumentType": "GooglePay",
"instrumentValue": null,
"alias": null,
"commission": 2.00,
"loyaltyCommission": null,
"actionsKeys": null,
"priorityIndex": 0,
"additionalParams":
{
"PublicKey": "BKdzipvJvJzcbTMm3dO0LEh1AXFr8qfSiPjwrI7vv9F6hqhDJB1M="
}
}
]
}
]

</syntaxhighlight>

=== Управління інструментами оплати ===
----Управління інструментами оплати на сторінці оплати EasyPay здійснюється при створенні замовлення. Параметр <code>allowedInstruments</code> визначає, які інструменти оплати будуть відображатися на сторінці платіжного шлюзу.
<br>
<syntaxhighlight lang="json" line="1">
"userInfo": {
"phone": "string"
},

Обов'язкові параметри:
"order": {
"serviceKey": "string",
"orderId": "string",
"description": "string",
"amount":1.01, (decimal)
"allowedInstruments": [ "string" ]
</syntaxhighlight>'''Опис параметрів''' <table style="border-collapse: collapse; width: 100%; font-family: Roboto, sans-serif; font-weight: 100; font-size: 0.8em; color: #333;">
<tr>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Параметр</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Характеристика</th>
<th style="border: none; border-bottom: 1px solid #d3d3d3; text-align: center; padding: 8px;">Коментарій</th>
</tr><tr>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">'''<code>allowedInstruments</code>'''</td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; padding-right: 10px; text-align: left;">параметр в якому передаються інструменти оплати, які будуть відображені на сторінці </td>
<td style="border: none; border-bottom: 1px solid #d3d3d3; text-align: left;">Можливі значення:

* RCard
* Card
* EBank
* FishkaB2C
* ApplePay
* GooglePay</td>
</tr></table>
'''<br>
Поведінка системи'''
# '''Якщо параметр''' <code>allowedInstruments</code> '''не передано або він порожній''': На сторінці оплати будуть відображені всі доступні інструменти, які підключені для партнера.
# '''Якщо з переданих інструментів немає доступних для оплати''': Повертається помилка: <code>PAYMENTINSTRUMENT_NOT_FOUND</code>
# '''Приклад помилки''': У разі, якщо у партнера активні ApplePay і Card, а в запиті передається GooglePay, повертається помилка <code>PAYMENTINSTRUMENT_NOT_FOUND</code>.
# '''Якщо передані доступні інструменти оплати''': У разі, якщо партнер передає, наприклад, GooglePay та Card, але GooglePay не активний для цього партнера, система поверне посилання з активним інструментом Card.
<br>

== Технічна підтримка ==
----За потреби консультацій з питань реалізації API можна написати запит на ''merchant.api.support@easypay.ua''