Skip to main content
Version: 1.01

Confirm Order

PATCH /api/1.01/order/confirm/{trx}

Confirm an order after creation using the trx returned by the Create order endpoint. This endpoint will attempt to return an order with the status finished. If the order cannot be finished within 20-30 seconds, the endpoint will return an order with the status pending.

To find out when the order is finished, you can either call the Find order endpoint at a later time or make use of our Webhook feature.

If you wish for the order to either be delivered instantly or not at all, it is suggested to use the Resolve order endpoint

info
  • This endpoint should be used when orders are allowed to be delivered at a later time.
  • In sandbox mode this endpoint has a 50% chance to be cancelled immediately for testing purposes.

Requested Parameters​

FieldTypeRequiredDefaultDescription
trxStringYes-Trx of order

Example Request​

curl -X PATCH https://connect.relograde.com/api/1.01/order/confirm/RELO0TFQK8FXQXSPURM \
-H "Authorization: Bearer <token>"

Example Response​

{
  "trx": "RELO0T6YGUVIF4TBWE2",
  "priceCurrency": "eur",
  "priceAmount": 24.80,
  "priceVat": 0.00,
  "priceInclVat": 24.80,
  "priceFx": 1.00000000,
  "dateCreated": "2025-04-14T08:05:34.000Z",
  "paymentStatus": "paid",
  "type": "api",
  "reference": "test",
  "state": "sandbox",
  "orderStatus": "finished",
  "isBalancePayment": true,
  "downloaded": false,
  "items": [
    {
      "product": {
        "slug": "rewarble-ww-eur-5",
        "name": "rewarble 5 EUR WW",
        "brand": "rewarble",
        "productType": "topup",
        "region": "ww",
        "faceValueAmount": 5.0,
        "faceValueCurrency": "eur",
        "mainCategory": "giftcard",
        "redeemType": "currency",
        "isStocked": true
      },
      "amount": 5,
      "priceCurrency": "eur",
      "singlePriceAmount": 4.96,
      "totalPriceAmount": 24.80,
      "totalPriceVat": 0,
      "totalPriceInclVat": 24.80,
      "priceFx": 1.00000000,
      "paymentCurrency": "eur",
      "singlePriceAmountInPaymentCurrency": 4.96,
      "totalPriceAmountInPaymentCurrency": 24.80,
      "totalPriceVatInPaymentCurrency": 0.00,
      "totalPriceInclVatInPaymentCurrency": 24.80,
      "orderLines": [
        {
          "tag": "TAG-566a410b-a104-4337-b07a-054bdab4ae9b",
          "voucherCode": "TESTUMAJSPFUYVVI",
          "voucherSerial": "bfcb278f-0680-47e0-958c-d9ac5f716948",
          "status": "finished"
        },
        {
          "tag": "TAG-7386847a-c844-4d25-8451-1ff26597b71a",
          "voucherCode": "TESTRAKA7XONS1BX",
          "voucherSerial": "8b4def36-f631-4a26-a1ae-a0ce0581d0bf",
          "status": "finished"
        },
        {
          "tag": "TAG-8f9f1dd9-600e-4e8c-8e11-d9277b5c2031",
          "voucherCode": "TEST63H2IK9JP5XC",
          "voucherSerial": "cd00523f-3759-4c82-855f-4ab8f5368195",
          "voucherDateExpired": "2026-04-14T08:05:41.000Z",
          "status": "finished"
        },
        {
          "tag": "TAG-82ce8660-5f61-4dd1-8c9a-c2d3b1e6c3ce",
          "voucherCode": "TESTZ59ZXOCZSAZJ",
          "voucherSerial": "744ca45e-d94e-4e91-8809-79f2dce0ab0b",
          "voucherDateExpired": "2026-04-14T08:05:41.000Z",
          "status": "finished"
        },
        {
          "tag": "TAG-5605b37f-56ff-4b71-a731-7fc0afde5815",
          "voucherCode": "TESTYWEFA2RRQQ2C",
          "voucherSerial": "6f119457-a874-4c04-99ab-522f8993d3f9",
          "status": "finished"
        }
      ],
      "linesCompleted": 5,
      "productSlug": "rewarble-ww-eur-5",
      "faceValueAmount": 5.00,
      "faceValueCurrency": "eur",
      "faceValueFx": 1.00000000
    }
  ]
}

Response Fields​

Field nameField typeField description
trxStringTrx of order (Identifier)
priceCurrencyStringCurrency of price
priceAmountDecimalPrice before VAT
priceVatDecimalVAT amount
priceInclVatDecimalPrice including VAT
priceFxDecimalPrice calculation multiplier
dateCreatedDateCreation date of order
paymentStatusStringStatus of payment
typeStringType of system used to create order (portal or api)
referenceStringReference of order
stateStringEnvironment of order (live or sandbox)
orderStatusStringStatus of order
isBalancePaymentBooleanWhether the order is a balance payment or not
downloadedBooleanWhether the order has been downloaded or not
itemsObjectItem object
productObjectProduct object
slugStringSlug of product
nameStringName of product
brandStringBrand of product
productTypeStringType of product
regionStringRegion in which the product can be used
faceValueAmountDecimalValue of product
faceValueCurrencyStringCurrency of faceValue
mainCategoryStringMain category of product
redeemTypeStringRedeem type of product
isStockedBooleanWhether the product is in stock or not
amountIntegerAmount of product
priceCurrencyStringCurrency of price
singlePriceAmountDecimalPrice for a single product
totalPriceAmountDecimalTotal price of all products
totalPriceVatDecimalTotal VAT amount
totalPriceInclVatDecimalTotal price including VAT
paymentCurrencyStringCurrency of payment price
singlePriceAmountInPaymentCurrencyDecimalPrice of a single product in payment currency
totalPriceAmountInpaymentCurrencyDecimalTotal price of all products in payment currency
totalPriceVatInPaymentCurrencyDecimalTotal VAT amount in payment currency
totalPriceInclVatInPaymentCurrencyDecimalTotal price including VAT in payment currency
orderLinesArrayArray of codes ordered
tagStringInternal tag (id) of the code
statusStringStatus of product
linesCompletedIntegerAmount of orderLines with status finished
productSlugStringSlug of product
faceValueAmountDecimalValue of product
faceValueCurrencyStringCurrency of faceValueAmount
faceValuefxDecimalPrice calculation multiplier for faceValueAmount

Errors​

Errors response
EndpointHTTP status codeHTTP statusMessageReason
Confirm order400BAD_REQUESTMULTIPLE_ORDER_LINESMutiple items have been requested in the order (Not allowed when using the resolve endpoint)
Confirm order404NOT_FOUNDorder not foundInvalid order TRX
Confirm order400BAD_REQUESTthis order can not be confirmedOrder status is not 'created'
Confirm order400BAD_REQUESTthis order has expired, orders need confirmation within 24 hoursOrder was made over 24 hours ago
Confirm order400BAD_REQUESTcompany not verifiedCompany is not verified
Confirm order422UNPROCESSABLE_ENTITYsome offers not available: <offerNames>One or more offers are not available
Confirm order422UNPROCESSABLE_ENTITYProduct <productName> is out of stockOne or more productis out of stock
Confirm order402PAYMENT_REQUIREDinsufficient balanceUser does not have enough balance on the specified account

Notes​

note
  • Currency codes follow ISO 4217 standard
  • Codes shown in example have been altered and made invalid
  • Only orders with status created can be confirmed
  • Price information may be provided either as fixed price or as fee.
  • Price information may have been altered in the documentation
  • In sandbox mode this endpoint has a 50% chance to be cancelled immediately for testing purposes.