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

Api

Last modified:2025-06-06 13:43:09

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

Required when creating a new payment transaction (IPAY QR-CODE)

amount

number <double>

required

Required: Total order value

>= 1

Example:

20.27

orderDetails

object (OrderDetails)

required

Optional: only required for statistics, fraud prevention, or creating shipping labels using IPAY integrated carriers

orderId

string | null

required

Required: Order number

>= 1 characters<= 256 characters

Example:

ShopX-001

firstName

string

required

>= 1 characters<= 256 characters

Example:

Reyhan

lastName

string

required

>= 1 characters<= 256 characters

Example:

Savvy

string | null

optional

>= 0 characters<= 256 characters

Example:

rey@dooo.com

phoneNumber

string | null

optional

>= 0 characters<= 50 characters

Example:

+316777298172

company

string | null

optional

>= 0 characters<= 256 characters

Example:

null

vatNumber

string | null

optional

>= 0 characters<= 256 characters

Example:

null

address1

string

required

>= 2 characters<= 256 characters

Example:

Max Euweplein

address2

string | null

optional

>= 0 characters<= 256 characters

Example:

null

houseNumber

string

required

>= 1 characters<= 25 characters

Example:

zipcode

string

required

>= 2 characters<= 10 characters

Example:

1017 MB

city

string

required

>= 2 characters<= 265 characters

Example:

Amsterdam

country

string

required

ISO2 / ALPHA2 Country Code

>= 2 characters<= 256 characters

Example:

reference

string | null

optional

If needed you can supply your own reference to this order

>= 0 characters<= 256 characters

Example:

MyRefInMyWMS99282

state

string | null

optional

>= 0 characters<= 265 characters

Example:

null

province

string | null

optional

>= 0 characters<= 265 characters

Example:

null

region

string | null

optional

>= 0 characters<= 265 characters

Example:

null

shopOrderId

string | null

optional

This is the internal order id from the merchant site where this order comes from (required if you use WMS integration with IPAY)

>= 0 characters<= 265 characters

Example:

2128721

orderlines

array[object (OrderLine) {10}] | null

required

Required information about the order

preferredShippingMethod

string | null

optional

Specify which shipping method you prefer (used when using WMS integration like HaydiGO where it will be put in order shipping field)

>= 0 characters<= 265 characters

Example:

DHL

customerLocale

string | null

optional

Optionally specify which locale the order customer uses or prefers. Otherwise country language will be used for instance for e-mail communications

>= 5 characters<= 5 characters

Example:

nl_NL

carrierId

integer <int32> | null

optional

Optional: The carrier you used for this order

>= 1<= 4

Example:

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"
            }
        ],
        "preferredShippingMethod": "DHL",
        "customerLocale": "nl_NL"
    },
    "carrierId": 1
}

Request 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"
            }
        ],
        "preferredShippingMethod": "DHL",
        "customerLocale": "nl_NL"
    },
    "carrierId": 1
}'

Responses

🟢200OK

text/plain

Body

traceId

string <uuid>

read-onlyoptional

succeeded

boolean

read-onlyoptional

Flag indicating whether if the operation succeeded or not.

errors

array[object (ServiceError) {2}] | null

read-onlyoptional

An System.Collections.Generic.IEnumerable`1 of iPAY.Model.Common.ServiceErrors containing an errors
that occurred during the identity operation.

code

string | null

optional

description

string | null

optional

warnings

array[object (ServiceError) {2}] | null

read-onlyoptional

code

string | null

optional

description

string | null

optional

Example

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

Modified at 2025-06-06 13:43:09

CreateTransaction

GetTransaction