Payment Credentials API
This section contains the information you need to retrieve the full payment credentials collected by the
Unified Checkout
tool using the payment credentials API. The payment information is returned in a redundantly signed and encrypted payment object. It uses the JSON Web Tokens (JWTs) as the data standard for communicating this sensitive data.IMPORTANT
Payment information returned by the
payment-credentials
endpoint will contain Personal Identifiable Information (PII). Retrieving this sensitive information requires your system to comply with PCI security standards. For more information on PCI security standards, see: https://www.pcisecuritystandards.org/The response is returned using a JWE data object that is encrypted with your public key created during the
Unified Checkout
tool's integration. For more information, see Upload Your Encryption Key.To decrypt the JWE response, use your private key created during the
Unified Checkout
tool's integration. The decrypted content is a JWS data object containing a JSON payload. This payload can be validated with the Unified Checkout
public signature key.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
/flex/v2/payment-credentials/{ReferenceID}
Test:
GET
https://apitest.cybersource.com
/flex/v2/payment-credentials/{ReferenceID}
The
is the reference ID returned in the
{ReferenceID}
id
field when you created the
payment credentials.