On This Page
FILTER BY TAG

Timeout Void for a Capture, Sale,
Refund
, or
Credit

When you do not receive a response message after requesting a capture, sale,
refund
, or
credit
, this feature enables you to void the transaction that you requested.
IMPORTANT
Wait 60 seconds before requesting a timeout service. For guidance on timeout scenarios, see Transaction Timeout Guidance
Include the
clientReferenceInformation.transactionId
 field in the original request for a capture, sale,
refund
, or
credit
. The value of the merchant transaction ID must be unique for 180 days.
When the original transaction fails, the response message for the reversal request includes these fields:
  • voidAmountDetails.originalTransactionAmount
  • processorInformation.responseCode

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/voids/
Test:
POST
https://apitest.cybersource.com
/pts/v2/voids/

Required Fields for a Timeout Void for a Capture, Sale,
Refund
, or
Credit

REST Example: Timeout Void for a Capture, Sale, Refund, or Credit

Request
{
  "clientReferenceInformation": {
    "transactionId": "987654321"
  },
  "reversalInformation": {
    "amountDetails": {
      "totalAmount": "100.00"
    },
    "reason": "testing"
  }
}
Response to a Successful Request
{
  "_links": {
    "self": {
      "method": "GET",
        "href": "/pts/v2/voids/6541933390746728203005"
    }
  },
  "clientReferenceInformation": {
    "code": "1654193339056"
  },
  "id": "6541933390746728203005",
  "orderInformation": {
    "amountDetails": {
      "currency": "USD"
    }
  },
  "status": "VOIDED",
  "submitTimeUtc": "2022-06-02T18:08:59Z",
  "voidAmountDetails": {
    "currency": "usd",
    "voidAmount": "100.00"
  }
}
RELATED TO THIS PAGE