Cardaq-side Payment Method Saving

Step 1: Create a new request to POST /clients/.

{
    "email": "client27@email.com"
}

This function will return the ID of the newly created customer which then can be used for assigning payment methods to.

Step 2: Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "original_client": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "email": client27@email.com"
    },
    "products": [
        {
        "title": "Test product",
        "price": 1.00,
        }
    ],
    "currency": "EUR",
    "setup_future_use": "recurring",
    "force_save_method": true
    "recurring_number": "1" // conditional field for recurring scenario, may be required for some acquiring connections
}

The ID of the original_client should be included in the request to assign the saved payment method to. The desired Payment Saving Method scenario should always be provided within the order body via the parameter setup_future_use. Possible values for the parameter setup_future_use are one-click, automatic, and recurring. If force_save_method is set to be true, then the payment method will be saved without the customer's consent. The recurring_number parameter should be provided only if setup_future_use parameter has value recurring.

Step 3:

1. Present to the customer one of the Gateway-hosted checkout options (Full Page or JS SDK), using the appropriate URL you received in the response to the previous step;
2. For the Host2Host integration, the execution is done as described here.

Step 4 (conditional): Perform 3DS authentication (link).

Merchant-side Payment Method Saving

Step 1: Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "client27@gmail.com",
        "send_to_email": false
    },
    "products": [
        {
        "title": "Test product",
        "price": 1.00,
        }
    ],
    "currency": "EUR",
    "setup_future_use": "recurring"
    "recurring_number": "1" // conditional field for recurring scenario, may be required for some acquiring connections
}

The desired Payment Saving Method scenario should always be provided within the order body via the parameter setup_future_use. Possible values for the parameter setup_future_use are one-click, automatic, and recurring. The recurring_number parameter should be provided only if setup_future_use parameter has value recurring.
The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Step 2: Minimal body request to POST payment api_do_url

{
    "cardholder_name": "Adam Smith",
    "card_number": "4242424242424242",
    "exp_month": 6,
    "exp_year": 23,
    "csc": "111",
    "saved_by_merchant": true,
    "ip_address": "198.51.100.42"
}

Step 3 (conditional): Perform 3DS authentication (link).

Create a new request to POST /orders/. Note that the price value must be ≥0.01.
NB: If you provide travel packages, we strongly recommend you to send the first service provided in the order (for example, if the travel package contains a flight and a hotel booking, then you must send Airline Addendum data in the order).

{
    "client": {
        "email": "test@test.com"
    },
    "travel_data": {
        "airline_addendum": { //if airline_addendum is sent, other travel types cannot be sent
            "ticket_number": "123",
            "passenger_name": "Adam Smith",
            "customer_ref": "123",
            "n_legs": 1,
            "carrier_name": "Test Airways",
            "ticket_issue_date": "121221",
            "legs": [
                {
                    "departure_airport": "RIX",
                    "carrier_code": "3d",
                    "destination_airport": "VIE",
                    "departure_date": "01012022",
                    "service_class": "Y",
                    "trip_number": "QR945",
                }
            ]
        },
        "lodging": { //if lodging is sent, other travel types cannot be sent
            "booking_number": "test",
            "checkin_date": "01012023",
            "checkout_date": "03012023"
        },
        "car_rental": { //if car_rental is sent, other travel types cannot be sent
            "booking_number": "test",
            "pickup_date": "01012023",
            "return_date": "03012023"
        },
        "cruise": { //if cruise is sent, other travel types cannot be sent
            "booking_number": "test",
            "departure_date": "01012023",
            "return_date": "03012023"
        },
        "ground_transportation": { //if ground_transportation sent, other travel types cannot be sent
            "booking_number": "test",
            "departure_date": "01012023",
            "return_date": "03012023"
        },
        "language": "en",
        "currency": "EUR",
        "products": [
            {
                "price": 0.01,
                "title": "Test Product"
            }
        ]
    }
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Create a new request to POST /orders/. Note that the price value must be ≥0.01. NB: We advise to send client information in each AFT order request.

{
    "client": {
        "email": "test@gmail.com",
        "first_name": "John", // mandatory field for VISA AFT payments
        "last_name": "Smith", // mandatory field for VISA AFT payments
        "address": "1 High St, Capitol Heights, MD 20700", // mandatory field for VISA AFT payments
        "country": "US", // mandatory field for VISA AFT payments
        "state": "DC", // conditional field for VISA AFT payments: mandatory only for Canada and USA issuers
        "city": "Washington" // mandatory field for VISA AFT payments
    },
    "recipient_client": { // this object and all its fields are mandatory for all AFT payments
        "first_name": "John",
        "last_name": "Doe",
        "birth_date": "1996-09-11",
        "city": "Riga",
        "account_type": "02",
        "account_number": "XXXXX",
        "recipient_address": "Dzirnavu 101-1, Riga, LV1010" // mandatory field for VISA AFT payments
        "country": "LV",
        "same_as_client": false // if value is True, then Gate indicates that the recipient client information is the same as the client information. Note that this parameter is informative and does not copy the client data
    },
    "products": [
        {
            "price": 0.01,
            "title": "test",
            "description": "test description",
            "quantity": 1
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com"
    },
    "dynamic_descriptor": "test",
    "products": [
        {
            "title": "Test product",
            "price": 1.00
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com"
    },
    "service_location": {
        "city": "London",
        "region": "ENG",
        "country": "GB",
        "zip_code": "W2 1HS"
    },
    "products": [
        {
            "price": 1.00,
            "title": "Title"
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Request examples for QCash payments are identical to One-step and Two-step payments. The only difference is in the terminal assigned but the order request bodies are the same.

Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com"
    },
    "is_moto": true,
    "products": [
        {
            "price": 0.01,
            "title": "Title"
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com"
    },
    "products": [
        {
            "price": 0.01,
            "title": "Title"
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Create a new request to POST /orders/. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com"
    },
    "sdwo_merchant_id": "XXXXX",
    "products": [
        {
            "price": 0.01,
            "title": "Title"
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Create a new request to POST /taxes/.

{
    "name": "example",
    "percent": 10
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

In order to perform AVS, you have to set up your payment authorization requests to include billing address details.
Create a new request to POST /orders/. It is mandatory to send address and zip_code parameters. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com",
        "address": "1 High St, Capitol Heights",
        "zip_code": "MD 20700"
    },
    "products": [
        {
        "price": 0.01,
        "quantity": 1,
        "title": "Test product"
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Response example and avs_status descriptions can be found here.

In order to perform Custom AVS, you have to set up your payment authorization requests to include billing address details and send the avs parameter as true in the payment api_do_url request.

Step 1: Create a new request to POST /orders/. It is mandatory to send address and zip_code parameters. Note that the price value must be ≥0.01.

{
    "client": {
        "email": "test@test.com",
        "address": "1 High St, Capitol Heights",
        "zip_code": "MD 20700"
    },
    "products": [
        {
        "price": 0.01,
        "quantity": 1,
        "title": "Test product"
        }
    ]
}

The request body above includes only the mandatory parameters for the request type. In case optional parameters are needed, see API Reference.

Step 2: Mandatory body request to POST payment api_do_url:

{
    "cardholder_name": "Adam Smith",
    "card_number": "4242424242424242",
    "exp_month": 6,
    "exp_year": 23,
    "csc": "111",
    "avs": true
}

Response example and avs_status descriptions can be found here.