Outlines using the terminal API to create a recurring contract by linking payment details to a shopper.
Before you begin
- Contact the POS Support Team to configure your account for recurring.
Step 1: Tokenize details
To recognize a shopper later, you must first save their tokenized details by sending additional parameters in
SaleToAcquirerData in the initial transaction.
In the example below, a
PaymentRequest is used to create the card alias (an alias for the credit card number). This can also be done using a CardAcquisition request. For more information, see Acquire card details.
These additional parameters are:
The type of recurring contract to be used.
Used only in combination with
The email of the shopper.
A unique reference to the shopper as generated by the merchant. Only in combination with
For more information on how additional data works, see Pass additional data.
Depending on the TokenRequestedType you pass, either a
cardAlias are returned:
- If you pass
TokenRequestedTypeset to Transaction it return the
- If you send in
TokenRequestedTypeset to Customer it will return the
For a list of
PaymentResponse fields, see PaymentResponse fields.
An authorization is attempted and you receive a response with the following fields, including an
If you receive an error, use our Error Scenarios page to troubleshoot the issue.
Warnings are triggered when non-fatal errors occur and are returned in the response.
Step 2: Recognize the shopper