v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB

Orders

Get the status of a BR-DGE Hosted Payment Page Order.

get/orders/{orderId}/status

Path parameters

orderIdstring required

The unique identifier for the Order.

This can be sourced from the orderId field in the response we sent to you when creating the Order.

Response

codestring

A numeric code which indicates the status of the order

messagestring

A textual description of the status of the order

creationTimestampstring

The date and time that the order was created

lastUpdatedTimestampstring

The date and time that the order was last updated or cancelled. Note: the date and time that a payment is made for this order does not affect the value of this field.

cardOnFileTokenCreatedstring

If a Card on File was created as part of this order, then this field will be populated with the multi-use token for the Card on File.

Example response

{
  "code": "1005",
  "message": "Order created",
  "creationTimestamp": "2022-01-30T10:10:10Z",
  "lastUpdatedTimestamp": "2022-01-30T10:10:10Z",
  "payments": [
    {
      "paymentId": "db805559-7cc4-4866-9e52-0b60fa59f12b",
      "code": "1000",
      "message": "Withdrawal limit exceeded",
      "timestamp": "2022-01-30T10:10:10Z",
      "paymentInstrument": {
        "nameOnCard": "John F Doe",
        "pan": "1234 56## #### 1111",
        "expiryDate": "05-25",
        "startDate": "01-00",
        "issueNumber": 1,
        "cardMetadata": {
          "cardBrand": "MASTERCARD",
          "category": "CLASSIC",
          "countryIsoA2": "GB",
          "commercial": true,
          "bin": "48321456"
        }
      },
      "psp": {
        "name": "Checkout.com",
        "transactionId": "6418da68-0b3d-4409-ab14-1ceb752b0b1f",
        "switchAccountId": "switch-account-123",
        "provisionedUserId": "Vx0H4pdAtPCz",
        "additionalInfo": {
          "customerFirstName": "John",
          "customerLastName": "Smith",
          "customerDateOfBirth": "2000-01-01",
          "customerIpAddress": "123.100.100.200",
          "customerId": "de5d7b4a-9410-40e1-85fd-8ceee23c9fd0",
          "paysafecardCustomerId": "151743187547"
        },
        "rawPspResponses": [
          {
            "httpStatusCode": 200,
            "pspName": "Checkout.com",
            "headers": {
              "content-type": [
                "application/json"
              ]
            }
          }
        ]
      },
      "avsResult": {
        "code": "I"
      }
    }
  ]
}