API постоянных ссылок
Получение списка постоянных ссылок
Для получения списка постоянных ссылок необходимо отправить POST-запрос со следующими данными.
Production url: https://procard-ltd.com/permanent-links/list
POST параметры:
| Параметр | Тип | Обязательный | Описание | значение |
|---|---|---|---|---|
| merchant_id | String | + | ID мерчанта | |
| signature | String | + | Контрольная подпись. Параметр merchant_id подлежит HMAC_SHA512 с помощью SecretKey мерчанта |
В ответ приходят следующие параметры:
Ответ успеха
| Параметр | Тип | Описание | значение |
|---|---|---|---|
| result | Integer | Статус ответа | 0 |
| permanent_links | Array | Массив объектов (постоянных ссылок) |
Ответ неуспеха
| Параметр | Тип | Описание | значение |
|---|---|---|---|
| code | Integer | Код ошибки | |
| message | String/Array | Описание ошибки |
Элемент массива permanent_links
| Параметр | Тип | Описание | значение |
|---|---|---|---|
| merchant_id | String | ID мерчанта | |
| id | String | ID постоянной ссылки | |
| имя | String | Название постоянной ссылки | |
| permanent_link | String | Постоянная ссылка | |
| kind | Integer | Вид ссылки | 0 - фиксированная сумма (по умолчанию) 1 - произвольная сумма |
| enable_counter | Integer | Управление количеством. На форме оплаты будет отображаться сумма и элемент управления количеством, позволяющий увеличивать сумму оплаты кратно выбранному количеству | 0 - отключен 1 - включен |
| amount | String | Сумма. Одна, или несколько, разделенных “;” (точка с запятой) | 100;200;300 |
| описание | String | Назначение платежа | |
| custom_amount | Float | Дополнительная сумма. Сумма, добавленная к накопленной сумме. | |
| target_amount | Float | Целевая сумма | |
| show_total_amount | Integer | Отображать информацию о накоплении. Показывать на странице оплаты сумму накопленных средств и целевую сумму, если она указана | 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 | Integer | Вид ссылки | 0 - фиксированная сумма (по умолчанию) 1 - произвольная сумма | |
| enable_counter | Integer | Управление количеством. На форме оплаты будет отображаться сумма и элемент управления количеством, позволяющий увеличивать сумму оплаты кратно выбранному количеству | 0 - отключен 1 - включен | |
| amount | String | + | Сумма. Одна, или несколько, разделенных “;” (точка с запятой) Может быть пустой строкой в случае kind = 1 | 100;200;300 |
| description | String | + | Назначение платежа | |
| custom_amount | Float | Дополнительная сумма. Сумма, которая будет добавлена к накопленной сумме. Заполняйте поле при необходимости или оставляйте его пустым, если в коррекции потребность отсутствует. | ||
| target_amount | Float | Целевая сумма | ||
| show_total_amount | Integer | Отображать информацию о накоплении. Отображать на странице оплаты сумму накопленных средств и целевую сумму, если она указана | 0 - отключен 1 - включен | |
| language | String | + | Язык платежной страницы | ukr en ru |
| signature | String | + | Контрольная подпись. Строка из конкатенированных параметров merchant_id, operation, amount, language, разделенные “;” (точка с запятой) в кодировке UTF-8 подлежит HMAC_SHA512 с помощью SecretKey мерчанта.Порядок параметров при конкатенации важен! |
В ответ приходят следующие параметры:
Ответ успеха
| Параметр | Тип | Описание | значение |
|---|---|---|---|
| result | Integer | Статус ответа | 0 |
| id | String | ID постоянной ссылки | |
| permanent_link | String | Постоянная ссылка |
Ответ неуспеха
| Параметр | Тип | Описание | значение |
|---|---|---|---|
| code | Integer | Код ошибки | |
| 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 | Integer | Отображать информацию о накоплении. Показывать на странице оплаты сумму накопленных средств и целевую сумму, если она указана | 0 - отключен 1 - включен | |
| language | String | + | Язык платежной страницы | ukr en ru |
| signature | String | + | Контрольная подпись. Строка из конкатенированных параметров merchant_id, id, amount, language, разделенные “;” (точка с запятой) в кодировке UTF-8 подлежит HMAC_SHA512 с помощью SecretKey мерчанта.Порядок параметров при конкатенации важен! |
В ответ приходят следующие параметры:
Ответ успеха
| Параметр | Тип | Описание | значение |
|---|---|---|---|
| result | Integer | Статус ответа | 0 |
Ответ неуспеха
| Параметр | Тип | Описание | значение |
|---|---|---|---|
| code | Integer | Код ошибки | |
| 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 | Integer | Количество операций на странице | По умолчанию: 100 | |
| page | Integer | Номер страницы | По умолчанию: 1 | |
| signature | String | + | Контрольная подпись. Строка из конкатенированных параметров merchant_id, id, разделенных “;” (точка с запятой) в кодировке UTF-8 подлежит HMAC_SHA512 с помощью SecretKey мерчанта.Порядок параметров при конкатенации важен! |
В ответ приходят следующие параметры:
Ответ успеха
| Параметр | Тип | Описание | Значение |
|---|---|---|---|
| result | Integer | Статус ответа | 0 |
| operations | Array | Массив объектов (операций), касающихся данной ссылки в статусе APPROVED и WAITING-AUTH. По умолчанию: новейшие 100 выполненных операций | |
| per_page | Integer | Количество операций на странице | |
| page | Integer | Номер страницы | |
| total | Integer | Общее количество операций |
Ответ неуспеха
| Параметр | Тип | Описание | Значение |
|---|---|---|---|
| code | Integer | Код ошибки | |
| message | String/Array | Описание ошибки |
Элемент массива operations
| Параметр | Тип | Описание | Значение |
|---|---|---|---|
| merchant_id | String | ID мерчанта | |
| id | Integer | ID операции | |
| даты | String | Дата операции | |
| amount | String | Сумма | |
| total_amount | String | Итоговая сумма | |
| fee | String | Сумма комиссии | |
| status | String | Статус операции (см. Справочник. Статусы платежа) | |
| card_number | String | Маскированный номер карты | |
| order_id | String | ID заказа | |
| описание | 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"
}
Другие коды ошибок см. Справочник. Коды системных ошибок