Orders

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

Changed on Nov 3, 2026

get/orders/{orderId}/status

Request

Base URL
https://sandbox.comcarde.com/v1
URL
https://sandbox.comcarde.com/v1/orders/{orderId}/status
Auth
HTTP bearer

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"
      }
    }
  ]
}

Changes

Nov 3, 2026c13725f5409c Revision changes
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the //////// response's property format changed from ipv4 to no format for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added subschema #2 to the response body allOf list for the response status
- info
  added subschema #2 to the response body allOf list for the response status
- info
  added the optional property /////////// to the response with the status
- info
  the response property //////// became required for the status
- info
  the response property //////// became required for the status
- info
  the response property //////// became required for the status
- info
  the response property //////// became required for the status
- info
  the response property //////// became required for the status
- info
  the ///// response's property pattern ^[A-Z]+$ was added for the status
- info
  the //////// response's property pattern was changed from ^$|^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ to ^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::(ffff(:0{1,4})?:)?((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))$ for the status

Operation history