3.1. Basic operations

This page describes the main operations of the Procard.Pay dispatch system

The main operations include:

  • Purchase - purchase operation using a card

  • Hold - blocking funds on the client's card as part of a two-stage payment

  • Complete - debiting funds from the client's card as part of a two-stage payment

  • Verify - card verification operation

  • Reverse - refund / partial refund online

  • Refund - refund / partial refund offline

Purchase / Hold operation on the processing payment page

Test url https://pay-test.procard-ltd.com/api (the client receives the production url in the project log)

To perform an operation on the processing payment page, the merchant needs to go to the processing center page with POST data:


On this page:

Parameter

Description

Value

Parameter

Description

Value

operation

Type of transaction

  • Purchase

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

 

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

 

phone

Customer phone number

Not mandatory

redirect

true / false - by default true, if the parameter is true, then the client will not receive a redirect, but will receive the URL of the payment page

Not mandatory

auth_type

Authorization type

Not mandatory
1 – PURCHASE,
2 – Pre-Authorization (HOLD)
Default – 1

Operation Complete

Test url https://pay-test.procard-ltd.com/api (the client receives the production url in the project log)

To complete the pre-authorization (HOLD) operation, send a POST request with the following parameters:

Parameter

Description

Value

Parameter

Description

Value

operation

Type of transaction

  • Complete

merchant_id

Merchant ID

 

order_id

This is the unique number of the operation that was sent in the PURCHASE request.

 

amount

Write-off 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 merchant_id, order_id , amount 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

Parameter

Description

Value

code

Response code. (See below for a list of response codes)

 

message

Text message with query result

 

signature

 

 

Operation Verify

Test url https://pay-test.procard-ltd.com/api (the client receives the production url in the project log)

To check the card, it is necessary to send / redirect the user to the payment gateway page using the POST method with the following parameters:

Parameter

Description

Value

Parameter

Description

Value

operation

Type of transaction

Verify

merchant_id

Merchant ID

 

order_id

This is a unique transaction number. Generated on the side of the merchant. It must be unique throughout the work.

 

approve_url

The URL to which the user will be redirected in case of a successful operation

 

decline_url

The URL to which the user will be redirected in case of an unsuccessful operation

 

cancel_url

The URL to which the user will be redirected if the operation is canceled

 

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, recurring_token, currency_iso, description parameters separated by “;” (semicolon) in UTF-8 encoding.

 

 

The order of the parameters when concatenating is important!

 

Operation Reverse

Test url https://pay-test.procard-ltd.com/api/reverse (the client receives the production url in the project log)

To make a reverse, you must send a POST request with the following parameters:

Parameter

Description

Value

Parameter

Description

Value

operation

Type of transaction

Reverse

merchant_id

Merchant ID

 

order_id

This is a unique transaction number. Generated on the side of the merchant. It must be unique throughout the work.

Note: P2PCREDIT operation reverse is not allowed

 

amount

Operation amount
If the operation amount is omitted, then the full amount of the operation is returned

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 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

Parameter

Description

Value

code

Response code. (See below for a list of response codes)

 

message

Text message with query result

 

signature

 

 

Operation Refund (offline operation!)

Test url https://pay-test.procard-ltd.com/api/refund (the client receives the production url in the project log)

To make a refund, you must send a POST request with the following parameters:

Parameter

Description

Value

Parameter

Description

Value

operation

Type of transaction

Refund

merchant_id

Merchant ID

 

order_id

This is the unique number of the operation that was sent in the P2PCREDIT, P2PDEBIT or VERIFY request

 

amount

Operation amount
If the operation amount is omitted, then the full amount of the operation is returned

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 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

Parameter

Description

Value

code

Response code. (See below for a list of response codes)

 

message

Text message with query result

 

signature

 

 


Copyright © 2015-2023 PROCARD