Tokenisation

Token creation

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, check thecreateToken object here.

If you do not pass the value for the customTokenValue parameter, a token value is created and returned by the Gateway (IPG). 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 it for future transactions.

Save cards details during checkout

In case "Save card details" option has been enabled on the Checkout Builder for respective Checkout page, then the cardholder can choose to tokenise 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 Checkout page.

Use the token for a payment transaction

If you have a previously generated a token, you can use it when creating the checkout via our API.
Below is an example of a request using a token:

{
    "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 a token represents a credit card, no further input is required from the cardholder. Returned "redirectionUrl", when clicked or redirected upon will process the transaction and skips displaying the Checkout page completely.