Linkage​

Balance Inquiry

Balance Inquiry adalah layanan yang menampilkan saldo tersedia di E-Wallet seperti OVO, Gopay, CIMB, Dana, dan ShopeePay. Layanan ini memungkinkan sistem Anda untuk memeriksa saldo yang terdaftar secara langsung melalui integrasi API, memastikan saldo tersebut tersedia secara akurat dan tepat waktu untuk keperluan transaksi.
Tipe Value
Service Code
11
Name
API Balance Inquiry
HTTP Method
POST

Flow

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

Environment

Environment URL
Sandbox
Port of HTTPS (443)
https://sandbox-api.espay.id/apidirectdebit/v1.0/balance-inquiry
Production
Port of HTTPS (443)
https://api.espay.id/apidirectdebit/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-Customer
String (150)
C
Kode token B2B2C. Khusus Espay -> Bank.
Y: Yes, O: Optional, C: Conditional

Parameter Permintaan

Parameter Tipe Mandatory Deskripsi
partnerReferenceNo
String (64)
Y
Kode referensi merchant.
bankCardToken
String (128)
C
Token kartu untuk pembayaran.
additionalInfo
Object
  productCode
String (64)
O
Kode produk. Klik disini
Y: Yes, O: Optional, C: Conditional

Parameter Permintaan

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

Format:
Kode HTTP + Kode Layanan + Kode Error

Contoh:
200+11+00 = 2001100.
responseMessage
String (150)
Y
Deskripsi respons.
accountInfo
Object
  balanceType
String (70)
Y
Jenis saldo pada akun.
  availableBalance
Object
    value
String (16.2)
Y
Saldo akun yang dapat digunakan untuk transaksi.

Format:
Desimal .00 (ISO 4217)

Contoh:
150000.00
    currency
Object
Y
Kode mata uang transaksi.

Format:
  • Rupiah: IDR
Y: Yes, O: Optional, C: Conditional




























Contoh Header

content-type:application/json
X-TIMESTAMP:2024-03-14T07:49:28+07:00
X-SIGNATURE:jaCUbDOSIjFcDaZ1rO0aCczJrWSfV0wAXVi/zOLlOLOIVH00gucOSOnHpKTARwpnn6qB08Vi8VJviNhIQh1q6zVJAwdhxnHRlwNFa28IVFTtSmD4nXPWT3LsuYuFPNDGJ59/MgKMVjwIofYvq2dwOHoDi9rnyT3nPl7N2bRdIQceQlD6sITcqdEbRUlm+zTFB2MxNy4vFaEZz1LU8fsENp+giMNqxR26DsNcRj1K8JBXO6nY8q2m3jmTmiduXK5VZXxt/5v6bp+OlYCwJhn3hmdZD1zwC3Hu6qZcCIhO6IVe0ThSCfsaCdye9o/Ew6VdMWbTtQUoR983mq6MubLmzg==
X-EXTERNAL-ID:d3be5aec-155b-4b46-bfee-3fd55363d0f4
X-PARTNER-ID:SGWYESSISHOP
CHANNEL-ID:ESPAY


























Contoh Permintaan

{
    "partnerReferenceNo":"uiiie182i4124o",
    "bankCardToken":"ESP230120035941IOIivjYrN3sVEViu8",
    "additionalInfo":{
        "productCode":"OVOLINK"
    }
}





Contoh Respons

{
    "responseCode": "2001100",
    "responseMessage": "Request has been processed successfully",
    "accountInfo": [
        {
            "balanceType": "CASH",
            "availableBalance": {
                "value": "19992334.00",
                "currency": "IDR"
            }
        },
        {
            "balanceType": "POINTS",
            "availableBalance": {
                "value": "1000000.00",
                "currency": "IDR"
            }
        }
    ]
}





CURL


curl --location 'https://sandbox-api.espay.id/apidirectdebit/v1.0/balance-inquiry' \
--header 'X-TIMESTAMP: 2024-03-14T07:49:28+07:00' \
--header 'X-SIGNATURE: B0VF16Vjsxxb/rUcgZM401XH7Z9cB5mhmYnfMdkblq84akTybh9Bakmb9nJD/ttrADmUbDJDW7s6E7yYTEATCdbjPs3+xEgA53gdcM7aJP9qPcfe79GankZrRvROcICdxuN2rjYZOuzvJ9SrfG/llmGic1bM627Eiz/G4pf7e8r6MOfsBRoUqH+moBGcw+/Xh2V8hqfb64hIzb7JZNZnVV7fQN6NZ8VAWLzjmo8PFLjg390wL3Fybr0GJwHohCaxBhv6P0nxVP+P9psnljKWt8EYHHWizgSVinUa9kncRq2MEpvLwujGcSG/MteZhcKXXYNGbCO5u7qato19fWwxaw==' \
--header 'X-EXTERNAL-ID: c1c915c4-a93e-407b-b770-f09720174be4' \
--header 'X-PARTNER-ID: SGWYESSOSHOP' \
--header 'CHANNEL-ID: ESPAY' \
--header 'Content-Type: application/json' \
--data '{
    "partnerReferenceNo":"uiiie182i4124o",
    "bankCardToken":"ESP230120035941IOIivjYrN3sVEViu8",
    "additionalInfo":{
        "productCode":"OVOLINK"
    }
}'





Scroll to Top