Void
- Description: Void the order if the payment method allows
- Path:
/direct/void
- Method:
POST
- Request Header:
Content-Type: application/json
#
Request ParametersParameter | Type | Required | Description |
---|---|---|---|
merchantId | string | Required | Merchant identifier |
orderId | number | Conditional | Order ID of the payment. Required when merchantReference is not given |
merchantReference | string | Conditional | Unique reference of the order. Required when orderId is not given |
#
Example:#
Response ParametersParameter | Type | Required | Description |
---|---|---|---|
responseCode | string | Required | Payment Gateway response code |
message | string | Required | Payment Gateway response message |
order | object | Required | |
order.id | number | Required | Order identifier |
order.merchantReference | string | Required | Merchant identifier which own this order |
order.currency | string | Required | 3-Letters ISO currency code of the order |
order.status | string | Required | Status of the order. Maintained by the Payment Gateway |
order.amount | number | Required | Order amount |
order.createTime | datetime | Required | Timestamp when the order is created. Maintained by the Payment Gateway |
order.updateTime | datetime | Required | Timestamp when the order is last updated. Maintained by the Payment Gateway |
transaction | object | Required | |
transaction.id | number | Required | Transaction identifier for the void transaction |
transaction.merchantId | number | Required | Merchant identifier which own this transaction |
transaction.type | string | Required | Transaction type |
transaction.currency | string | Required | Transaction currency |
transaction.amount | number | Required | Transaction amount |
transaction.status | string | Required | Status of the transaction. Maintained by the Payment Gateway |
transaction.maskedPan | string | Required | Masked card number of the original sale transaction if supported by the payment method |
transaction.stan | string | Required | System trace audit number for the transaction |