Void

If an authorized payment has to be voided, then void api shall be used.

The void model

The void model contains all the information required to void an authorized payment.

Properties

Name
paymentID
Type
string
Description
The payment id (transaction receipt) of the order

POST/custom/void

Void a payment

This endpoint allows you to void an authorized payment.

Required attributes

Name
paymentID
Type
string
Description
The payment id (transaction receipt) of the order

Request

POST

/custom/void

curl -X POST https://stagingapi.platform.poweredbytandym.com/custom/void \
  -H 'content-type:application/json' \
  -H 'apiKey:{YOURPAY_API_KEY}' \
  -H 'secret:{YOURPAY_API_SECRET}' \
  -d '{
        "paymentID":"d0254461-7607-4d28-a0b8-accff6b1d0af"
      }'

Success Response

{
  "void": 1
}

Error Response

{
  "void": 0,
  "errorcode": "VOID_UNSUCCESSFUL",
  "errormessage": "Void is not successful!"      
}