Start a job for a purchase

POST

/api/purchase/v5/{id}

Start a job for a purchase. The job will be processed asynchronously. The response will contain URLs that can be used to retrieve the job status and cancel the job. This request will display "Tap to Pay" along with the amount on the display of the xGate.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Job successfully created

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠405405

🟠409409

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://192-168-1-1.xip.get.systems:9443/api/purchase/v5/12345678-abcd-4bcf-9bcd-123456789012' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paymentType": "cashless",
    "cartItems": [
        {
            "count": 1,
            "productKey": "mySuperDuperProductKey",
            "variantKey": "mySuperDuperVariantKey",
            "name": "My Super Duper Product",
            "priceInCredits": 1.23,
            "accountingCategoryKey": "common.service",
            "taxRate": 0.19,
            "ean": "1234567890123",
            "reference": {
                "link": "string",
                "text": "string",
                "reference": "string"
            }
        }
    ],
    "requiredChip": "string",
    "reference": {
        "link": "string",
        "text": "string",
        "reference": "string"
    },
    "allowUserCancel": true
}'

Response Example

200 - Example 1

{
    "data": {
        "statusUrl": "string",
        "cancellationUrl": "string"
    }
}

Modified at 2025-04-02 13:28:50

Get the status of an asynchronous NFC tag interaction (NFC related)

Initiate a refund job for a specific purchase