Payment Account
Endpoint ini digunakan untuk mengambil daftar rekening Anda yang tersedia sebagai tujuan pembayaran.
Sebelum membuat invoice, Anda perlu memastikan ketersediaan rekening tujuan. Gunakan nilai account_id dari response endpoint ini sebagai parameter saat melakukan Payment Create.
Penting:
- Anda hanya dapat membuat pembayaran jika status
account_active = truedanaccount_quota > 0. - Sistem Kuota Hari: Anda dapat melakukan Top Up / Renew Kuota Hari melalui Dashboard. Kuota hanya akan berkurang 1 (satu) apabila akun digunakan untuk membuat pembayaran pada hari tersebut, terlepas dari seberapa banyak request atau nominal pembayarannya. Jika tidak digunakan sama sekali pada hari itu, kuota Anda tidak akan berkurang.
Request
- Endpoint
- Parameter
- Header
- Body
- Contoh
| Method | URL |
|---|---|
GET | https://api.bayar.digital/gateway/accounts |
Tidak ada parameter yang dibutuhkan.
| Header | Wajib | Deskripsi |
|---|---|---|
X-Api-Key | Ya | API Key merchant Anda |
Tidak ada request body.
curl -X GET https://api.bayar.digital/gateway/accounts \
-H "X-Api-Key: pk_..."
Response
- Sukses
- Gagal
| Field | Tipe | Deskripsi |
|---|---|---|
account_id | uuid | Penting: Gunakan nilai ini sebagai account_id saat create payment |
account_number | string | Nomor rekening atau QRIS NMID |
account_name | string | Nama pemilik rekening |
account_min_amount | int64 | Minimal nominal pembayaran |
account_max_amount | int64 / null | Maksimal nominal pembayaran (null = tak terbatas) |
account_active | bool | Status keaktifan rekening |
account_quota | int | Sisa kuota hari |
channel_id | uuid | ID channel dari sistem perbankan |
channel_type | string | TRANSFER (transfer bank) atau QRIS |
channel_name | string | Nama bank atau institusi finansial |
app_id | uuid | ID aplikasi mobile banking |
app_name | string | Nama aplikasi mobile banking |
app_package | string | Package name dari aplikasi mobile banking |
200 OK
{
"success": true,
"message": "ok",
"data": [
{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"account_number": "1234567890",
"account_name": "PT Merchant Contoh",
"account_min_amount": 10000,
"account_max_amount": 10000000,
"account_active": true,
"account_quota": 30,
"channel_id": "660e8400-e29b-41d4-a716-446655440001",
"channel_type": "TRANSFER",
"channel_name": "Bank Central Asia",
"app_id": "990e8400-e29b-41d4-a716-446655440002",
"app_name": "BCA Mobile",
"app_package": "com.bca"
},
{
"account_id": "550e8400-e29b-41d4-a716-446655440003",
"account_number": "QRIS-001",
"account_name": "PT Merchant Contoh",
"account_min_amount": 1000,
"account_max_amount": 5000000,
"account_active": true,
"account_quota": 30,
"channel_id": "660e8400-e29b-41d4-a716-446655440004",
"channel_type": "QRIS",
"channel_name": "QRIS",
"app_id": null,
"app_name": null,
"app_package": null
}
]
}
| Code | Status | Keterangan |
|---|---|---|
tenant_api_key_required | 401 | API Key tidak valid atau tidak disertakan |
internal_error | 500 | Terjadi kesalahan pada server, silakan coba beberapa saat lagi |
401 Unauthorized
{
"success": false,
"code": "tenant_api_key_required",
"message": "tenant api key required"
}
500 Internal Server Error
{
"success": false,
"code": "internal_error",
"message": "internal server error"
}