Tokenization

Creation of token for a card

If you want to use the token to process the payment, you need to pass the following parameters.

{
    "transactionType": "SALE",
    "transactionAmount": {
        "total": 25,
        "currency": "EUR"
    },
    "storeId": "12345678",
    "checkoutSettings": {
        "redirectBackUrls": {
            "successUrl": "https://www.success.com/",
            "failureUrl": "https://www.failureexample.com"
        }
    },
    "paymentMethodDetails": {
        "cards": {
            "createToken": {
                "customTokenValue": "Test1234567",
                "declineDuplicates": true,
                "reusable": false,
                "toBeUsedFor": "UNSCHEDULED"
            }
        }
    }
}

For more information on the request body parameters, kindly refer the createToken object here.

If you don't pass the value for the customTokenValue parameter, a token value gets created and returned by the Gateway. You will receive the token ID with the help of webhooks along with the other transaction information. You have to save the token if you want to reuse the token for future transactions.

Save cards details on payment page for the paying customer

In case "Save card details" option has been enabled on the Checkout Builder for respective Checkout page, then the cardholder can choose to tokenize the card details and agree to send token to you for reusing the same for future payments without entering the details again.

This option is not enabled for the Default payment page.

Use a token for a payment transaction

If you have a previously generated token that can be used for further transactions, you can pass that when creating the checkout via our API. Here's a sample request of how it can be done:

{
    "transactionType": "SALE",
    "transactionAmount": {
        "total": 25,
        "currency": "EUR"
    },
    "storeId": "12345678",
    "checkoutSettings": {
        "redirectBackUrls": {
            "successUrl": "https://www.success.com/",
            "failureUrl": "https://www.failureexample.com"
        }
    },
    "paymentMethodDetails": {
        "cards": {
            "tokenBasedTransaction": {
                "value": "Test1234567",
                "transactionSequence": "SUBSEQUENT"
            }
        }
    }
}

Since its a token that represents a card and no further input is required from the cardholder, the returned "redirectionUrl", when clicked or redirected upon will just process the transaction and will skip displaying the Checkout page completely.