Brick API Documentation
Brick
Brick API

Checkout Page

Server

Membuat dan memantau sesi Brick Checkout Page yang dihosting. Checkout Page berguna ketika Anda menginginkan tautan pembayaran yang dapat dibagikan atau halaman pembayaran yang dihosting tanpa membuat sendiri setiap metode pembayaran UI.


Buat Sesi Halaman Checkout

POST
https://sandbox.onebrick.io
/v1/payments/checkout
publicAccessToken (header)

Buat sesi Brick Checkout Page yang dihosting dan terima checkoutUrl yang dapat dibagikan dengan pelanggan. Gunakan Checkout Page bila Anda ingin Brick menghosting pengalaman pembayaran di seluruh metode yang didukung alih-alih membuat sendiri setiap pembayaran UI. Permintaan tersebut menentukan jumlah, mata uang, detail pelanggan, masa berlaku, dan konteks callback untuk rekonsiliasi nanti.

Buat Sesi Halaman Checkout › Headers

publicAccessToken
​string · required

Pembawa `. periksa /getting-started/generate-public-access-token-jwt-token

Buat Sesi Halaman Checkout › Request Body

externalId
​string · required

Pengidentifikasi unik yang ditentukan penjual untuk sesi pembayaran

currency
​string · required

Mata uang transaksi. Gunakan IDR untuk aliran Receive Money saat ini.

description
​string · required

label Checkout ditunjukkan kepada pelanggan dan digunakan untuk rekonsiliasi.

amount
​number · double

Jumlah pembayaran tetap. Jika dihilangkan, pembayaran mungkin berperilaku sebagai aliran jumlah terbuka.

type
​string

Jenis pembayaran. Koleksi yang diuji mendukung qris dan virtual_account.

Buat Sesi Halaman Checkout › Responses

200

status
​integer
Default: 0
​object
errors
​
hashcode
​string

Status Checkout

GET
https://sandbox.onebrick.io
/v1/payments/checkout/status
publicAccessToken (header)

Ambil status terbaru dari sesi Checkout Page yang dihosting. Gunakan endpoint ini untuk merekonsiliasi tautan pembayaran, pembayaran pesanan, atau kasus dukungan pelanggan ketika Anda memiliki referensi sesi checkout. Responsnya mengonfirmasi apakah sesi tersebut tertunda, berbayar, kedaluwarsa, gagal, atau siap untuk ditindaklanjuti di sistem Anda.

Status Checkout › query Parameters

checkoutId
​string

pengidentifikasi checkout yang dihasilkan Brick dikembalikan dari POST /v1/payments/checkout.

externalId
​string

periksa externalId

Status Checkout › Responses

200

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object
type = object
type = object
type = object
Properties for Dibuat:
status
​integer
Default: 0
​object
errors
​
hashcode
​string