Payment Credentials

Overview

This section contains the information you need to retrieve the full payment credentials collected by Click to Pay Drop-In UI 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.

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.

Returned Credentials

A payment account number (PAN) or network token is returned on your request depending on your payment method and Click to Pay Drop-In UI account status. This table shows the payment credentials returned by card type and Click to Pay Drop-In UI account status:

Click to Pay Drop-In UI Account Status	American Express	Mastercard	Visa
New card not saved in Click to Pay Drop-In UI	PAN	PAN	PAN
New card saved in Click to Pay Drop-In UI	PAN	Network Token	Network Token
Existing card stored in Click to Pay Drop-In UI	PAN	Network Token	Network Token

When you retrieve PAN information from the Payment Credentials API, the response includes the PAN, card expiration date, and the card verification value (CVV). When you retrieve network token information, the response includes the network token and network token cryptogram.

Network tokens are generated in the wallet of the Click to Pay Drop-In UI token requestor ID (TRID). When tokenization is successful, Visa and Mastercard can also complete authentication during the Click to Pay Drop-In UI experience to acquire a fully authenticated response. For information on authentication, see Click to Pay Drop-In UI Customer Authentication.

Endpoints

GET /flex/v2/payment-credentials/{paymentCredentialsReference}

The {paymentCredentialsReference} is the reference ID returned in the id field when you created the payment credentials.

Required Fields

Your payment credentials request must include this field:

ReferenceID string · Required

The reference ID that is returned in the paymentCredentialsReference.[organizationID] field of the transient token data object after a successful Click to Pay Drop-In UI interaction. This is an example paymentCredentialsReference.[organizationID] field in the transient token response payload:

"paymentCredentialsReference": {    "na_partner_ctp2": "qlXufLdFrU_TIIye497LN"  },...

Example

/flex/v2/payment-credentials/E-firqlLk7GiziQwXxAsq

eyJhdWQiOiJwc3AiLCJzdWIiOiJwc19ocGEiLCJraWQiOiIyMDIzMDUxNC1kcmFmdC1wc3AtZW5jcnlwdCIsImN0eSI6IkpXVCIsImVuYyI6IkEyNTZHQ00iLCJleHAiOjE2ODQxNDk2NjQsImFsZyI6IlJTQS1PQUVQLTI1NiIsImp0aSI6IjA0NDUwNWNiLTM1ZDYtNDU2ZS05OTBlLWRkZjQwYzI5NzlhNCJ9.enhUfZJOjbMX-wZPIOb1zj8sFZiix6JSJyNw2i9QJ4k_hd7Iy_UMYvOmS-X1FJwjH0IQxMIblSV8XqMegIOm5dYBYdqouUfC8zq4Zm_dsMoTp3m9T6z-A_eJ8MGaxqTHSf2vWiXB-EMrww2eCXPyVTBkI1OdmYIX-s85vsqYpW-s0ThlCKaGI7B4_rJKNa7mou9VMBtBnfzhHLtnHDW8vsX8rLmTT76Ct2jMdIoQnlQRgEOi-zYu0Jm0gHERavUtq_7lDw9Ta73_TFw3KA2fsG13CURyR7ZXoZy9_nRifwHjwNVbaFRceAzXoVtvM8H8F-ZzIC8AdA1FRye7RqcK9Q.OlrMxOMDkVDU6goS.TPfBhm1eBfRjCSSvuT6SxFeZ3SGwOC6qX2Z4rlAEY9lOor2Q2E1CMqB6o-q6DNkGtASFONBzKtoB0yAgXBpx3S72FltR8bd40qmRnPyTOAscXa3eWbP45EqZqHW58lwUtMwcBORcfSjxPnWUo-OGmKCtIgiUO4MTlBsl9HdCLx7RWpwslo0pKQAuFrURHJyhdE1JUArgjNQMdQwPvCjoZ2RxTzECEqE1l0KmBGM-w8suowrnTNZl8cwVUZKzHQEJV-twAGykQIIRCI3ydHfCupyUuA-5-Wvlk6nhcL3qND4JF-E3EIRpzm7WH8pCV5nzByUue-grHejg774c7fi1ehfTBUZ8v6X7rTZUBLL0V5343X3zQQy_G-vq5qcaJZ8AS2XWSi17r8UEHoU5emYu5QAuXy1AhL32nDRZuXzOzQ19JsrTN2CD8qxU7tDpkUCEmY2GEMp4sd-rfu_2qBZDdr74tjYNgMsTIXSpgGDiwjLMJu4r460YencO6-JweGCT8woIySjBRYpX1_axxcO6I9RUTSopPbslZwq_zpy3UuDa9InlSexM--fatYfAehY857F7bFVXlnXeqr7X0_LribJsx6CWJU1ihjMVtnF-SxeE3IdpJxyFYBb7D1iL3ywFooxcGqarXU-3_CBuDHvnJFDC_iQPaeH7csb-EMeNqFTmFf8dWNQYG7IJDfEnrnRW_XtnczH-ZS67iVuGzGwJZDQfJZ-KLhnWr6FE1EnT1VLyXPM78WeocT7cnLXmr9BgevNmU3q_SV5nxlDLPuCqF0PmFNxaTjqfF2Qw_zOCvazwFWuBdUDdHilPqhj3gfsOesAJVA7VoTDw2U3zte3V09KcJLaHygwPomopWOODinKzcZeWfJ39984pQa5cOMSEToGegkRZyvSxpf5PTht30uB3F3qC4cVLOu4qukYsrjXqOtxg3icde7lXywfAtEZgf54jAP2Cl8JFmGWL5YnIY44-zj-GVz2C8iCN1CCUP3U4eVxz2GtxNNSXuwY8ORUdino4rF-OpqqdjX5F0Uw6J2D3uR9cWB4Ee3v8TIA3-tRkG4ScAcclEwjkwsILPgVLU57HOm0AnaEsznyHrd9-Qfz_p-UjbsaD3e-_sr56-x2UZVVL6TAMmJqmS2C55CHgkkhtHBCu-vb0KOmssopIvaQA5jK6ZoCftewE8-98816ZmoU8Sty05PSeK0yBlxFwTIeJxt-moszRawFuBrLAbOu72y_eeUtk1tHpHV2Db7T6XvaRD4NvOFZg8ianYY6uHidoTl1ApjCp8VG9oTJ-uKWAEp9TU6qEHUswZZUIBeGTKjzBkRAQ20cZs5POb-qtjteoWo9QdnczipZ8demy-FSZwNRFPkeedl3oHLepeTgwVnmij9ovk0e5Wqq2GVUMe8sLa-4eEnjliIjAVUQ9YNJBeqLf6_wo3HF8o2k4ZgSJTuPHAuP41-D6sYrOcM6WvkCfKRTXw7ue5unri3M0Rpd2TEnzyw.TaLt6G8QyRykbrxb0iV9Jg

{  "aud": "na_partner_ctp2",  "sub": "0404_testctpdiui001",  "clientReferenceInformation": {    "applicationVersion": "1.4.0",    "applicationUser": "UC",    "code": "1778664244584",    "applicationName": "unifiedCheckout"  },  "deviceInformation": {    "fingerprintSessionId": "ea5f708f-0a77-4623-bdf8-62bb656c4a1f"  },  "orderInformation": {    "billTo": {      "firstName": "firstName",      "lastName": "lastName",      "country": "GB",      "phoneNumber": "07700900123",      "address2": "test address1",      "address1": "test address1",      "postalCode": "W26TT",      "locality": "London",      "buildingNumber": "",      "administrativeArea": "",      "email": "[email protected]"    },    "amountDetails": {      "totalAmount": "100.00",      "currency": "GBP"    },    "shipTo": {      "country": "GB",      "lastName": "lastName",      "firstName": "firstName",      "address1": "test address1",      "postalCode": "W26TT",      "locality": "London",      "buildingNumber": "",      "administrativeArea": ""    }  },  "paymentInformation": {    "card": {      "expirationYear": "2029",      "number": "FOURONE11111111111111",      "securityCode": "123",      "expirationMonth": "12",      "type": "001",      "typeSelectionIndicator": "1"    }  },  "exp": 1778664881,  "jti": "P6RXHH8Lc79oT1DKS1_Rs"}

{  "aud": "na_partner_ctp2",  "sub": "0404_testctpdiui001",  "clientReferenceInformation": {    "applicationVersion": "1.4.0",    "applicationUser": "UC",    "code": "1778664940677",    "applicationName": "unifiedCheckout"  },  "deviceInformation": {    "fingerprintSessionId": "e8cc0b02-7eb3-476b-8253-055b39cdcb62"  },  "processingInformation": {    "paymentSolution": "027"  },  "orderInformation": {    "billTo": {      "firstName": "Tanya",      "country": "GB",      "lastName": "Lee",      "phoneNumber": "44 7700900123",      "address2": "test address1",      "address1": "1 Example Street",      "postalCode": "AB1 2CD",      "locality": "Example Town",      "buildingNumber": "",      "administrativeArea": "",      "email": "[email protected]"    },    "amountDetails": {      "totalAmount": "100.00",      "currency": "GBP"    },    "shipTo": {      "lastName": "lastName",      "firstName": "firstName",      "country": "GB",      "address1": "test address1",      "postalCode": "W26TT",      "locality": "London",      "buildingNumber": "",      "administrativeArea": ""    }  },  "paymentInformation": {    "tokenizedCard": {      "transactionType": "1",      "expirationYear": "2033",      "number": "FOURTHREE23126880583278",      "expirationMonth": "08",      "type": "001",      "cryptogram": "Ax0AAGQfGv6nK5QDMx6WgIUxYeg="    },    "card": {      "typeSelectionIndicator": "1",      "useAs": "D"    }  },  "exp": 1778665630,  "jti": "U3lO1Flys1fcQmAWLzchn"}

Was this page helpful?

Last published: September 29, 2026