--- title: "Get the status of a BR-DGE Hosted Payment Page Order." method: GET path: "/orders/{orderId}/status" tags: ["Orders"] --- # Get the status of a BR-DGE Hosted Payment Page Order. `GET /orders/{orderId}/status` ## Path parameters - `orderId` string, required ## Response `200` OK - OrderStatusResponse — Last known status of an Order - `code` string — A numeric code which indicates the status of the order - `message` string — A textual description of the status of the order - `creationTimestamp` string — The date and time that the order was created - `lastUpdatedTimestamp` string — 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. - `cardOnFileTokenCreated` string — 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. - `payments` object[] — A list of up to three payment attempts in descending time order - `paymentId` string — Unique identifier for the payment - `code` string — A unique identifier covering the outcome of the request. - `message` string — A description of the outcome of the request. - `timestamp` string — Timestamp for when the payment attempt was made - `paymentInstrument` union - OrderPaymentInstrumentCard — Returned when an order was paid using a card Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - `nameOnCard` string - `pan` string, required - `expiryDate` string, required — Card expiry date in MM-YY format. - `startDate` string — Start date of the credit or debit card. - `issueNumber` integer — Issue number of the credit or debit card. - `cardMetadata` CardMetadata — If a card payment instrument is used then BR-DGE may be able to provide metadata about the card **Please note: All text will be UPPERCASE and all fields can be null** - `metadataType` string — Discriminator field. Discriminator field. Please see the discriminator mapping for the PaymentInstrumentMetadata schema. - `cardBrand` string — MASTERCARD, VISA, etc - `issuer` string — Name of issuing bank - `type` 'DEBIT' | 'CREDIT' | 'CHARGE_CARD' | 'CHARGE' | 'DEFERRED_DEBIT' | 'PREPAID' | 'PREPAID_RELOADABLE' | 'UNKNOWN' - `category` string — CLASSIC, BUSINESS, MIXED_PRODUCT, etc - `countryIsoA2` string — ISO 3166 Alpha-2 Country code - `commercial` boolean — Indicates if the card is corporate or retail - `bin` string — The Bank Identification Number that identifies the bank or financial institution that issued the card - OrderPaymentInstrumentApplePay — Returned when an order was paid using an Apple Pay Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - OrderPaymentInstrumentGooglePay — Returned when an order was paid using a Google Pay Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - OrderPaymentInstrumentPayPal — Returned when an order was paid using PayPal Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - OrderPaymentInstrumentPayPalOrder — Returned when an order was paid using PayPal Order Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - `intent` string — The intent of the payment - `orderId` string — The Id of the Paypal Order - OrderPaymentInstrumentVisaInstalments — Returned when an order was paid using a Visa Instalments Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - OrderPaymentInstrumentAstroPay — Returned when an order was paid using an AstroPay Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - OrderPaymentInstrumentTrustly — Returned when an order was paid using an Trustly Payment Instrument. - `type` string, required — Discriminator field. Please see the discriminator mapping for the `OrderPaymentInstrument` schema. - `psp` PspInfo - `name` string, required — Name of Payment Service Provider (PSPs). Please see [PSP Integrations] for a list of possible PSPs. [PSP Integrations]: https://docs.br-dge.io/docs/psp-integrations - `transactionId` string, required — Identifier provided by the PSP this payment was routed to. - `switchAccountId` string — Internal switch account identifier for the PSP account that was used to perform the transaction. This is an internally-assigned identifier, not a value provided by the PSP. Please note: PSP account switching feature is still under development and this field is not present in GET responses and notifications yet. - `pspToken` string — The token created by the PSP for the payment instrument. - `pspCardFingerprint` string — The PSP fingerprint for the payment instrument. - `provisionedUserId` string — PSP-specific user ID that was provisioned by the PSP when processing the payment. - `additionalInfo` union — Any additional information returned from interaction with PSP - object - `type` string — Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema. - `customerFirstName` string — Customer's first name - `customerLastName` string — Customer's last name - `customerDateOfBirth` string, date — Customer's date of birth - `customerIpAddress` string, ipv4 — IP address of the customer - `customerId` string — The ID of the customer in your system. - `paysafecardCustomerId` string — Paysafecard identifier for the customer - object - `type` string — Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema. - `customerPaymentOptionId` string — Identifier for the customer Payment Option - object - `type` string — Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema. - `customerPaymentOptionId` string — Identifier for the customer Payment Option - object - `type` string — Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema. - `customer` TrueLayerCustomer — Contains TrueLayer customer information. - `address` Address - … - `dateOfBirth` string, date — Date of birth of the referenced person. While this field is not required by the BR-DGE API; it is highly recommended as some PSPs recommend the inclusion of this field. If you have any questions about whether you should provide customer date of birth, please raise a ticket with the [BR-DGE Support Centre](https://support.br-dge.io/support/home). - `customerId` string — The ID of the customer in TrueLayer's system - `name` string — Customer's full name - `providerId` string — ID of the bank or other financial institution used in this payment in TrueLayer's system - `paymentSourceId` string — ID of the customer's payment source used to perform the payment in TrueLayer's system - `originalTransactionId` string - `accountNumber` string — 8 digit bank account number. - `sortCode` string — 6 digit sort code (no spaces or dashes). - `iban` string — Valid ISO 13616 International Bank Account Number (no spaces). Consists of a 2 letter country code, followed by 2 check digits, and then by up to 30 alphanumeric characters (also known as the BBAN). - object - `type` string — Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema. - `fingerprint` string — The fingerprint associated to the authorized order's payment method - `name` string — The name of the revolut customer. - `emailAddress` string — The email address of the revolut customer - `paymentRevTag` string — Unique handle for a Revolut customer. - `revolutCustomerId` string, uuid — The unique identifier for the revolut customer. - `billingAddress` RevolutPayBillingAddress - `street_line_1` string — First line of street address information for Revolut customer. - `street_line_2` string — Second line of street address information for Revolut customer.. - `region` string — The region associated with the address. - `city` string — The region associated with the address. - `country_code` string — 2 letter country code of the country associated with the address. - `postcode` string — The postcode associated with the address. - object - `type` string — Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema. - `vaultId` string — Vault ID generated by PayPal referring to the customer's stored PayPal wallet. - `paymentSource` PaymentSource — Details of the PayPal account used to complete the payment for the PayPal Order. - `name` string — Full name of customer. - `email` string — Email address of the customer. - `accountId` string — PayPal account ID. - `vaultId` string — Vault ID generated by PayPal referring to the customer's stored PayPal wallet. - object - `type` string — Discriminator field. Please see the discriminator mapping for the `AdditionalInfo` schema. - `pin` string — voucher pin - `serialNumber` string — voucher serial number - `rawPspResponses` RawPspResponse[], nullable - `httpStatusCode` integer — The http response code for the given call to the external system - `body` string — The response body of the http request to the external system. This is the raw response with sensitive data redacted. We make no guarantees about the format of this field. It is psp dependant. The majority of these responses are in `application/json` but note for certain types of error response they may be `text/html` or `application/xml` - `pspName` string, required — Name of Payment Service Provider (PSPs). Please see [PSP Integrations] for a list of possible PSPs. [PSP Integrations]: https://docs.br-dge.io/docs/psp-integrations - `headers` object — A key/value map of the http headers from the external system. - `paymentAccountReference` string — The Payment Account Reference (PAR) linked the the payment-instrument, if available. See our [dedicated PAR guide](https://docs.br-dge.io/docs/payment-account-reference) for more info. - `avsResult` AvsResult — Information about the AVS (Address Verification Service) result. - `code` 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' — The AVS (Address Verification Service) result code. | AVS Code | Meaning | |----------|---------------------------------------------------------------| | A | Postal code matches, street address matches. | | B | Postal code matches, street address not checked. | | C | Postal code matches, street address does not match. | | D | Postal code not checked, street address matches. | | E | Postal code does not match, street address matches. | | F | Postal code not checked, street address not checked. | | G | Postal code not checked, street address does not match. | | H | Postal code does not match, street address not checked. | | I | Both postal code and street address do not match. | | J | Both postal code and street address were not provided. | | K | AVS is unavailable. | | L | Postal code was not provided, street address was not checked. | | M | Postal code was not provided, street address matches. | | N | Postal code was not provided, street address does not match. | | O | Postal code was not checked, street address was not provided. | | P | Postal code matches, street address was not provided. | | Q | Postal code does not match, street address was not provided. | - `message` string — A human readable meaning behind the AVS code specified in the `code` field. ## Other responses - `401` — Unauthorized request. - `404` — The specified entity was not found. - `500` — An internal server error occurred upstream while processing the request. If you have any questions about why you are receiving these responses, please raise a ticket with support on the BR-DGE Support Portal at with the `id` from the response so we track down the individual requests on our end. --- [API](https://skmtc.net/br-dge/apis/br-dge-transaction-rest-api.md) · [All operations](https://skmtc.net/br-dge/apis/br-dge-transaction-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/br-dge/br-dge-transaction-rest-api/revisions/a9c0feac5523/schema)