Cancel a transaction

Cancel transactions up to 50 orders in a single request.
Merchant can also manually cancel a transaction in Merchant Portal.

curl --location --request POST 'https://test.your-api-server.com/v1/cancel' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-raw '{ "merchant_id": "1018001", "account_id": "1018001003", "encryption_data": "dd7272885fd236dfb8962292b70cfa89e4f17cd509dc822d87de60bdc4e385f7", "cancel_orders": [{ "transaction_id": "1379870445276102656", "order_no": "1731482719332", "currency": "USD", "amount": "107.74" }] }'

{ "merchant_id": "1018001", "account_id": "1018001003", "return_message": "OK", "return_status": "1", "encryption_data": "dd7272885fd236dfb8962292b70cfa89e4f17cd509dc822d87de60bdc4e385f7", "cancel_orders": [ { "amount": "107.74", "cancel_status": "1", "currency": "USD", "error_message": "", "order_no": "1731482719332", "transaction_id": "1379870445276102656" } ] }

Request

Header Params

Content-Type

string

required

Example:

application/x-www-form-urlencoded

Body Params application/json

merchant_id

string

required

Merchant Code or Merchant ID or Merchant Number

account_id

string

required

Account ID or Gateway Number

encryption_data

string

required

Digital signatures information
encryption_data=sha256(merchant_id + account_id + transaction_id1 + transaction_id2 ...+ sign_key);
All encryption parameters need to remove spaces before encryption.

cancel_orders

array [object {4}]

required

transaction_id

string

required

Transaction ID generated by gateway system, the Transaction ID = Order No + '-' + 5 digits random number

<= 50 characters

Example:

1377153085188472832

order_no

string

required

Merchant Order Number

<= 50 characters

Example:

1591065261405

currency

string

required

Transaction currency

<= 3 characters

Example:

USD

amount

string

required

Full order amount

<= 15 characters

Example:

10.36

Examples

Responses

🟢200Success

application/json

Body

merchant_id

string

required

account_id

string

required

return_message

string

required

return_status

string

required

encryption_data

string

required

cancel_orders

array [object {6}]

required

amount

string

required

cancel_status

string

required

currency

string

required

error_message

string

required

order_no

string

required

transaction_id

string

required