Card payments

Overview

OnlinePay Checkout API supports accepting card payments securely via our payment partner, Verifone. You can configure Checkout to accept card payments and alternative payment methods, such as Apple Pay and Google Pay through the same page. Supported card payment methods include Visa, Mastercard, American Express, and JCB.

Card payment configuration

Card payment processing is handled on the configurations.card object in the Checkout API request. The card object mode field is used to specify the payment mode, which can be one of the following values:

• 3DS_PAYMENT - used for a payment that includes 3D Secure verification. This requires that 3D Secure is enabled and you must also provide a 3DS contract ID. This is the default value if the mode field is not specified.
• 3DS - used for a PCI secure 3D Secure-encrypted card capture. No transaction occurs, however the merchant receives an encrypted card, which they can then use against the eCommerce API.
• PAYMENT - used for a card payment with 3D Secure disabled.

To configure the Checkout to accept card payments, you must provide the payment contract ID in the configurations.card object. The payment contract ID is obtained from the OnlinePay dashboard. See Getting started with the OnlinePay API for more information.

{
...
    "configurations": {
        "card": {
            "payment_contract_id": "{{paymentContract}}"
        }
    }
}

3D Secure card payments

The Checkout API can be configured to accept 3D Secure card payments. To configure a 3D Secure payment, 3D Secure must be enabled on the Checkout and you must provide the 3DS contract ID in the configurations.card object. The 3DS contract ID is obtained from the OnlinePay dashboard. See Getting started with the OnlinePay API for more information.

The following example shows how to configure a 3D Secure card payment for transaction processing using the Checkout API:

{
    ...
    "configurations": {
        "card": {
            "threed_secure": {
                "threeds_contract_id": "{{3dsContract}}",
                "enabled": true
            },
            "payment_contract_id": "{{paymentContract}}"
        }
    }
}