On This Page

Capture an Apple Pay Authorization

The topics in this section shows you how to capture an authorized Apple Pay payment transaction.
IMPORTANT
In the example, the payment being captured was made using a
Visa card
, and the transaction is processed with the
Visa Platform Connect
.
If you want to replicate this example for a different card or a different processor, you will need to change some of the API fields in the request message.
For general information about capture transactions, see the "Standard Payments Processing" section of the .

Basic Steps: Capturing an Authorization

  1. Follow these steps to capture an authorized Apple Pay payment transaction:
  2. Create the request message with the required
    REST
     API fields.
  3. Send the request to one of these endpoints:
    • Production:
      POST
      https://api.cybersource.com
      /pts/v2/payments/{id}/captures
    • Test:
      POST
      https://apitest.cybersource.com
      /pts/v2/payments/{id}/captures

    ADDITIONAL INFORMATION

    Replace the
    {id}
     portion of the URL with the transaction ID of the payment that you want to capture. The transaction ID is returned in the
    id
     field of the response to the authorization request. Example value: 7359642011156554503954
  4. Verify the response messages to make sure that the request was successful.

    ADDITIONAL INFORMATION

    A 200-level HTTP response code indicates success. See the .

Fields Required to Capture an Authorization

As a best practice, include these
REST API
 fields in your request to capture an authorized Apple Pay payment transaction.
Depending on your processor, your geographic location, and whether the relaxed address verification system (RAVS) is enabled for your account, some of these fields might not be required. It is your responsibility to determine whether an API field can be omitted from the transaction you are requesting.
 For information about the relaxed requirements for address data and expiration dates in payment transactions, see the
.
Set this field to the value returned in the response to the original authorization.
Set the value to
001
 to identify Apple Pay as the digital payment solution.

REST Example: Capturing an Authorization

Request
{ 
  "clientReferenceInformation": {
    "code": "TC_1231223"
  },
  "processingInformation": {
    "paymentSolution": "001"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "10",
      "currency": "USD"
    }
  }
}
Response to a Successful Request
{
  "_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/captures/6662994431376681303954/voids"
    },
    "self": {
      "method": "GET",
    }
  },
  "clientReferenceInformation": {
    "code": "TC_1231223"
  },
  "id": "6662994431376681303954",
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "10.00",
      "currency": "USD"
    }
  },
  "reconciliationId": "66535942B9CGT52U",
  "status": "PENDING",
  "submitTimeUtc": "2024-11-21T04:17:20Z"
}