CreateTransaction - API Documentation

Create a new payment transaction and QR-Code (OrderDetails and Orderlines are optional but is highly recommended to specify for WMS integrations, 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

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

amount

number <double>

required

Required: Amount to be paid on delivery

>= 1

Example:

20.27

orderId

string | null

required

Required: Order number

>= 1 characters<= 256 characters

Example:

ShopX-001

shopOrderId

string | null

optional

Optional: Order internal number (platforms like shopify etc..)

Example:

332837882

orderDetails

object (OrderDetails)

optional

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

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

parcel

object (Parcel)

optional

Required if you want to use IPAY internal Carrier integrations (label printing).

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

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

orderCountry

string

required

ISO2 / ALPHA2 Country Code

>= 2 characters<= 256 characters

Example:

consumerEmail

string | null

optional

Email address of consumer ordered the order

>= 0 characters<= 256 characters

Example:

rey@dooo.com

locale

string | null

optional

The language the payment screen will be for the consumer

>= 0 characters<= 256 characters

Example:

en_US

carrierId

integer <int32>

required

The carrier you will be using for this order / transaction

>= 1<= 3

Example:

testMode

boolean

optional

If you want to create a test transaction to test payments.

Example:

true

orderlines

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

optional

Required if you create shipment labels using IPAY (for instance for customs info)

name

string

required

The name or description of the product

>= 1 characters

Example:

43" FHD Smart TV

productId

integer <int32>

optional

You can pass on the marketplace internal Product Id (required if you use for instance shopify or our WMS integrations)

Example:

13882

sku

string

required

SKU or EAN of product

>= 1 characters

Example:

FN43GE320

quantity

number <double>

required

How many of this product

Example:

weight

number <double>

required

How much does this product weight ; default is 1 kg

Example:

tax

number <double>

optional

Tax value of this product (for example 21% of the price per item)

Example:

pricePerItem

number <double>

required

Price per item including taxes

Example:

totalPrice

number <double>

required

Total value of this order line

Example:

countryOfOrigin

string | null

optional

Country Of Origin (required for shipping goods to other countries or IPAY WMS integration)

>= 0 characters<= 265 characters

Example:

hsCode

string | null

optional

Harmonized System (HS) Codes. Only used throughout the import and export process for the classification of goods. (required for shipping goods to other countries or IPAY WMS integration)

>= 0 characters<= 265 characters

Example:

Example

{
  "amount": 20.27,
  "orderId": "ShopX-001",
  "shopOrderId": "332837882",
  "orderDetails": {
    "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,
    "parcel": {
      "shopName": "string",
      "shopOrderNumber": "string",
      "shopOrderId": "string",
      "eori": "string",
      "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"
      }
    },
    "shopOrderId": "2128721",
    "preferredShippingMethod": "DHL",
    "customerLocale": "nl_NL"
  },
  "orderCountry": "NL",
  "consumerEmail": "rey@dooo.com",
  "locale": "en_US",
  "carrierId": 1,
  "testMode": true,
  "orderlines": [
    {
      "name": "43\" FHD Smart TV",
      "productId": 13882,
      "sku": "FN43GE320",
      "quantity": 1,
      "weight": 1,
      "tax": 1,
      "pricePerItem": 10,
      "totalPrice": 10,
      "countryOfOrigin": "NL",
      "hsCode": "NL"
    }
  ]
}

Request 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 '{
    "amount": 20.27,
    "orderId": "ShopX-001",
    "shopOrderId": "332837882",
    "orderDetails": {
        "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,
        "parcel": {
            "shopName": "string",
            "shopOrderNumber": "string",
            "shopOrderId": "string",
            "eori": "string",
            "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"
            }
        },
        "shopOrderId": "2128721",
        "preferredShippingMethod": "DHL",
        "customerLocale": "nl_NL"
    },
    "orderCountry": "NL",
    "consumerEmail": "rey@dooo.com",
    "locale": "en_US",
    "carrierId": 1,
    "testMode": true,
    "orderlines": [
        {
            "name": "43\" FHD Smart TV",
            "productId": 13882,
            "sku": "FN43GE320",
            "quantity": 1,
            "weight": 1,
            "tax": 1,
            "pricePerItem": 10,
            "totalPrice": 10,
            "countryOfOrigin": "NL",
            "hsCode": "NL"
        }
    ]
}'

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"
    }
  ]
}