CreateTransaction - API Documentation

Create a new payment transaction and QR-Code (OrderDetails are mandatory and required for Statistics, Carrier region filters and Fraud prevention). This method is protected by rate limiting. Rate limit is set to 1000 request per minute.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
    "transactionType": "QrCodePayment",
    "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"
    },
    "parcel": {
        "shopName": "string",
        "shopOrderNumber": "string",
        "shopOrderId": "string",
        "eori": "string",
        "senderAddress": {
            "name": "Test Shop",
            "address": "Max Euweplein",
            "zipcode": "1017 MB",
            "city": "Amsterdam",
            "country": "NL",
            "phoneNumber": "+31644410190"
        },
        "destinationAddress": {
            "contactFirstName": "Reyhan",
            "contactLastName": "Savvy",
            "contactCompany": null,
            "vatNumber": null,
            "contactEmail": "rey@dooo.com",
            "contactPhone": "+316777298172",
            "address1": "Max Euweplein",
            "address2": null,
            "houseNumber": "6",
            "zipcode": "1017 MB",
            "city": "Amsterdam",
            "state": null,
            "country": "NL"
        },
        "billingAddress": {
            "contactFirstName": "Reyhan",
            "contactLastName": "Savvy",
            "contactCompany": null,
            "vatNumber": null,
            "contactEmail": "rey@dooo.com",
            "contactPhone": "+316777298172",
            "address1": "Max Euweplein",
            "address2": null,
            "houseNumber": "6",
            "zipcode": "1017 MB",
            "city": "Amsterdam",
            "state": null,
            "country": "NL"
        },
        "weight": 2,
        "dimensions": {
            "length": 10,
            "width": 10,
            "height": 10
        },
        "serviceCode": "string",
        "returnLabel": true,
        "carrierLabelType": "Zpl"
    },
    "locale": "en_US",
    "carrierId": 1,
    "testMode": true
}

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/CreateTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transactionType": "QrCodePayment",
    "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"
    },
    "parcel": {
        "shopName": "string",
        "shopOrderNumber": "string",
        "shopOrderId": "string",
        "eori": "string",
        "senderAddress": {
            "name": "Test Shop",
            "address": "Max Euweplein",
            "zipcode": "1017 MB",
            "city": "Amsterdam",
            "country": "NL",
            "phoneNumber": "+31644410190"
        },
        "destinationAddress": {
            "contactFirstName": "Reyhan",
            "contactLastName": "Savvy",
            "contactCompany": null,
            "vatNumber": null,
            "contactEmail": "rey@dooo.com",
            "contactPhone": "+316777298172",
            "address1": "Max Euweplein",
            "address2": null,
            "houseNumber": "6",
            "zipcode": "1017 MB",
            "city": "Amsterdam",
            "state": null,
            "country": "NL"
        },
        "billingAddress": {
            "contactFirstName": "Reyhan",
            "contactLastName": "Savvy",
            "contactCompany": null,
            "vatNumber": null,
            "contactEmail": "rey@dooo.com",
            "contactPhone": "+316777298172",
            "address1": "Max Euweplein",
            "address2": null,
            "houseNumber": "6",
            "zipcode": "1017 MB",
            "city": "Amsterdam",
            "state": null,
            "country": "NL"
        },
        "weight": 2,
        "dimensions": {
            "length": 10,
            "width": 10,
            "height": 10
        },
        "serviceCode": "string",
        "returnLabel": true,
        "carrierLabelType": "Zpl"
    },
    "locale": "en_US",
    "carrierId": 1,
    "testMode": true
}'

Responses

🟢200OK

application/json

Body

Example

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