Permanent Links API
Getting a list of permanent links
To get a list of permanent links, you need to send a POST request with the following data.
Production url: https://****.procard-ltd.com/permanent-links/list
POST parameters:
| Parameter | Type | Required | Description | Value |
|---|---|---|---|---|
| merchant_id | String | + | Merchant ID | |
| signature | String | + | Control signature. The merchant_id parameter is subject to HMAC_SHA512 using the merchant's SecretKey |
The following parameters are received in response:
Successful
| Parameter | Type | Description | Value |
|---|---|---|---|
| result | Integer | Response Status | 0 |
| permanent_links | Array | Array of objects (permanent links) |
Unsuccessful
| Parameter | Type | Description | Value |
|---|---|---|---|
| code | Integer | Error code | |
| message | String / Array | Description of the error |
Array element permanent_links
| Parameter | Type | Description | Value |
|---|---|---|---|
| merchant_id | String | Merchant ID | |
| id | String | Permanent link ID | |
| name | String | Permanent link name | |
| permanent_link | String | Permanent link | |
| kind | Integer | Type of link | 0 - fixed amount (default) 1 - arbitrary amount |
| enable_counter | Integer | Quantity Control. The payment form will display an amount and a quantity control that allows you to increase the payment amount by multiples of the selected quantity | 0 - disabled 1 - enabled |
| amount | String | Sum. One or more separated by “;” (semicolon) | 100; 200; 300 |
| description | String | Description of payment | |
| custom_amount | Float | Additional amount. The amount that will be added to the accumulated amount. | |
| target_amount | Float | Target amount | |
| show_total_amount | Integer | Display information about accumulation. Display the amount of accumulated funds and the target amount on the payment page, if it is specified | 0 - disabled 1 - enabled |
| language | String | Payment page language | ukr en ru |
Example request:
{
"signature":"d1345960ee7fdd52fd323685d69af86e",
"merchant_id":"TEST_TRADER_2"
}
Example of a success response:
{
"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"
}
]
}
Example of a request processing refusal response:
{
"code": -13,
"message": "Parameter signature not found"
}
Other error codes see Dictionary. System Error Codes
Create a permanent link
Production url: https://****.procard-ltd.com/permanent-links/create
To create a permanent link, you need to send a POST request with the following data.
POST parameters:
| Parameter | Type | Required | Description | Value |
|---|---|---|---|---|
| merchant_id | String | + | Merchant ID | |
| operation | String | + | Type of operation | Purchase P2Pin |
| card_number2 | String | Recipient's card number Required for operation = P2Pin! | ||
| name | String | + | The name of the permanent link | |
| kind | Integer | Type of link | 0 - fixed amount (by default) 1 - arbitrary amount | |
| enable_counter | Integer | Quantity control. The payment form will display an amount and a quantity control that allows you to increase the payment amount by multiples of the selected quantity | 0 - disabled 1 - enabled | |
| amount | String | + | Amount. One or more separated by “;” (semicolon) Can be an empty String if kind = 1 | 100;200;300 |
| description | String | + | Description of payment | |
| custom_amount | Float | Additional amount. The amount that will be added to the accumulated amount. Fill in the field as needed, or leave it blank if there is no need for correction. | ||
| target_amount | Float | Target amount | ||
| show_total_amount | Integer | Display savings information. Display the amount of accumulated funds and the target amount, if specified, on the payment page | 0 - disabled 1 - enabled | |
| language | String | + | Payment page language | ukr en ru |
| signature | String | + | Control signature. A String of concatenated parameters merchant_id, operation, amount, language separated by “;” (semicolon) in UTF-8 encoding is subject to HMAC_SHA512 using the merchant's SecretKey.Order of parameters during concatenation is important! |
The following parameters are received in response:
Successful
| Parameter | Type | Description | Value |
|---|---|---|---|
| result | Integer | Response Status | 0 |
| id | String | Permanent link ID | |
| permanent_link | String | Permanent link |
Unsuccessful
| Parameter | Type | Description | Value |
|---|---|---|---|
| code | Integer | Error code | |
| message | String / Array | Description of the error |
An example of a request to create a permanent link with the type of operations Purchase for a fixed amount with the ability to choose the amount:
{
"merchant_id": "BO_c329e89e362aba4",
"operation": "Purchase",
"kind": 0,
"amount": "1.10",
"enable_counter": 1,
"signature": "41f3c91852e13b856fdff9fe92feea1b",
"name": "Назва постійного посилання",
"description": "Призначення платежу",
"language": "ukr"
}
Example of a request to create a permanent link with the type of operations Purchase for an arbitrary amount with accumulation:
{
"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"
}
Example of a request to create a permanent link with the operation type P2Pin:
{
"merchant_id": "TEST_TRADER_2",
"operation": "P2Pin",
"amount": "1.12",
"card_number2": "4000000000000000",
"signature": "85a92a58919ec58d1716a449f6338231",
"name": "Назва постійного посилання",
"description": "Призначення платежу",
"language": "ukr"
}
Example of a success response:
{
"result": 0,
"id": "yqqNCgWLkD",
"permanent_link": "https://front.dev/yqqNCgWLkD"
}
Example of a rejection response:
{
"code": -13,
"message": "Parameter signature not found"
}
Other error codes see Dictionary. System Error Codes
Editing a permanent link
Production url: https://****.procard-ltd.com/permanent-links/update
To edit a permanent link, you must send a POST request with the following data.
POST parameters:
| Parameter | Type | Required | Description | Value |
|---|---|---|---|---|
| merchant_id | String | + | Merchant ID | |
| id | String | + | Permanent link ID | |
| name | String | + | The name of the permanent link | |
| amount | String | + | Amount. One or more separated by “;” (semicolon) Can be an empty String if kind = 1 | 100;200;300 |
| description | String | + | Purpose of payment | |
| custom_amount | Float | Additional amount. The amount that will be added to the accumulated amount. Fill in the field as needed, or leave it blank if no correction is needed. | ||
| target_amount | Float | Target amount | ||
| show_total_amount | Integer | Display information about accumulation. Display the amount of accumulated funds and the target amount, if it is specified, on the payment page | 0 - disabled 1 - enabled | |
| language | String | + | Payment page language | ukr en ru |
| signature | String | + | Control signature. A String of concatenated parameters merchant_id, id, amount, language separated by “;” (semicolon) in UTF-8 encoding is subject to HMAC_SHA512 using the merchant's `SecretKey'.Order of parameters during concatenation is important! |
The following parameters are received in response:
Successful
| Parameter | Type | Description | Value |
|---|---|---|---|
| result | Integer | Response Status | 0 |
Unsuccessful
| Parameter | Type | Description | Value |
|---|---|---|---|
| code | Integer | Error code | |
| message | String / Array | Description of the error |
Example request:
{
"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"
}
Example of a success response:
{
"result": 0
}
Example of a rejection response:
{
"code": -13,
"message": "Parameter signature not found"
}
Other error codes see Dictionary. System Error Codes
Getting a list of operations performed on the specified link
Production url: https://****.procard-ltd.com/permanent-links/operations
To get a list of operations performed on the specified permanent link, you need to send a POST request with the following data.
POST parameters:
| Parameter | Type | Required | Description | Value |
|---|---|---|---|---|
| merchant_id | String | + | Merchant ID | |
| id | String | + | Permanent link ID | |
| per_page | Integer | Number of operations on page | Default: 100 | |
| page | Integer | Page number | Default: 1 | |
| signature | String | + | Control signature. A String of concatenated parameters merchant_id, id separated by “;” (semicolon) in UTF-8 encoding is subject to HMAC_SHA512 using the merchant's SecretKey.Order of parameters during concatenation is important! |
The following parameters are received in response:
Successful
| Parameter | Type | Description | Value |
|---|---|---|---|
| result | Integer | Response Status | 0 |
| operations | Array | An Array of objects (operations) related to this link in APPROVED and WAITING-AUTH status. Default: the most recent 100 operations performed | |
| per_page | Integer | Number of operations on page | |
| page | Integer | Page number | |
| total | Integer | Total number of operations |
Unsuccessful
| Parameter | Type | Description | Value |
|---|---|---|---|
| code | Integer | Error code | |
| message | String / Array | Description of the error |
An element of the operations Array
| Parameter | Type | Description | Value |
|---|---|---|---|
| merchant_id | String | Merchant ID | |
| id | Integer | Operation ID | |
| date | String | Date of operation | |
| amount | String | Amount | |
| total_amount | String | Final amount | |
| fee | String | Commission amount | |
| status | String | Operation Status (see Dictionary. Payment Statuses) | |
| card_number | String | Masked card number | |
| order_id | String | Order ID | |
| description | String | Purpose of payment | |
| STAN | String | Transaction number |
Example request:
{
"merchant_id": "TEST_TRADER_2",
"id": "yqqNCgWLkD",
"per_page": 2,
"page": 2,
"signature": "d77dadde9b9bfee8137ab2904b33bd0d"
}
Example of a success response:
{
"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
}
Example of a rejection response:
{
"code": -13,
"message": "Parameter signature not found"
}
Other error codes see Dictionary. System Error Codes