Initiate a refund job for a specific purchase

POST

/api/refund/v5/{id}

Initiate a refund job for a specific purchase. Refunds can only be issued to the original payment tag. This request will display "Tap to refund" 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

Refund job successfully created

Body

🟠400Bad Request

🟠401Unauthorized

🟠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/refund/v5/12345678-abcd-4bcf-9bcd-123456789012' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "123e4567-e89b-12d3-a456-426614174000",
    "allowUserCancel": true
}'

Response Example

200 - Example 1

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

Modified at 2025-04-02 13:29:04

Start a job for a purchase

Start a job to swap a ticket to a NFC-tag