get
https://sandbox.onebrick.io/v1/payments/checkout/status
Use this endpoint to retrieve the latest status of a checkout page session.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this endpoint to retrieve the latest status of a checkout page session.
You can query by Brick's checkoutId or by your own externalId. Store both values after creating a checkout session so your system can reconcile checkout progress even if a callback is delayed or missed.
When to Use This Endpoint
- Confirm a checkout session after the customer returns to your application.
- Reconcile payment status when your callback endpoint was unavailable.
- Check whether a checkout session is still open, completed, or expired.
Query Parameters
Provide at least one of the following identifiers:
| Parameter | Description |
|---|---|
checkoutId | Brick-generated checkout identifier returned when the checkout session is created. |
externalId | Your own checkout identifier sent when creating the checkout session. |
Status Values
| Status | Meaning |
|---|---|
CREATED | The checkout session has been created. |
OPENED | The customer has opened the checkout page. |
COMPLETED | The payment has been completed. Payment details are returned in the response when available. |
EXPIRED | The checkout session expired before payment was completed. |
For the full request and response examples, use the API reference panel on this page.