Disbursement

Balance Inquiry

Balance inquiry merupakan layanan yang disediakan agar dapat mengecek jumlah saldo terbaru Anda secara real-time.
Tipe Value
Kode Layanan
11
Nama
API Balance Inquiry
HTTP Method
POST

Flow

Anda melakukan permintaan dengan mengirimkan parameter yang dibutuhkan, dan Espay Disbursement akan memberikan respons dalam bentuk JSON.

API URL

Environment URL
Sandbox
Port of HTTPS (443)
https://sandbox-api.espay.id/api/v1.0/balance-inquiry
Production
Port of HTTPS (443)
https://api.espay.id/api/v1.0/balance-inquiry
Nama Tipe Mandatory Keterangan
Content-Type
String
Y
Isi konten permintaan Anda.

Contoh:
application/json
X-TIMESTAMP
String (25)
Y
Tanggal dan waktu lokal customer saat ini.

Format:
yyyy-MM-ddThh:mi:ssTZD (ISO 8601)

Contoh:
2024-03-14T07:49:28+07:00
X-SIGNATURE
String (255)
Y
Kode yang digunakan untuk melakukan validasi transaksi. Pelajari Signature Asymmetric
X-EXTERNAL-ID
String (32)
Y
String Numerik. Kode referensi yang bersifat unik pada hari yang sama.
X-PARTNER-ID
String (50)
Y
Merchant code yang diberikan oleh tim Espay.
CHANNEL-ID
String (5)
Y
Kode channel.

Value:
ESPAY
Authorization
String
Y
Token akses dari B2B. Pelajari Access Token B2B

Format:
Bearer (access token).

Contoh:
Bearer ZDE1MTQxM2QwODE2Zj UyNjk3ZmY0NTA3ZDgwZ Tg2ZDcyNmQ4MTNlYw
Y: Yes, O: Optional, C: Conditional

Parameter Permintaan

Parameter Tipe Mandatory Keterangan
partnerReferenceNo
String (64)
Y
Kode referensi merchant yang unik.
accountNo
String (16)
Y
Nomor rekening sumber.
bankCardToken
String (128)
C
Token kartu bank, mandatory jika accountNo null.
balanceTypes
Array of String
O
Tipe Saldo.

Format:
  • BCA: ["Cash", "Coin"]
  • Danamon: Balance
  • Permata: Balance
Y: Yes, O: Optional, C: Conditional

Parameter Respons

Parameter Tipe Mandatory Keterangan
responseCode
String (7)
Y
Kode respon.

Format:
Kode HTTP + Kode Layanan + Kode Error. Lihat disini

Contoh:
200+11+00 = 2001100.
responseMessage
String (150)
Y
Deskripsi respon.
referenceNo
String (16)
O
Kode referensi dari bank.
partneReferenceNo
String (64)
O
Kode referensi merchant yang unik.
accountNo
String (32)
Y
Nomor rekening sumber.
name
String (140)
O
Nama pemilik rekening sumber.
accountInfos
Array of Object
  balanceType
String (70)
O
Tipe Saldo.

Format:
  • BCA: ["Cash", "Coin"]
  • Danamon: Balance
  • Permata: Balance
  amount
Array of Object
    value
String (16.2)
O
Total saldo net.

Format:
Decimal .00 (ISO 4217)

Example:
150000.00
    currency
String (3)
O
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
  floatAmount
Array of Object
    value
String (16.2)
O
Total saldo deposit yang belum efektif (karena hari libur dll).

Format:
Desimal .00 (ISO 4217)

Contoh:
150000.00
    currency
String (3)
O
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
  holdAmount
Array of Object
    value
String (16.2)
O
Total saldo yang yang belum bisa digunakan.

Format:
Desimal .00 (ISO 4217)

Contoh:
150000.00
    currency
String (3)
O
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
  availableBalance
Array of Object
    value
String (16.2)
Y
Total saldo yang dapat digunakan untuk transaksi.

Format:
Desimal .00 (ISO 4217)

Contoh:
150000.00
    currency
String (3)
Y
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
  ledgerBalance
Array of Object
    value
String (16.2)
O
Total saldo yang tersedia pada awal hari sebelum transaksi.

Format:
Desimal .00 (ISO 4217)

Contoh:
150000.00
    currency
String (3)
O
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
  currentMultilateralLimit
Array of Object
    value
String (16.2)
O
Batas limit kredit / plafon.

Format:
Desimal .00 (ISO 4217)

Contoh:
150000.00
    currency
String (3)
O
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
  additionalInfo
Array of Object
    productCode
String (20)
O
Kode produk.

Format:
  • BRI: TV
  • CIMB: CAGIRO0016
    productDesc
String (256)
O
Deskripsi produk.

Format:
  • CIMB: Giro Perusahaan
    accountType
String (2)
O
Tipe akun.

Format:
CIMB
  • Rekening Giro: CA
BRI
  • Saving: SA
  • Deposito: TA
  • Giro: DA
  • Loan: LA
  status
String (5)
O
Status akun. Lihat disini
Y: Yes, O: Optional, C: Conditional

Try It!

Anda bisa coba masukkan data sesuai dengan input yang telah disediakan. Setelah itu Anda submit dan lihat hasilnya!































Contoh Header

Content-Type:application/json
X-TIMESTAMP:2024-03-14T07:49:28+07:00
X-SIGNATURE:w1m7j0UGZxqPPyTZB2EZOF5Tpokp/PfHgcrnJq3NVQ9e8Q8vUmQ123c6CSqbTV/VRXxAVrQazEda9nMoJ/oIML7zZ/M1WUTRkv5RK/e+vLP+ZZAMDlgs8jM6RFerkCPUgkAKZ08yAePcgPCjipS3In4BrMa164bf+/rkuS3sGZ4YUNSfTn+uMdEzlO1aGMgm2ZRbJKq6JsNFweTNuWdecbktWsVQdSa0J3rC0DKGSc54LXScuv2ztzmLO/3rsJTUk17ZmSP6vbmc24h6LARbBnkYVeDTU8BLC62/41U3hgiv3CsX/DQ3IUvDCu+LYsxJCnkZJYZ/wwYHRqArUl6GzQ==
X-EXTERNAL-ID:d3be5aec-155b-4b46-bfee-3fd55363d0f4
X-PARTNER-ID:SGWYESSISHOP
CHANNEL-ID:ESPAY
Authorization:Bearer dPYxGvc5SSS8lETvpqRZ2hdM39fTNN3uhIZS5woAZb79ybGDDNAMeWVG2S7cp0USwx9TGcXN/0kzYGobeyzpdg==
































Contoh Permintaan

{
    "partnerReferenceNo":"2020102900000000001",
    "accountNo":"1234567890",
    "balanceTypes":[
        "CASH",
        "POINTS"
    ]
}










Contoh Respons Positif

{
    "responseCode": "2001100",
    "responseMessage": "Successful",
    "referenceNo": "2020102977770000000009",
    "partnerReferenceNo": "2020102900000000001",
    "accountNo": "1234567890",
    "name": "Andhika",
    "accountInfos": {
        "balanceType": "Cash",
        "amount": {
            "value": "100000.00",
            "currency": "IDR"
        },
        "floatAmount": {
            "value": "500000.00",
            "currency": "IDR"
        },
        "holdAmount": {
            "value": "200000.00",
            "currency": "IDR"
        },
        "availableBalance": {
            "value": "200000.00",
            "currency": "IDR"
        },
        "ledgerBalance": {
            "value": "200000.00",
            "currency": "IDR"
        },
        "currentMultilateralLimit": {
            "value": "200000.00",
            "currency": "IDR"
        }
    },
    "additionalInfo": {
        "productCode": "CAGIRO0016",
        "productDesc": "Giro Perusahaan",
        "accountType": "CA"
    }
}


Contoh Respons Negatif

{
    "responseCode": "4011101",
    "responseMessage": "Invalid Token (B2B)"
}


CURL

curl --location 'https://sandbox-api.espay.id/api/v1.0/balance-inquiry' \
--header 'Content-Type: application/json' \
--header 'X-TIMESTAMP: 2024-03-14T07:49:28+07:00' \
--header 'X-SIGNATURE: w1m7j0UGZxqPPyTZB2EZOF5Tpokp/PfHgcrnJq3NVQ9e8Q8vUmQ123c6CSqbTV/VRXxAVrQazEda9nMoJ/oIML7zZ/M1WUTRkv5RK/e+vLP+ZZAMDlgs8jM6RFerkCPUgkAKZ08yAePcgPCjipS3In4BrMa164bf+/rkuS3sGZ4YUNSfTn+uMdEzlO1aGMgm2ZRbJKq6JsNFweTNuWdecbktWsVQdSa0J3rC0DKGSc54LXScuv2ztzmLO/3rsJTUk17ZmSP6vbmc24h6LARbBnkYVeDTU8BLC62/41U3hgiv3CsX/DQ3IUvDCu+LYsxJCnkZJYZ/wwYHRqArUl6GzQ==' \
--header 'X-EXTERNAL-ID: 2a087dae-2948-4d9b-b058-d09c7594a967' \
--header 'X-PARTNER-ID: SGWYESSISHOP' \
--header 'CHANNEL-ID: ESPAY' \
--header 'Authorization: Bearer dPYxGvc5SSS8lETvpqRZ2hdM39fTNN3uhIZS5woAZb79ybGDDNAMeWVG2S7cp0USwx9TGcXN/0kzYGobeyzpdg==' \
--data '{
    "partnerReferenceNo":"2020102900000000001",
    "accountNo":"1234567890",
    "balanceTypes":[
        "CASH",
        "POINTS"
    ]
}'
Scroll to Top