Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Order

Order:Update

Update an order with a reference and/or description. This action is only allowed for orders of the type 'payment_based_checkout' and only if the value to update is currently not set.

patch/v1/orders/{id}

Path parameters

idstring required
Example:9f5cc332-8cd7-4242-b9c8-51941aa12837

The id of the order

Request body

referencestring nullable

The merchant identification of this transaction. This field only allows alphanumeric characters

descriptionstring nullable

Is shown on the statement of the payer.

Example request

{
  "reference": "REF1234",
  "description": "Order Description"
}

Response

Order updated

idstring

The unique identifier of your order.

typestring

The order type.

serviceIdstring

The Service ID used for creating this order

descriptionstring nullable

The description given for this order.

referencestring nullable

The reference given for this order.

manualTransferCodestring

The manual transfer code that can be used to transfer the order amount to PAY. using a bank transfer.

orderIdstring

The order ID as you would see it within the PAY. platform.

uuidstring

The UUID that can be used to create a QR code for this order.

customerKeystring nullable

An identifier for the customer

receiptstring nullable

Base64 encoded string of the receipt for this order when it's paid.

transferDataobject

Contains the transferData values given when the order was created.

createdAtstring date-time

The date-time at which this order was created in our system.

createdBystring nullable

The API token or Service ID that created this order.

modifiedAtstring date-time nullable

The date-time at which this order was modified in our system. This can be done by you or by actions taken within our order-payment flow.

modifiedBystring nullable

The API token or Service ID that did the modification of the order. This can also be the TGU node that was handling the order-payment flow.

expiresAtstring date-time

The date-time at which this order expires.

completedAtstring date-time nullable

The date-time at which this order was completed. This means that all underlying payments are captured and money is guaranteed.

linksobject

The links that can be used to interact with this order.

Example response

{
  "id": "655b2da5-5223-8f32-1aee-737862302XXX",
  "type": "sale",
  "serviceId": "SL-####-####",
  "description": "Instore Terminal Order #27",
  "reference": "REF1234",
  "manualTransferCode": "1234 1234 1234 1234",
  "orderId": "52305407020X2325",
  "uuid": "ad0e7378-6230-2325-5230-5407020a2XXX",
  "status": {
    "code": 20,
    "name": "pending",
    "action": "PENDING"
  },
  "receipt": "<base64 string>",
  "splitPayments": [
    {
      "amount": {
        "value": 1,
        "currency": "EUR"
      }
    }
  ],
  "stats": {
    "extra1": "Extra1",
    "extra2": "Extra2",
    "extra3": "Extra3",
    "tool": "Tool",
    "info": "Info",
    "object": "Object",
    "domainId": "WU-1234-1234"
  },
  "amount": {
    "value": 1,
    "currency": "EUR"
  },
  "authorizedAmount": {
    "value": 1,
    "currency": "EUR"
  },
  "capturedAmount": {
    "value": 1,
    "currency": "EUR"
  },
  "checkoutData": {
    "customer": {
      "email": "johndoe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "1999-11-22",
      "gender": "O",
      "phone": "06-12345678",
      "locale": "nl_BE",
      "ipAddress": "192.168.0.1",
      "reference": "Cstmr12",
      "company": {
        "name": "Pay.",
        "cocNumber": "24283498",
        "vatNumber": "NL807960147B01",
        "country": "NL"
      }
    },
    "billingAddress": {
      "firstName": "John",
      "lastName": "Doe",
      "streetName": "Curieweg",
      "streetNumber": "19",
      "streetNumberAddition": "C",
      "zipCode": "3208 KJ",
      "city": "Spijkenisse",
      "countryCode": "NL",
      "regionCode": "nl-ZH"
    },
    "shippingAddress": {
      "firstName": "John",
      "lastName": "Doe",
      "streetName": "Curieweg",
      "streetNumber": "19",
      "streetNumberAddition": "C",
      "zipCode": "3208 KJ",
      "city": "Spijkenisse",
      "countryCode": "NL",
      "regionCode": "nl-ZH"
    }
  },
  "payments": [
    {
      "id": "2d29c301-c71d-4016-8239-4ee3194a234e",
      "customerKey": "5d7dbff5bf0a64c7e3d9dbd8806d2b55d3d67731",
      "customerId": "GB33BUKB20201555555555",
      "customerMethod": {
        "data": {
          "iban": "NL05ABNA8014558928",
          "name": "Pay.nl",
          "bic": "RABONL2U"
        }
      },
      "status": {
        "code": 20,
        "name": "pending",
        "action": "PENDING"
      },
      "currencyAmount": {
        "value": 1,
        "currency": "EUR"
      },
      "amount": {
        "value": 1,
        "currency": "EUR"
      },
      "authorizedAmount": {
        "value": 1,
        "currency": "EUR"
      },
      "capturedAmount": {
        "value": 1,
        "currency": "EUR"
      }
    }
  ],
  "links": {
    "redirect": "<an_url>",
    "status": "<an_url>",
    "cancel": "<an_url>"
  }
}