Overview

Tokenisation allows you to store card payment data for recurring and one-click payments.

📘

• Tokenisation is only available for card payments.
• You must get permission from your customers before tokenising their cards.

To tokenise cards during the checkout process, set createRegistration=true (see the public Postman collection for an example call). In the checkout response, you receive a card token or registrationId (resembling 8ac7a49f8e9f15d2018ea09b285f0ebz) that you can use for recurring or one-click payments. You can also execute the Query Checkout status call to get the card token and useful card information that you can store for future recurring or one-click payment requests.

📘

You can force customers to pay with card by setting defaultPaymentMethod=CARD and forceDefaultMethod=true.

Recurring payments

After you have tokenised cards, you can use the recurring API for recurring or subscription payments.

One-click payments

To generate card tokens, configure one of the following:

• createRegistration=true.
• allowStoringDetails=true: Enables the customer to store their card for future use. See the public Postman collection for an example call.

allowStoringDetails=true works in the same way that createRegistration=true does, with the card token returned in the response. However, since it's optional for the customer, the registration ID is not always present and you must account for this.

After you have tokenised cards, provide the card tokens using the cardTokens parameter. This enables customers to pay using a stored card. See the public Postman collection for an example call.
For one-click payments, in addition to createRegistration=true, you must set allowStoredCards=true. With these parameters set, customers paying by card can store their cards for future use.

After you have tokenised cards, you can pass one or more tokens in the cardTokens parameter. Customers then have the option of paying with one of their stored cards.

❗

Ensure that you pass the correct tokens for the specified customer.