Overview
In REST 2.0, the /payments endpoint supports tokenization through the paymentOption.store parameter which determines how card details are stored and linked for future transactions.
Tokenization Options
This section describes tokenization options for paymentOption.store.
none
- Description – No tokenization occurs.
- Use Case – One-time transaction only.
- Behavior – Card details are used for the payment and then discarded.
tokenOnly
- Description – The card is tokenized but not linked to a specific buyer.
- Use Case – Storing the card for future use without associating it with a buyer.
- Behavior – Token is created and stored independently.
buyerToken (default)
- Description – The card is tokenized and linked to a buyer.
- Use Case – For recurring payments or buyer-specific stored cards.
- Behavior – Requires
buyerDetails.buyerIdin the request.
Default Behavior
- If
paymentOption.storeis omitted, the default value isbuyerToken. - For
buyerTokenthe merchant must includebuyerDetails.buyerId.
Example Request
{
.......
"amount": 100,
"currency": "USD",
"paymentOption": {
"card": {
"cardNumber": "4111111111111111",
"expirationMonth": "12",
"expirationYear": "2028",
"CVV": "123"
},
"store": "buyerToken"
},
"buyerDetails": {
"buyerId": "buyer_12345"
} ..................
}