Cards - Pay with Token

You can use Unified Checkout to pass through a single token ID to be shown within the Unified Checkout UI. To display a payment instrument in the Unified Checkout UI, you must include

TMS_TOKEN

as an allowed payment type in the

allowedPaymentTypes

field object and the details of the Token Management Service (TMS) token in the

paymentConfigurations

field object in the capture context request:

"allowedPaymentTypes": [
    "PANENTRY",
    "TMS_TOKEN"

},
  "paymentConfigurations": {
    "TMS_TOKEN": {
      "paymentInstruments": [
        {
          "id": "404352E77F6A66E7E0634136CF0ABCD7"
        }

This is an example UI with a payment instrument:

Image showing the Unified Checkout UI that includes a payment
instrument, card payment, Apple Pay, and Google Pay. — Pay with Token in `Unified Checkout` UI

You can use these token types to pay with a token in Unified Checkout:

Customer Tokens: When you include the customer token, your UI displays the default payment instrument that is inked to a customer. To display a customer token, you must include the
paymentConfigurations.TMS_TOKEN.customer.id
field in your sessions API request.

IMPORTANT

When you include a customer token ID here with
tokenCreate
for a
paymentInstrument
or
instrumentIdentifier
, the complete mandate creates a new payment instrument or instrument identifier within the level of the customer token that you provide.

"paymentConfigurations": { "TMS_TOKEN": { "customer": { "id": "404352E77F6A66E7E0634136CF0ABCD7" }
Instrument Identifier Tokens: When you include an instrument identifier token, your UI displays the payment instrument that is associated with the specified instrument identifier. To display an instrument identifier token, you must include the
paymentConfigurations.TMS_TOKEN.instrumentIdentifiers.id
field in your sessions API request.
"paymentConfigurations": { "TMS_TOKEN": { "instrumentIdentifiers": [ { "id": "4B1BCB328D52ED86E063AF598E0A99A5" }
Payment Instruments: When you include a payment instrument, your UI displays the payment instrument that is associated with the specified payment instrument token identifier. To display a payment instrument, you must include the
paymentConfigurations.TMS_TOKEN.paymentInstruments.id
field in your sessions API request.
"paymentConfigurations": { "TMS_TOKEN": { "paymentInstruments": [ { "id": "404352E77F6A66E7E0634136CF0ABCD7" }

IMPORTANT

To make a new payment instrument or instrument identifier under an existing customer during the complete mandate, you must meet these requirements:

You must include the customer token ID in the

paymentConfigurations

field object.

TMS_TOKEN

must be included in the

allowedPaymentTypes

field object.

tokenCreate

must be set to

true

and

paymentInstrument

and

instrumentIdentifier

must be included as values in the

tms.tokenTypes

field array. For example:

"tms": {
      "tokenCreate": true,
      "tokenTypes": [
        "paymentInstrument",
        "instrumentIdentifier",
      ]
    }

When you meet these requirements, a new payment instrument or instrument identifier is created under the specified customer token.

Pay with Token

Figure: