On This Page

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

When you do not receive a response message after sending a capture, sale,
refund
, or
credit
 request, this feature enables you to void the transaction that you requested.
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 60 days.
When the original transaction fails, the response message for the void 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 Processing a Timeout Void for a Capture, Sale,
Refund
, or
Credit

Use the value from this field to request a timeout void:
Identifier that links the void request to the original request.

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

Request
{
  "clientReferenceInformation": {
    "transactionId": "987654321"
  }
}
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": "2023-06-02T18:08:59Z",
  "voidAmountDetails": {
    "currency": "usd",
    "voidAmount": "100.00"
  }
}