Void

---

• Description： Void the order if the payment method allows
• Path： /tokenization/void
• Method： POST
• Request Header： Content-Type: application/json

Request Parameters

Parameter	Type	Mandatory	Description
merchantId	String	M	Merchant identifier
orderId	Number	C	Order ID of the payment. Mandatory when merchantReference is not given
merchantReference	String(64)	C	Unique reference of the order. Mandatory when orderId is not given

Example:

{
  "request": "{\"merchantId\":3,\"orderId\":5800}",
  "signature": "i25WiZAALHUnBEXX7dF2zlPs0XduBD3/qE13nVBn+gk22TScDdZ1rIHnrQ1x0OJ536uRlbANPJBoTcPfjvKUOkaBW3ExY6favEtwF70sfWRpBB79qVBj8OIxO/NdEMjXg37bQcZx47Yty1ChhIowyC3c2GAYwDMSGPCMg+zEzDB1tLh2DdDyxv1tjZs7IzjEbidusvvsp+FvhMKm3YkkN0Nor3AFI73C/l+zc15pmEi9vz2IInIoL70z1RGvRIcxrKVYhP0+K/LWzBonDlR5cLDU3DSZ5rSmdnrBTb7qds2cmSUKmNZ4Wk0rqu/RvsBOIXQV/V/Rwc2mJoL0GMVxWg=="
}

Response Parameters

parameter	type	Mandatory	description
responseCode	String	M
message	String	M
order	Object	M
order.id	Number	M	Order identifier
order.merchantId	Number	M	Merchant identifier which own this order
order.merchantReference	String	M	Your reference for the order
order.currency	String	M	3-Letters ISO currency code of the order
order.amount	Number	M	Order amount
order.netAmount	Number	M	Net amount of the order
order.cardType	String	M	Card type of the order
order.createTime	Datetime	M	Timestamp when the order is created. Maintained by the Payment Gateway
order.updateTime	Datetime	M	Timestamp when the order is last updated. Maintained by the Payment Gateway
order.status	String	M	Status of the order. Maintained by the Payment Gateway
order.recurring	Boolean	M	Flags the order is a recurring order or not
transaction	Object	M
transaction.id	Number	M	Transaction identifier for the void transaction
transaction.merchantId	Number	M	Merchant identifier which own this transaction
transaction.type	String	M	Transaction type
transaction.amount	String	M	Transaction amount
transaction.status	String	M	Status of the transaction. Maintained by the Payment Gateway
transaction.maskedPan	String	M	Masked card number of the original sale transaction if supported by the payment method
transaction.stan	String	M	System trace audit number for the transaction

Example:

{
  "responseCode": "0000",
  "order": {
    "id": 5800,
    "merchantId": 3,
    "merchantReference": "merRef1656991269870",
    "currency": "USD",
    "amount": 30.00,
    "netAmount": 0,
    "cardType": "VISA",
    "createTime": "2022-07-05T03:21:10.000+00:00",
    "updateTime": "2022-07-05T03:21:12.000+00:00",
    "status": "VOIDED",
    "recurring": true
  },
  "transaction": {
    "id": 3973,
    "merchantId": 3,
    "type": "SALE_VOID",
    "amount": 30.00,
    "currency": "USD",
    "status": "SUCCESS",
    "maskedPan": "470534XXXXXX8101",
    "stan": "3971"
  }
}