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.

SetOrderShipped

POST

/Api/SetOrderShipped

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

You can optional use this call to notify IPAY when an orders is fulfilled in a warehouse and the package is on its way to the consumer.
When IPAY has an integration with your shop platform, it will also set a note or a tag in the order in de shop (for instance in shopify we will set: Pending IPAY Payment)

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
    "transactionId": "string",
    "trackAndTraceNumber": "string",
    "trackAndTraceUrl": "string"
}

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/SetOrderShipped' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transactionId": "string",
    "trackAndTraceNumber": "string",
    "trackAndTraceUrl": "string"
}'

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

GetTransactionStatus

GetCarriers