On This Page
Time-Out Void
This section describes how to void an authorization, capture, refund, or credit when you do not receive a response within the time allowed and the transaction times out. To use this feature, you must include a unique value in the
clientReferenceInformation.transactionId
field in your payment,
capture, refund, or credit request and use the same unique value for the
clientReferenceInformation.transactionId
field in this request to
reverse the transaction.Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/voids/Test:
POST
https://apitest.cybersource.com
/pts/v2/voids/Required Field for a Time-Out Void
- Set this field toREVERSAL Timeout.
REST Example: Time-Out Void
Request
{ "clientReferenceInformation": { "comments": "VOID Timeout", "transactionId": "888858556" } }
Response to a Successful Request
{ "_links": { "self": { "method": "GET", "href": "/pts/v2/voids/6502849034136438604002" } }, "clientReferenceInformation": { "code": "1650284903396", "transactionId": "888858556" }, "id": "6502849034136438604002", "orderInformation": { "amountDetails": { "currency": "EUR" } }, "status": "VOIDED", "submitTimeUtc": "2022-04-18T12:28:23Z", "voidAmountDetails": { "currency": "EUR", "voidAmount": "10.00" } }
Response to a Declined Request
{ "id": "6502858209346457804004", "submitTimeUtc": "2022-04-18T12:43:41Z", "status": "INVALID_REQUEST", "reason": "INVALID_DATA", "message": "Declined - One or more fields in the request contains invalid data" }