Create Checkout Page Session

Creates a hosted checkout session and returns a unique checkoutUrl.

Request Body

FieldTypeRequiredDescription
externalIdstringYesMerchant-defined unique identifier for the checkout session.
currencystringYesTransaction currency. Use IDR for current acceptance flow.
descriptionstringYesCheckout label shown to the customer and used for reconciliation.
amountnumberNoFixed payment amount. If omitted, the checkout may behave as an open-amount flow.
typestringNoPayment type. The tested collection supports qris and virtual_account.

Response Fields

FieldTypeDescription
data.idstringBrick-generated checkout identifier.
data.externalIdstringYour original merchant reference.
data.statusstringInitial checkout status, such as CREATED.
data.checkoutUrlstringHosted page URL to present to the customer.
data.currencystringCurrency code.
data.amountnumber or nullFixed amount if configured.
data.typestringPayment type when explicitly set.
data.createdAtstringISO-8601 session creation timestamp.
data.descriptionstringSession description.
Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!