Pay with Token

You can use Unified Checkout to pass a single Token Management Service (TMS) token ID and display the associated payment instrument within the Unified Checkout UI. To display a payment instrument in the Unified Checkout UI, include TMS_TOKEN as an allowed payment type in the allowedPaymentTypes field object, and provide the details of the TMS token in the paymentConfigurations field object in the session request:

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

This is an example UI with a payment instrument:

Token Types

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

Customer Tokens

When you include a customer token, your UI displays the default payment instrument that is linked to a customer. To display a customer token, include the paymentConfigurations.TMS_TOKEN.customer.id field in your session request:

{  "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, include the paymentConfigurations.TMS_TOKEN.instrumentIdentifiers.id field in your session request:

{  "paymentConfigurations": {    "TMS_TOKEN": {      "instrumentIdentifiers": [        {          "id": "4B1BCB328D52ED86E063AF598E0A99A5"        }      ]    }  }}

Payment Instrument Tokens

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, include the paymentConfigurations.TMS_TOKEN.paymentInstruments.id field in your session request:

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

Creating a Token During Checkout

The complete mandate can create a TMS token for the payment method used during checkout. Include the completeMandate.tms object in your session request to enable token creation:

TMS Token Creation by Payment Method

This table shows when a token is created, based on the payment method and configuration:

For information about requestSaveCard and the capture mandate, see Sessions.

Creating a New Payment Instrument Under an Existing Customer

For example:

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

Related Payment Methods

• Card Payments
• Digital Wallets
• Alternative Payment Methods
• Sessions