API постійних посилань
Отримання списку постійних посилань
Щоб отримати список постійних посилань, необхідно надіслати POST-запит із наступними даними.
Production url: https://procard-ltd.com/permanent-links/list
POST параметри:
| Параметр | Тип | Обов'язковий | Опис | Значення |
|---|---|---|---|---|
| merchant_id | string | + | ID мерчанта | |
| signature | string | + | Контрольний підпис. Параметр merchant_id підлягає HMAC_SHA512 за допомогою SecretKey мерчанта |
У відповідь надходять наступні параметри:
Відповідь успіху
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| result | int | Статус відповіді | 0 |
| permanent_links | array | Масив об’єктів (постійних посилань) |
Відповідь відмови
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| code | int | Код помилки | |
| message | string / array | Опис помилки |
Елемент масиву permanent_links
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| merchant_id | string | ID мерчанта | |
| id | string | ID постійного посилання | |
| name | string | Назва постійного посилання | |
| permanent_link | string | Постійне посилання | |
| kind | int | Вид посилання | 0 - фіксована сума (за замовчанням) 1 - довільна сума |
| enable_counter | int | Керування кількістю. На формі оплати буде відображатися сума та елемент керування кількістю, що дозволяє збільшувати суму оплати кратно вибраній кількості | 0 - вимкнено 1 - увімкнено |
| amount | string | Сума. Одна, або декілька, розділених “;” (крапка з комою) | 100;200;300 |
| description | string | Призначення платежу | |
| custom_amount | float | Додаткова сума. Сума, яка буде додана до накопиченої суми. | |
| target_amount | float | Цільова сума | |
| show_total_amount | int | Відображати інформацію про накопичення. Відображати на сторінці оплати суму накопичених коштів та цільову суму, якщо вона вказана | 0 - вимкнено 1 - увімкнено |
| language | string | Мова платіжної сторінки | ukr en ru |
Приклад запиту:
{
"signature":"d1345960ee7fdd52fd323685d69af86e",
"merchant_id":"TEST_TRADER_2"
}
Приклад відповіді успіху:
{
"result":0,
"permanent_links":[
{
"merchant_id":"TEST_TRADER_2",
"id":"TzrBX6Tgas",
"name":"Фіксована с кількістю",
"permanent_link":"https://front.dev/TzrBX6Tgas",
"kind":0,
"enable_counter":1,
"amount":"100.34",
"description":"Платіж фіксована с кількістю",
"custom_amount":0,
"target_amount":0,
"show_total_amount":0,
"language":"ukr"
},
{
"merchant_id":"TEST_TRADER_2",
"id":"lguYXHGDb2",
"name":"Фіксована без кількості",
"permanent_link":"https://front.dev/lguYXHGDb2",
"kind":0,
"enable_counter":0,
"amount":"10.55",
"description":"Платіж фіксована без кількості",
"custom_amount":0,
"target_amount":0,
"show_total_amount":0,
"language":"ukr"
},
{
"merchant_id":"TEST_TRADER_2",
"id":"7LbWunScwD",
"name":"Довільна без рекомендованої",
"permanent_link":"https://front.dev/7LbWunScwD",
"kind":1,
"enable_counter":0,
"amount":"",
"description":"Платіж довільна без рекомендованої",
"custom_amount":0,
"target_amount":0,
"show_total_amount":0,
"language":"ukr"
}
]
}
Приклад відповіді відмови обробки запиту:
{
"code": -13,
"message": "Parameter signature not found"
}
Інші коди помилок див. Довідник. Коди системних помилок
Створення постійного посилання
Production url: https://procard-ltd.com/permanent-links/create
Щоб створити постійне посилання, необхідно надіслати POST-запит із наступними даними.
POST параметри:
| Параметр | Тип | Обов'язковий | Опис | Значення |
|---|---|---|---|---|
| merchant_id | string | + | ID мерчанта | |
| operation | string | + | Тип операції | Purchase P2Pin |
| card_number2 | string | Номер картки отримувача Обов’язковий для операції P2Pin! | ||
| name | string | + | Назва постійного посилання | |
| kind | int | Вид посилання | 0 - фіксована сума (за замовчанням) 1 - довільна сума | |
| enable_counter | int | Керування кількістю. На формі оплати буде відображатися сума та елемент керування кількістю, що дозволяє збільшувати суму оплати кратно вибраній кількості | 0 - вимкнено 1 - увімкнено | |
| amount | string | + | Сума. Одна, або декілька, розділених “;” (крапка з комою) Може бути пустим рядком у разі kind = 1 | 100;200;300 |
| description | string | + | Призначення платежу | |
| custom_amount | float | Додаткова сума. Сума, яка буде додана до накопиченої суми. Заповнюйте поле за потреби, або залишайте його порожнім, якщо у корекції потреба відсутня. | ||
| target_amount | float | Цільова сума | ||
| show_total_amount | int | Відображати інформацію про накопичення. Відображати на сторінці оплати суму накопичених коштів та цільову суму, якщо вона вказана | 0 - вимкнено 1 - увімкнено | |
| language | string | + | Мова платіжної сторінки | ukr en ru |
| signature | string | + | Контрольний підпис. Рядок із конкатенованих параметрів merchant_id, operation, amount, language, що розділені “;” (крапка з комою) у кодуванні UTF-8 підлягає HMAC_SHA512 за допомогою SecretKey мерчанта.Порядок параметрів під час конкатенації важливий! |
У відповідь надходять наступні параметри:
Відповідь успіху
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| result | int | Статус відповіді | 0 |
| id | string | ID постійного посилання | |
| permanent_link | string | Постійне посилання |
Відповідь відмови
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| code | int | Код помилки | |
| message | string / array | Опис помилки |
Приклад запиту створення постійного посилання з типом операцій Purchase на фіксовану суму з можливістю вибирати кількість:
{
"merchant_id": "BO_c329e89e362aba4",
"operation": "Purchase",
"kind": 0,
"amount": "1.10",
"enable_counter": 1,
"signature": "41f3c91852e13b856fdff9fe92feea1b",
"name": "Назва постійного посилання",
"description": "Призначення платежу",
"language": "ukr"
}
Приклад запиту створення постійного посилання з типом операцій Purchase на довільну суму з накопиченням:
{
"merchant_id": "BO_c329e89e362aba4",
"operation": "Purchase",
"kind": 1,
"amount": "",
"signature": "12ed9cd9e82df7d1afd5460cd8e8041f",
"show_total_amount": 1,
"custom_amount": 100.55,
"target_amount": 10000,
"name": "Назва постійного посилання",
"description": "Призначення платежу",
"language": "en"
}
Приклад запиту створення постійного посилання з типом операцій P2Pin:
{
"merchant_id": "TEST_TRADER_2",
"operation": "P2Pin",
"amount": "1.12",
"card_number2": "4000000000000000",
"signature": "85a92a58919ec58d1716a449f6338231",
"name": "Назва постійного посилання",
"description": "Призначення платежу",
"language": "ukr"
}
Приклад відповіді успіху:
{
"result": 0,
"id": "yqqNCgWLkD",
"permanent_link": "https://front.dev/yqqNCgWLkD"
}
Приклад відповіді відмови:
{
"code": -13,
"message": "Parameter signature not found"
}
Інші коди помилок див. Довідник. Коди системних помилок
Редагування постійного посилання
Production url: https://procard-ltd.com/permanent-links/update
Щоб відредагувати постійне посилання, необхідно надіслати POST-запит із наступними даними.
POST параметри:
| Параметр | Тип | Обов'язковий | Опис | Значення |
|---|---|---|---|---|
| merchant_id | string | + | ID мерчанта | |
| id | string | + | ID постійного посилання | |
| name | string | + | Назва постійного посилання | |
| amount | string | + | Сума. Одна, або декілька, розділених “;” (крапка з комою) Може бути пустим рядком у разі kind = 1 | 100;200;300 |
| description | string | + | Призначення платежу | |
| custom_amount | float | Додаткова сума. Сума, яка буде додана до накопиченої суми. Заповнюйте поле за потреби, або залишайте його порожнім, якщо у корекції потреба відсутня. | ||
| target_amount | float | Цільова сума | ||
| show_total_amount | int | Відображати інформацію про накопичення. Відображати на сторінці оплати суму накопичених коштів та цільову суму, якщо вона вказана | 0 - вимкнено 1 - увімкнено | |
| language | string | + | Мова платіжної сторінки | ukr en ru |
| signature | string | + | Контрольний підпис. Рядок із конкатенованих параметрів merchant_id, id, amount, language, що розділені “;” (крапка з комою) у кодуванні UTF-8 підлягає HMAC_SHA512 за допомогою SecretKey мерчанта.Порядок параметрів під час конкатенації важливий! |
У відповідь надходять наступні параметри:
Відповідь успіху
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| result | int | Статус відповіді | 0 |
Відповідь відмови
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| code | int | Код помилки | |
| message | string / array | Опис помилки |
Приклад запиту:
{
"merchant_id": "TEST_TRADER_2",
"id": "yqqNCgWLkD",
"custom_amount": 546.54,
"amount": "100;200;500;1000;3500",
"target_amount": 10000,
"signature": "46f9bf919ea2f0e0ce8772c5698eb54e",
"show_total_amount": 1,
"name": "Назва постійного посилання",
"description": "Призначення платежу",
"language": "en"
}
Приклад відповіді успіху:
{
"result": 0
}
Приклад відповіді відмови:
{
"code": -13,
"message": "Parameter signature not found"
}
Інші коди помилок див. Довідник. Коди системних помилок
Отримання списку операцій, виконаних за вказаним посиланням
Production url: https://procard-ltd.com/permanent-links/operations
Щоб отримати список операцій, виконаних за вказаним постійним посиланням, необхідно надіслати POST-запит із наступними даними.
POST параметри:
| Параметр | Тип | Обов'язковий | Опис | Значення |
|---|---|---|---|---|
| merchant_id | string | + | ID мерчанта | |
| id | string | + | ID постійного посилання | |
| per_page | int | Кількість операцій на сторінці | За замовчанням: 100 | |
| page | int | Номер сторінки | За замовчанням: 1 | |
| signature | string | + | Контрольний підпис. Рядок із конкатенованих параметрів merchant_id, id, що розділені “;” (крапка з комою) у кодуванні UTF-8 підлягає HMAC_SHA512 за допомогою SecretKey мерчанта.Порядок параметрів під час конкатенації важливий! |
У відповідь надходять наступні параметри:
Відповідь успіху
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| result | int | Статус відповіді | 0 |
| operations | array | Масив об’єктів (операцій), що стосуються даного посилання в статусі APPROVED та WAITING-AUTH. За замовчанням: найновіші 100 виконаних операцій | |
| per_page | int | Кількість операцій на сторінці | |
| page | int | Номер сторінки | |
| total | int | Загальна кількість операцій |
Відповідь відмови
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| code | int | Код помилки | |
| message | string / array | Опис помилки |
Елемент масиву operations
| Параметр | Тип | Опис | Значення |
|---|---|---|---|
| merchant_id | string | ID мерчанта | |
| id | int | ID операції | |
| date | string | Дата операції | |
| amount | string | Сума | |
| total_amount | string | Підсумкова сума | |
| fee | string | Сума комісії | |
| status | string | Статус операції (див. Довідник. Статуси платежу) | |
| card_number | string | Маскований номер картки | |
| order_id | string | ID замовлення | |
| description | string | Призначення платежу | |
| STAN | string | Номер транзакції |
Приклад запиту:
{
"merchant_id": "TEST_TRADER_2",
"id": "yqqNCgWLkD",
"per_page": 2,
"page": 2,
"signature": "d77dadde9b9bfee8137ab2904b33bd0d"
}
Приклад відповіді успіху:
{
"result": 0,
"operations": [
{
"merchant_id": "TEST_TRADER_2",
"id": 78,
"date": "2023-07-12 17:07:40",
"amount": "1.00",
"total_amount": "-0.01",
"fee": "1.01",
"status": "APPROVED",
"card_number": "401200******3010",
"order_id": "64aeb3acb85418.20210539",
"description": "Довільна с багатьма рекомендованими сумами",
"STAN": "3081634"
},
{
"merchant_id": "TEST_TRADER_2",
"id": 79,
"date": "2023-07-12 17:07:41",
"amount": "200.55",
"total_amount": "197.54",
"fee": "3.01",
"status": "APPROVED",
"card_number": "401200******3010",
"order_id": "64aeb3ad465bc7.92402800",
"description": "Довільна с багатьма рекомендованими сумами",
"STAN": "3081632"
}
],
"per_page": 2,
"page": 2,
"total": 5
}
Приклад відповіді відмови:
{
"code": -13,
"message": "Parameter signature not found"
}
Інші коди помилок див. Довідник. Коди системних помилок