Create and monitor hosted Brick Checkout Page sessions. Checkout Page is useful when you want a shareable payment link or hosted payment page without building every payment method UI yourself.
Create Checkout Page Session
Create a hosted Brick Checkout Page session and receive a checkoutUrl that can be shared with customers. Use Checkout Page when you want Brick to host the payment experience across supported methods instead of building each payment UI yourself. The request defines amount, currency, customer details, expiry, and callback context for later reconciliation.
Headers
publicAccessTokenBearer
Create Checkout Page Session › Request Body
externalIdMerchant-defined unique identifier for the checkout session
currencyTransaction currency. Use IDR for current Receive Money flow.
descriptionCheckout label shown to the customer and used for reconciliation.
amountFixed payment amount. If omitted, the checkout may behave as an open-amount flow.
typePayment type. The tested collection supports qris and virtual_account.
Create Checkout Page Session › Responses
200
statuserrorshashcodeCheckout Status
Retrieve the latest status of a hosted Checkout Page session. Use this endpoint to reconcile payment links, order payments, or customer support cases when you have the checkout session reference. The response confirms whether the session is pending, paid, expired, failed, or otherwise ready for follow-up in your system.
query Parameters
checkoutIdBrick-generated checkout identifier returned from POST /v1/payments/checkout.
externalIdcheckout externalId
Checkout Status › Responses
200
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object | |
| type = object |
statuserrorshashcode