On This Page

Capture

Use this information to process a capture.

Use the capture service to complete a pre-authorization.

When a transaction is below the threshold for First Ride Risk protection, use the capture service to capture funds from a declined authorization. For more information, see First Ride Risk.

Endpoint

Production:

POST https://api.cybersource.com/pts/v2/payments/{id}
/captures

Test:

POST https://apitest.cybersource.com/pts/v2/payments/{id}
/captures

The

{id}

is the transaction ID returned in the authorization response.

Required Fields for a Capture

clientReferenceInformation.code
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount

REST Example: Capture

Request

{
   "clientReferenceInformation": {
        "code": "TCCUP1"
    },
   "orderInformation": {
    "amountDetails": {
      "totalAmount": "5",
      "currency": "THB"
    }
  }
}

Response to a Successful Request

{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/captures/7012404694986081603137/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/captures/7012404694986081603137"
        }
    },
    "clientReferenceInformation": {
        "code": "TCCUP1"
    },
    "id": "7012404694986081603137",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "5.00",
            "currency": "THB"
        }
    },
    "reconciliationId": "333306641171",
    "status": "PENDING",
    "submitTimeUtc": "2023-11-9T06:47:50Z"
}