Checkout Page

Server

Download schema

Create Checkout Page Session

POST

https://sandbox.onebrick.io/v2/payments/general

/checkout

Creates a hosted checkout session and returns a unique checkoutUrl.

Create Checkout Page Session › Headers

publicAccessToken

string · required

Bearer `. check https://onebrick.readme.io/reference/generate-public-access-token-jwt-token

Create Checkout Page Session › Request Body

externalId

string · required

Merchant-defined unique identifier for the checkout session

currency

string · required

Transaction currency. Use IDR for current acceptance flow.

description

string · required

Checkout label shown to the customer and used for reconciliation.

amount

number · double

Fixed payment amount. If omitted, the checkout may behave as an open-amount flow.

type

string

Payment type. The tested collection supports qris and virtual_account.

Create Checkout Page Session › Responses

200

status

integer

Default: 0

object

errors

hashcode

string

POST/checkout

curl https://sandbox.onebrick.io/v2/payments/general/checkout \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'publicAccessToken: <string>' \
  --data '{
  "externalId": "CO-1773723246580",
  "currency": "IDR",
  "description": "Gaming Voucher Free Amount"
}'

Example Request Body

{
  "externalId": "CO-1773723246580",
  "currency": "IDR",
  "description": "Gaming Voucher Free Amount"
}

json

application/json

Example Responses

{
  "status": 200,
  "data": {
    "id": "QyECa1OpjWJcyfzXOLT6HKCxAVoDzUs3",
    "externalId": "CO-1773723246580",
    "status": "CREATED",
    "checkoutUrl": "https://sandbox-checkout.onebrick.io/aiU5tkLQZeZzXXdgwZUenOyGgTf41mKqyXv9XS96yB4QE9lze2wuMFhfPH4jMC2%2B",
    "currency": "IDR",
    "amount": null,
    "type": "",
    "createdAt": "2026-03-17T04:54:06Z",
    "description": "Gaming Voucher Free Amount"
  },
  "errors": null,
  "hashcode": "38d4b6cc3dd7a6cbb400f08c3bed1228"
}

json

application/json

Checkout Status

GET

https://sandbox.onebrick.io/v2/payments/general

/checkout/status

Checkout Status › query Parameters

checkoutId

string

Brick-generated checkout identifier returned from POST /v1/payments/checkout.

externalId

string

checkout externalId

Checkout Status › Responses

200

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object
	type = object
	type = object

Properties for Created:

status

integer

Default: 0

object

errors

hashcode

string

E-wallet OCR Bank Statement

Create Checkout Page Session

POST

https://sandbox.onebrick.io/v2/payments/general

/checkout

Creates a hosted checkout session and returns a unique checkoutUrl.

Create Checkout Page Session › Headers

publicAccessToken

string · required

Bearer `. check https://onebrick.readme.io/reference/generate-public-access-token-jwt-token

Create Checkout Page Session › Request Body

externalId

string · required

Merchant-defined unique identifier for the checkout session

currency

string · required

Transaction currency. Use IDR for current acceptance flow.

description

string · required

Checkout label shown to the customer and used for reconciliation.

amount

number · double

Fixed payment amount. If omitted, the checkout may behave as an open-amount flow.

type

string

Payment type. The tested collection supports qris and virtual_account.

Create Checkout Page Session › Responses

200

status

integer

Default: 0

object

errors

hashcode

string

Checkout Status

GET

https://sandbox.onebrick.io/v2/payments/general

/checkout/status

Checkout Status › query Parameters

checkoutId

string

Brick-generated checkout identifier returned from POST /v1/payments/checkout.

externalId

string

checkout externalId

Checkout Status › Responses

200

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object
	type = object
	type = object

Properties for Created:

status

integer

Default: 0

object

errors

hashcode

string