Direct API integration

Make your first payment using our API

Pre-requirements:

Before following the steps to create your first payment, make sure that:

Your have an access to your (Sandbox) Merchant Account
You have generated your API keys
You have at least one merchant contract activated with at least one payment method added

Step 1: Create Checkout Request

Set at least the following in the request body: amount, currency, operation_type, order_merchant_id, payment_channel: ecommerce, type: api

{
  "amount": 1,
  "currency": "EUR",
  "operation_type": "authorize",
  "order_merchant_id": "123456",
  "payment_channel": "e-commerce",
  "type": "api"
}

{
    "result": {
        "code": "011111",
        "description": "checkout created successfully"
    },
    "checkout": {
        "amount": 1,
        "currency": "EUR",
        "customer_browser_info_time_zone": "",
        "expiration_date": "2025-08-04T11:28:50.629Z",
        "hosted_page_configuration": {
            "hosted_fields": {}
        },
        "operation_type": "authorize",
        "order_merchant_id": "123456",
        "token_type": "oneshot",
        "type": "api",
        "payment_channel": "e-commerce",
        "payment_method_name": [],
        "status": "created",
        "merchant_data": [],
        "checkout_id": "689095ee9daea8ddae8cf291"
    },
    "payment_methods": {
        "payment_methods_available": [
            {
                "component_type": "card",
                "display_name": "Visa",
                "form_fields": [
                    {
                        "name": "card_number",
                        "label": "card_number",
                        "display_name": "card_number",
                        "data_type": "integer",
                        "enum": [],
                        "example": "4111 xxxx xxxx xxxx"
                    },
                    {
                        "name": "cvc",
                        "label": "cvc",
                        "display_name": "cvc",
                        "data_type": "integer",
                        "enum": [],
                        "example": "123"
                    },
                    {
                        "name": "card_validity",
                        "label": "card_validity",
                        "display_name": "card_validity",
                        "data_type": "date",
                        "enum": [],
                        "example": "MM/YY"
                    },
                    {
                        "name": "cardholder_name",
                        "label": "cardholder_name",
                        "display_name": "cardholder_name",
                        "data_type": "name",
                        "enum": [],
                        "example": "Mickael Smith"
                    }
                ],
                "logo": "visa.svg",
                "logo_png": "visa.png",
                "logo_colorbg": "Visa_colorbg.svg",
                "logo_colorbg_png": "[email protected]",
                "logo_favicon_colorbg": "Visa_favicon_colorbg.svg",
                "logo_favicon_colorbg_png": "[email protected]",
                "logo_favicon_whitebg": "Visa_favicon_whitebg.svg",
                "logo_favicon_whitebg_png": "[email protected]",
                "logo_white": "Visa_white.svg",
                "logo_white_png": "[email protected]",
                "logo_whitebg": "Visa_whitebg.svg",
                "logo_whitebg_png": "[email protected]",
                "name": "visa",
                "partner": "partnername",
                "merchant_contract": "688a17ed2d0d625ebfbdf781",
                "required_fields": [
                    "payment_method_name",
                    "token",
                    "amount",
                    "currency"
                ],
                "countries": [
                    "all"
                ]
            }
        ]
    }
}

Step 2: Create Token

Securely send card information to our PCI DSS compliant environment: card_number, card_validity_year, cvc, customer_scheme_name, token_type. Get a token in the response (unique identifier of the card data).

{
  "card_number": "4242424242424242",
  "card_validity_month": "12",
  "card_validity_year": "2028",
  "cvc": "123",
  "customer_scheme_name": "visa",
  "token_type": "oneshot"
}

{
  "result": {
    "code": "999999",
    "description": "Tokenization successful"
  },
  "created_date": "2025-07-04T13:52:10.851Z",
  "token": "788ecfa5dd8e12eabdcc364a3cbb265e2616bd7753d450232f64278652ea57ac",
  "token_type": "oneshot",
  "token_kind": "card",
  "customer_scheme_name": "visa",
  "bin_scheme_name": "visa",
  "bin_secondary_scheme_name": "cb",
  "card_6_digits": "424242",
  "card_4_digits": "4242",
  "card_validity_month": "12",
  "card_validity_year": "28",
  "card_unique_id": "d71687a0-a793-418b-b384-87e32041f404"
}

Step 3: Create Order

After the token has been created, use it to create an order.

{
  "operation_type": "authorize",
  "amount": "1",
  "currency": "EUR",
  "order_merchant_id": "276398531664",
  "payment_channel": "e-commerce",
  "accept_url": "https://accepttest.com",
  "decline_url": "https://declinetest.com",
  "token": "788ecfa5dd8e12eabdcc364a3cbb265e2616bd7753d450232f64278652ea57ac",
  "checkout_id": "689095ee9daea8ddae8cf291"
}

{
    "result": {
        "code": "944444",
        "description": "authorization successful"
    },
    "order_id": "68909bed9daea8ddae8d0be3",
    "transaction_id": "68909bed9daea8ddae8d0be4",
    "checkout_id": "689095ee9daea8ddae8cf291",
    "status": "authorization_successful",
    "payment_method_name": "visa",
    "order_amount": 1,
    "order_currency": "EUR",
    "order_merchant_id": "276398531664",
    "payment_channel": "e-commerce",
    "website_url": "",
    "customer_id": "VDS",
    "customer_email": "[email protected]",
    "customer_first_name": "Vincent",
    "customer_last_name": "Dos Santos",
    "customer_street_name": "22 RTE du point dde vue",
    "customer_city": "Villeneuve en retz",
    "customer_zip_code": "",
    "customer_country": "NL",
    "customer_ip": "127.0.0.1",
    "order_description": "3 credits",
    "is_suspicious": false,
    "risk_assessment_partner": "",
    "risk_assessment_date": "",
    "risk_assessment_result": "",
    "risk_assessment_reason": "",
    "risk_assessment_reason_code": "",
    "is_authenticated": false,
    "authentication_indicator": "ask_3ds",
    "authentication_partner": "",
    "authentication_date": "",
    "authentication_result": "",
    "authorization_date": "2025-08-04T11:39:25.761Z",
    "authorization_result": "",
    "authorization_code": "",
    "authorization_amount": 1,
    "is_captured": false,
    "capture_date": "",
    "capture_result": "",
    "capture_total_amount": "",
    "payin_partner": "",
    "merchant_contract_id": "",
    "psp_result_code": "",
    "psp_result_description": "",
    "accept_url": "https://accepttest.com",
    "decline_url": "https://declinetest.com"
}

Full API reference

The above guide serves as a kickstart example to test your first payment with direct API integration. To have a full scope and test different use cases, please visit our API Reference.