Parameter | Description | Value |
operation | Type of transaction |
|
merchant_id | Merchant ID | |
amount | Transaction amount | Example 500.00 |
signature | In order to confirm the validity of the data, a verification signature must be generated and transmitted in the SHA-512 request using the merchant's private_key. | |
A string subject to SHA-512 is generated by concatenating the merchant_id, order_id, amount, currency_iso, description parameters separated by “;” (semicolon) in UTF-8 encoding. | ||
The order of the parameters when concatenating is important! | ||
order_id | The unique transaction number on the merchant's side. If the operation is duplicated, the merchant receives an error. | |
currency_iso | Payment currency. | UAH |
description | Purpose of payment. Displayed on the payment page when entering payment details. Displayed in account statement and registers | |
add_params | An array with additional parameters. Additional parameters are then returned to the merchant in the CALLBACK call | |
split | Payment split sign | 0 - do not split |
1 - split | ||
split_rules | An array with splitting rules that contains submerchant identifiers and amounts. | |
The amount of splits must match the amount of the payment. | ||
Example: | ||
split_rules[0][sub_merchant_id]=test1&split_rules[0][amount]=100.00&split_rules[1][sub_merchant_id]=test2&split_rules[1][amount]=50.00&.......&split_rules[n][sub_merchant_id]=testn&split_rules[n][amount]=10.00 | ||
approve_url | URL to redirect in case the payment is successful | |
decline_url | URL to redirect in case the payment is not successful | |
cancel_url | URL to redirect in case the user refused to make a payment | |
callback_url | URL to which information about the result of the payment will be sent |
Recurring payments RecPayment (payment by token)
Test url https://pay-test.procard-ltd.com/api (the client receives the production url in the project log)
To make a recurring payment, you need to send a POST request with the following parameters:
Parameter | Description | Value |
operation | Type of transaction | RecPayment |
merchant_id | Merchant ID |
|
amount | Transaction amount | Example 500.00 |
recurring_token | Token received from PS |
|
order_id | Unique order number in the merchant system |
|
description | Purpose of payment |
|
currency_iso | Currency. Currently only UAH |
|
auth_type | Authorization type | 1 - Purchase (PURCHASE), Default - 1 |
secure_type | 3DS verification | 1 - operation without 3DS, |
signature | In order to confirm the validity of the data, a verification signature must be generated and transmitted in the SHA-512 request using the merchant's private_key. |
|
A string subject to SHA-512 is generated by concatenating merchant_id, order_id, amount, recurring_token, currency_iso, description parameters separated by “;” (semicolon) in UTF-8 encoding. |
| |
The order of the parameters when concatenating is important! |
|
The response is JSON with the following parameters:
Name | Parameter |
status | APPROVED - successfully, |
DECLINED - operation failed | |
code | Response code (See list of response codes below) |
signature |
Example:
Request
Code Block | ||
---|---|---|
| ||
{"operation": "RecPayment", "amount": "100.00", "order_id": "12345678", "signature": "", "add_params": {}, "description": "Описание", "merchant_id": "merchant_id", "currency_iso": "UAH", "recurring_token": "", "auth_type":"1", "secure_type":"2"} |
Response
Code Block | ||
---|---|---|
| ||
{"status": "3ds", "code": 0, "d3_acs_url": "http://acs.url", "d3_md": "*****************", "d3_pareq": "***********"} |
Operation Check
Test url https://pay-test.procard-ltd.com/api/check (the client receives the production url in the project log)
To check the operation status, send a POST request with the following parameters:
Parameter | Description | Value |
operation | Type of transaction | Check |
merchant_id | Merchant ID |
|
order_id | This is the unique number of the operation that was sent in the P2PCREDIT, P2PDEBIT, VERIFY or VERIFY PurchaseOnMerchant request |
|
signature | In order to confirm the validity of the data, a verification signature must be generated and transmitted in the SHA-512 request using the merchant's private_key. |
|
A string subject to HMAC_MD5 is generated by concatenating the merchant_id, order_id parameters separated by “;” (semicolon) in UTF-8 encoding. | ||
The order of the parameters when concatenating is important! |
The response is JSON with the following parameters:
Parameter | Description | Value |
reasoneCode | Response code. (See below for a list of response codes) |
|
reason | Response Description |
|
merchant_id | Merchant ID |
|
amount | Transaction amount |
|
phone | Phone number |
|
createdDate | Payment date |
|
cardPan | Masked card number |
|
cardType | Card type |
|
transactionId | Transaction ID |
|
message | Text message with query result |
|
datetime | Date the operation was created on the server |
|
fee | Payment fee |
|
transactionStatus | Operation status (Reference see below) |
|
signature |
Filter by label (Content by label) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|