Payment Details API
This section contains the information you need to retrieve the non-sensitive data associated with a
Unified Checkout
transient token and the payment details API. This API can be used to retrieve personally identifiable information, such as the cardholder name and billing and shipping details, without retrieving payment credentials; which helps ease the PCI compliance burden. There are two methods of authentication:
IMPORTANT
When integrating with
Cybersource
APIs, Cybersource
recommends that you dynamically parse the response for the fields that you are looking for. Additional fields may be added in the future. You must ensure that your integration can handle new fields that are returned in the response. While the underlying data structures will not change, you must also ensure that your integration can handle changes to the order in which the data is returned.
Cybersource
uses semantic versioning practices, which enables you to retain backwards compatibility as new fields are introduced in minor version updates.Endpoint
Production:
GET
https://api.cybersource.com
/up/v1/payment-details/{id}
Test:
GET
https://apitest.cybersource.com
/up/v1/payment-details/{id}
The
{id}
is the full
JWT received from Unified Checkout
as the result of capturing payment
information. The transient token is a JWT object that you retrieved as part of a
successful capture of payment information from a cardholder.
REST Example: Retrieving Transient Token Payment Details
Request
GEThttps://apitest.cybersource.com/up/v1/payment-details/{id}
Response to Successful Request
{ "paymentInformation": { "card": { "expirationYear": "2024", "number": "XXXXXXXXXXXX1111", "expirationMonth": "05", "type": "001" } }, "orderInformation": { "amountDetails": { "totalAmount": "21.00", "currency": "USD" }, "billTo": { "lastName": "Lee", "country": "US", "firstName": "Tanya", "email": "[email protected]" }, "shipTo": { "locality": "Small Town", "country": "US", "administrativeArea": "CA", "address1": "123 Main Street", "postalCode": "98765" } } }