Повідомлення про платіж
Матеріал з apidocs
Отримання інформації про рекурентний платіж
GET /api/merchant/reccurent/info
Request
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
Response
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
}
Параметр | Характеристика |
---|---|
serviceKey |
ІД сервісу партнера у системі EasyPay |
orderId |
номер замовлення партнера із запиту createOrder |
reccurentId |
номер рекурента |
dateFrom |
дата створення рекурента з.. |
dateTo |
дата створення рекурента по.. |
isEnabled |
відобразити лише активні / або неактивні рекуренти |
pageNumber |
відобразити сторінку номер.. |
countPerPage |
кількість записів на сторінці |
templateId |
номер рекуренту (reccurentId) |
Виклик рекурентного платежу
POST /api/merchant/reccurent/payment
Request
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
}
Response
headers
body
{
"reccurentId": 0,
"transactionId": 0,
"transactionStatus": "None",
"error": {
"errorCode": "string",
"title": "string",
"description": "string",
"errorMessage": "string",
"fieldErrors": [
{
"fieldName": "string",
"errorCode": "string",
"errorMessage": "string"
}
]
}
}
Також буде надіслано нотифікацію у разі успішного платежу. Створення рекурентного платежу на операцію, у структурі якої є спліт – не підтримується.
Видалення рекурентного платежу
DELETE /api/merchant/reccurent/delete/{id}
Request
headers
"PartnerKey": "partnerName"
"locale": "ua"
"AppId": "a5806a5f-dbb8-496a-a23f-aab6d2fcbce1"
"PageId": "2ce7dba6-4600-456e-b9c8-f13cacf1c85d"
"Sign": "e0v1vIOMyNt2qSmrG5+sjAq8wOhvgDDUEyfVP21mRU4="
body
відсутній
Response
headers
-
body
-
← Назад
Скасування платежу
Далі →
Токенізація карти