Travel API flow

If you are a Travel merchant, to correctly set up the custom integration on your website, you need to implement the following 3 API calls.

Create order

This POST call is mandatory to create the order.

In this call, all the necessary order information is sent from the merchant’s website to our server. Upon a successful call, an order is created in the Scalapay database, and Scalapay responds with a checkout URL to which the customer should be redirected.

As a travel merchant, it is mandatory to complete the following fields in the create order call:

The totalAmount field
The consumer field
The billing field, if available
The merchant field (redirectCancelUrl and redirectConfirmUrl)
We kindly ask you to include the extensions field in the create order call. The travel date must be valid and therefore later than the order creation date.

  "extensions": {
    "industry":{
      "travel":{
        "startDate": "2026-10-15”,
        "endDate": "2026-10-30”
      }
        }
    }

Please find below a full example of the create order API call for a Travel merchant.

{  
    "totalAmount": {  
        "amount": "1500.00",
        "currency": "EUR"
    },
    "consumer": {  
        "phoneNumber": "+393001234567",
        "givenNames": "Mario",
        "surname": "Rossi",
        "email": "[email protected]"
    },
    "billing": {  
        "name": "Mario Rossi",
        "line1": "Via Puglia, 58",
        "suburb": "Castelfranco Veneto",
        "postcode": "31033",
        "countryCode": "IT",
        "phoneNumber": "+393001234567"
    },
    "discounts": [
        {
            "displayName": "10% Off",
            "amount": {
                "amount": "150.00",
                "currency": "EUR"
            }
        }
    ],
    "merchant": {
        "redirectConfirmUrl": "https://portal.integration.scalapay.com/success-url",
        "redirectCancelUrl": "https://portal.integration.scalapay.com/failure-url"
    },
    "merchantReference": "merchantOrder-1234",
    "taxAmount": {  
        "amount": "3.70",
        "currency": "EUR"
    },
    "shippingAmount": {  
        "amount": "10.00",
        "currency": "EUR"
    },
    "orderExpiryMilliseconds": 2400000,
    "channel": "travel",
    "type": "online",
    "product": "pay-in-3",
    "frequency": {
        "number": 1,
        "frequencyType": "monthly"
    },
    "extensions": {
        "industry": {
            "travel": {
                "startDate": "2025-12-15",
                "endDate": "2025-12-30"
            }
        }
    }
}

Get order details

This GET call checks the status of order.

It is not mandatory, but highly recommended in order to check the status of the order before sending the capture call. Please note that only authorised orders can be captured.

Capture order

This POST call is the final one and mandatory to correctly finalise the order.

Once the capture call is made, the first instalment is deducted from the user’s card, and the order status is updated to "charged".

Scalapay will respond with either a success or a failure.

📘
API Simulator
In this section, you can find the API Simulator, which allows you to test the API calls and see how Scalapay will respond to each one.