Complete Mandate - completeMandate.tms

completeMandate.tms.tokenCreate

: This field determines if a TMS token is created for the customer's selected payment method. When this field is set to

true

, a token is created. When this field is set to

false

or not included in the request, a token is not created.

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.

completeMandate.tms.tokenTypes

: This is an optional field that you can use to indicate the token type for the token that is created. When this field is not included in the request, a token is created based on your TMS vault configuration. You can set this field to these values:

customer

instrumentIdentifier

paymentInstrument

shippingAddress

If you want Unified Checkout to capture the cardholder's consent to save the card before a request to create a token is completed, then you must set

captureMandate.requestSaveCredentials

to

true

. When this field is set to

true

, Unified Checkout presents a Save card for future payments
checkbox within the UI and enables the cardholder to give consent. Do not include

captureMandate.requestSaveCredentials

in your request if you have already gained cardholder consent to create a TMS token or do not require consent.

This table indicates if a token is created given the requested payment method:


Payment Method	Capture Context	Result
PAN Entry and `Click to Pay`	completeMandate.tms.tokenCreate = true	`TMS` token is created at the token level(s) specified in the request or based on the default for the token vault.
PAN Entry and `Click to Pay`	completeMandate.tms.tokenCreate = true and captureMandate.requestSaveCredentials = true	Cardholder can check Save Payment Information in `Unified Checkout`. The request to create a token is made when the cardholder checks this field in the UI. When it is not checked, ni token is created.
Apple Pay, Google Pay	completeMandate.tms.tokenCreate = true	`TMS` token is created at the token level(s) specified in the request or based on the default for the token vault.
Apple Pay, Google Pay	completeMandate.tms.tokenCreate = true and captureMandate.requestSaveCredentials = true	`Unified Checkout` cannot obtain consent to create a token and no token is created when the customer completes the payment.