Checkout Page
Create Checkout Page Session
Create Checkout Page Session is the API endpoint for creating a hosted Brick Checkout Page payment session. The response returns a Brick-generated checkout identifier and a checkoutUrl that you can present to the customer as a payment link.
Use this endpoint when your system needs to create checkout sessions on demand for web checkout, mobile checkout, invoices, chat-based payment requests, or customer support payment flows.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
externalId | string | Yes | Merchant-defined unique identifier for the checkout session. |
currency | string | Yes | Transaction currency. Use IDR for the current Receive Money flow. |
description | string | Yes | Checkout label shown to the customer and used for reconciliation. |
amount | number | No | Fixed payment amount. If omitted, the checkout may behave as an open-amount flow. |
type | string | No | Payment type. The tested collection supports qris and virtual_account. |
Response Fields
| Field | Type | Description |
|---|---|---|
data.id | string | Brick-generated checkout identifier. |
data.externalId | string | Your original merchant reference. |
data.status | string | Initial checkout status, such as CREATED. |
data.checkoutUrl | string | Hosted page URL to present to the customer. |
data.currency | string | Currency code. |
data.amount | number or null | Fixed amount if configured. |
data.type | string | Payment type when explicitly set. |
data.createdAt | string | ISO-8601 session creation timestamp. |
data.description | string | Session description. |
Last modified on