After you have successfully created tokens, you can use them in your subsequent payment requests to offer returning customers a faster checkout experience. You can also use tokens to charge your shoppers for subscription, or automatic top-up payments.
Requirements
Before you begin, take into account the following requirements, limitations, and preparations.
| Requirement | Description |
|---|---|
| Integration type | An online payments integration. |
| API credential roles | Make sure that you have the following roles:
|
| Webhooks | Subscribe to the Recurring tokens life cycle events webhook. |
| Limitations | With the /sessions endpoint, you can create tokens for all recurring payment types, but making subsequent subscription or unscheduled card-on-file payments require using the /payments endpoint. |
| Setup steps | Before you begin:
|
How it works
You can use a previously created token for making different types of payments.
- One-click (
CardOnFile): A shopper-initiated payment where a returning shopper uses their stored payment details for a faster checkout. - Subscription (
Subscription): A payment where you initiate a subscription payment to bill the shopper at regular intervals. - Unscheduled Card-on-File (
UnscheduledCardOnFile): An automatic top-up payment or other contracts where you initiate payments at non-fixed intervals.
Shopper-initiated payments
- When the shopper proceeds to pay on your website or app, present their stored payment details as a payment option.
- If your shopper selects the option to pay with their stored details, make a /sessions, or /payments request including the token and the shopper reference.
- Get the outcome of the payment in an AUTHORISATION webhook.
Payments initiated by you
- When it is time to bill your shopper for their subscription, or other non-scheduled contract, make a /payments request including the token and the shopper reference.
- Get the outcome of the payment in the /payments response, or an AUTHORISATION webhook.
Make a one-click payment
Select the endpoint you are using:
Make a subscription or unscheduled card-on-file payment
To initiate a payment with stored payment details, for example when billing for a subscription, or making an automatic top-up payment:
-
From your server, make a POST /payments request including:
Parameter Required Description paymentMethod.storedPaymentMethodId
Checkout API v49 or later
The token for the shopper's stored payment details. This is the storedPaymentMethodIdfrom the recurring.token.created webhook you received when you created the token.shopperReference 
Your unique identifier for the shopper. Must be the same one you included with the request to create the token.
Format:- Minimum length: 3 characters.
- Case-sensitive.
shopperInteraction 
ContAuth recurringProcessingModel 
Subscription or UnscheduledCardOnFile paymentMethod.brandOnly for co-badged cards Only required for co-badged cards; optional for single branded cards. The secondary brand of the card. The following example shows how to make a subscription payment with stored payment details.
The response includes the following.
Parameter Description additionalData.tokenization.storedPaymentMethodIdThe token for the shopper's stored payment details. This is the storedPaymentMethodIdfrom the recurring.token.created webhook you received when the token was created.recurringProcessingModelThe type of recurring transaction. resultCodeThe status of the transactions. For a successful payment: Authorised. -
Get the outcome of the payment in an AUTHORISATION webhook.
Test and go live
Follow our testing guide for tokenization and make sure that you can successfully make payments with a token.
When you are ready to go live:
- Enable the Recurring tokens life cycle events webhooks in your live Customer Area.
- Follow the Tokenization end-to-end testing checklist.