On This Page
Reverse an Apple Pay Payment Authorization
The topics in this section shows you how to reverse an Apple Pay payment authorization.
IMPORTANT
In the example, the authorization being reversed
is for a payment made using a .
Visa card
,
and the processor is
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 more information, see
Cards Supported for Apple Pay on Visa Platform Connect.
For general information about authorization reversals,
see the "Standard Payments Processing" section of the
.
Basic Steps: Reversing a Payment Authorization
- Follow these steps to reverse an Apple Pay payment authorization:
- Create the request message with the requiredRESTAPI fields.
- Use the API fields listed in Fields Required to Reverse a Payment Authorization.
- Refer to the example in REST Example: Reverse a Payment Authorization.
- Send the request to one of these endpoints:
- Production:POSThttps://api.cybersource.com/pts/v2/payments/{id}/reversals
- Test:POSThttps://apitest.cybersource.com/pts/v2/payments/{id}/reversals
ADDITIONAL INFORMATION
Replace the{id}portion of the URL with the transaction ID of the payment that you want to reverse. The transaction ID is returned in theidfield of the response to the authorization request. Example value: 7359642011156554503954 - 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 Reverse a Payment Authorization
As a best practice,
include these
REST API
fields
in your request to reverse the authorization of an Apple Pay 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 to001to identify Apple Pay as the digital payment solution.
REST Example: Reverse a Payment Authorization
Request
{ "clientReferenceInformation": { "code": "TC_1231223" }, "processingInformation": { "paymentSolution": "001" }, "orderInformation": { "amountDetails": { "currency": "USD" } }, "reversalInformation": { "amountDetails": { "totalAmount": "10" } } }
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": "2025-01-04T23:56:13Z" }