Discriminator field. Please see the discriminator mapping for the PaymentInstrumentRequest schema.

Identifier for the merchant's customer who owns the payment instrument to be tokenized.

Name on the credit or debit card. This may be required by the payment services provider (PSP).

PAN of the credit or debit card.

Expiry date of the credit or debit card.

Start date of the credit or debit card.

Indicates whether a card has been stored externally to our system, and if it has been used previously.

Used for the situation where you have previously used and stored the card outside our system. This will override the value sent to the card networks, (e.g. Visa/Mastercard) on the first time the card is used within our systems.

If your systems don't ever store card details this field should be ignored.

When sent to us this affects the first time the tokenized card is used within our systems. In the case of a card that you never want tokenized with us, but is tokenized externally, we will require the correct value on every call.

This is related to Credential on file mandate compliance.

Possible Values

• UNUSED - The card has not been previously used in a transaction, this is used as a hint to the networks that the card will be stored from this point onward.
• USED - The card has been previously used in a transaction on your systems, this lets the networks know that this is a previously stored card.

Usage Notes:

• Not sending a value for this implies that you have not stored the card for reuse within your systems.
• If your company never stores cards for reuse then there is no need to ever send a value for this field.
• This field is optional but MUST be filled when using a previously/externally stored card.

Whether to synchronously or asynchronously enroll and provision a network token and optionally include the cryptogram in the response when creating a card-on-file.

If unspecified and, if the retail channel is enabled for network tokenization, the async behaviour will be used by default.

This field accepts the following values:

• async
  • Asynchronously enrolls a card, a network token card number will be available once a cryptogram is provisioned.
• networkToken
  • Synchronously enrolls a card and provisions a network token when creating the card-on-file.
• networkTokenWithCryptogram
  • Synchronously enrolls a card and provisions a network token when creating the card-on-file, providing the resulting cryptogram in the same response.