Before you can use our API you need be a customer at IPAY Solutions Europe B.V. Please contact our sales department to access our services.

AddOrderData (for statistics and insights)

POST

/Api/AddOrderData

Last modified:2025-08-09 09:41:27

Creates an order record in IPAY without any transaction / payment options. This is to feed IPAY database with non IPAY orders so we can provide you with proper statistics/insights about your business

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "amount": 20.27,
    "orderDetails": {
        "orderId": "ShopX-001",
        "firstName": "Reyhan",
        "lastName": "Savvy",
        "email": "rey@dooo.com",
        "phoneNumber": "+316777298172",
        "company": null,
        "vatNumber": null,
        "address1": "Max Euweplein",
        "address2": null,
        "houseNumber": "6",
        "zipcode": "1017 MB",
        "city": "Amsterdam",
        "country": "NL",
        "reference": "MyRefInMyWMS99282",
        "state": null,
        "province": null,
        "region": null,
        "shopOrderId": "2128721",
        "orderlines": [
            {
                "name": "43\" FHD Smart TV",
                "productId": 13882,
                "sku": "FN43GE320",
                "quantity": 1,
                "weight": 1,
                "tax": 1,
                "pricePerItem": 10,
                "totalPrice": 10,
                "countryOfOrigin": "NL",
                "hsCode": "NL"
            }
        ],
        "customerLocale": "nl_NL",
        "trackAndTraceUrl": "string",
        "trackingNumber": "H1023310826074101040"
    },
    "carrierId": 1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ipay-solutions.com/Api/AddOrderData' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 20.27,
    "orderDetails": {
        "orderId": "ShopX-001",
        "firstName": "Reyhan",
        "lastName": "Savvy",
        "email": "rey@dooo.com",
        "phoneNumber": "+316777298172",
        "company": null,
        "vatNumber": null,
        "address1": "Max Euweplein",
        "address2": null,
        "houseNumber": "6",
        "zipcode": "1017 MB",
        "city": "Amsterdam",
        "country": "NL",
        "reference": "MyRefInMyWMS99282",
        "state": null,
        "province": null,
        "region": null,
        "shopOrderId": "2128721",
        "orderlines": [
            {
                "name": "43\" FHD Smart TV",
                "productId": 13882,
                "sku": "FN43GE320",
                "quantity": 1,
                "weight": 1,
                "tax": 1,
                "pricePerItem": 10,
                "totalPrice": 10,
                "countryOfOrigin": "NL",
                "hsCode": "NL"
            }
        ],
        "customerLocale": "nl_NL",
        "trackAndTraceUrl": "string",
        "trackingNumber": "H1023310826074101040"
    },
    "carrierId": 1
}'

Responses

🟢200OK

application/json

Body

Example

{
    "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
    "succeeded": true,
    "errors": [
        {
            "code": "string",
            "description": "string"
        }
    ],
    "warnings": [
        {
            "code": "string",
            "description": "string"
        }
    ]
}

Modified at 2025-08-09 09:41:27

CreateTransaction

GetTransaction