Technical Documentation OpenAPI-Account-
Balance API
Version 1.6
Release Date: April 05, 2022
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
Document Version
Date Doc Version Description
- Update port from 8443 to 443
- Update field balanceType to balanceTypes
April 05, 2022 1.6
- Update field accountInfo to accountInfos
- Update list error code
- Remove field format partnerReferenceNo
February 02, 2022 1.5 - Add field bankCardToken at request
- Remove field currency
December 15, 2021 1.4 Update port from 443 to 8443
Add note and highlight field used by BCA
September 16, 2021 1.3
Update endpoint
September 01, 2021 1.2 Update request dan response
July 22, 2021 1.1 Remove clientId
April 01, 2021 1.0 Create this document
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
2
Contents
Document Version ........................................................................................................................................ 2
Contents ........................................................................................................................................................ 3
Prerequisites ................................................................................................................................................. 4
Introduction .................................................................................................................................................. 4
Core Resources ............................................................................................................................................. 5
Account Balance.................................................................................................................................... 5
General Errors ............................................................................................................................................. 12
Sample Errors .............................................................................................................................................. 13
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
3
Prerequisites
To successfully communicate with API BCA, please read API BCA - Oauth & Signature OpenAPI
documentation first.
Introduction
Overview of OpenAPI-Account-Balance API:
Method Endpoint Usage
POST /openapi/v1.0/balance-inquiry Inquiry Account Balance
URL that you can access:
URL Usage
https://devapi.klikbca.com BCA API UAT environment. Port of HTTPS (443)
https://api.klikbca.com BCA API production environment. Port of HTTPS (443)
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
4
Core Resources
Account Balance
This service is used to inquiry account balance.
Your request must contain following information:
Note :
= Field used by BCA
Additional Headers and URI Params
Field Params Data Type Length Mandatory Description
Type Type
Channel’s identifier using
CHANNEL-ID Header String (5) Fixed Y
WSID KlikBCA Bisnis
(95051)
X-PARTNER-ID Header String Max Y Corporate ID
(32)
Payload
Field Data Length Mandatory Format Description
Type Type
partnerReferenceNo String Max Y - Mandatory in BCA.
(64) Transaction
identifier on service
consumer system
bankCardToken String Max N - Card token for
(128) payment
Only filled if
accountNo is null
and Authorization-
Customer is Null.
accountNo String Max Y Numeric Mandatory in BCA.
(16) Bank account
number using
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
5
registered account
number in KlikBCA
Bisnis. For BCA,
length account
number is 10 digit
balanceTypes Array N Balance Types of
of this parameter
String doesn’t exist, its
mean to inquiry all
Balance Type on the
account
Result of the request will contains following information:
Response
Field Data Type Length Mandato Format Description
Type ry
responseCode String (7) Fixed Y - Response code
responseMessage String Max Y - Response
(150) description
referenceNo String (64) Max N Numeric Send by BCA.
Transaction
identifier on
service provider
system. Unique
each day from
BCA
Must be filled
upon successful
transaction.
partnerReferenceNo String (64) Max N - Send by BCA
according to the
request input.
Transaction
identifier on
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
6
service customer
system.
accountNo String (32) Max N Numeric Send by BCA
according to the
request input.
Registered
account number
in KlikBCA Bisnis.
For BCA, length
account number
is 10 digit.
name String (140) Max N Alphanume Send by BCA.
ric Customer
account name
accountInfos Array of N Send by BCA.
Object
balanceType String (70) Max N - Account type
name
amount Object N Send by BCA.
Net amount of
the transaction
value String Max Y Numeric Send by BCA.
(16.2)
If it's IDR then
value includes 2
decimal
digits. BCA will
send response
amount with
format value
Numeric (13.2)
currency String (3) ISO-4217
Fixed Y Send by BCA.
Currency of the
account
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
7
floatAmount Object N Send by BCA.
Amount of
deposit that is
not effective yet
(due to holiday,
etc)
value String Max Y Numeric Send by BCA.
(16.2)
If it's IDR then
value includes 2
decimal
digits. BCA will
send response
amount with
format value
Numeric (13.2)
currency String (3) ISO-4217
Fixed Y Send by BCA.
Currency of the
account
holdAmount Object N - Send by BCA.
Hold amount that
cannot be used
value String Max Y Numeric Send by BCA.
(16.2)
If it's IDR then
value includes 2
decimal
digits. BCA will
send response
amount with
format value
Numeric (13.2)
currency String (3) ISO-4217
Fixed Y Send by BCA.
Currency of the
account
availableBalance Object N Send by BCA.
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
8
Account balance
that can be used
for financial
transaction
value String Max Y Numeric Send by BCA.
(16.2)
If it's IDR then
value includes 2
decimal
digits. BCA will
send response
amount with
format value
Numeric (13.2)
currency String(3) ISO-4217
Fixed Y Send by BCA.
Currency of the
account
ledgerBalance Object N Account balance
at the beginning
of each day
value String Max Y Numeric If it's IDR then
(16.2) value includes 2
ISO4217 decimal
digits. BCA will
send response
amount with
format value
Numeric (13.2)
currency String (3) Fixed Y Alphanume Currency of the
ric account
currentMultilateralLi Object N Credit limit of the
mit account/plafon
value String Max Y Numeric If it's IDR then
(16.2) value includes 2
ISO4217 decimal
digits. BCA will
send response
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
9
amount with
format value
Numeric (13.2)
currency String(3) Fixed Y Alphanume Currency of the
ric account
String(4) Fixed N Numeric Customer
registrationStatusCo registration
de status
status String(4) Fixed N Numeric Account status
1 = Active
Account
2 = Closed
Account
4 = New Account
6 = Restricted
Account
7 = Frozen
Account
9 = Dormant
Account
Request
curl –X POST https://api.klikbca.com:8443/openapi/v1.0/balance-inquiry
-H 'CHANNEL-ID':'95051'
-H 'X-PARTNER-ID': 'KBBABCINDO'
-d '{
"partnerReferenceNo": "2020102900000000000001",
"accountNo": "1234567890",
"bankCardToken":"",
"balanceTypes":["Cash","Coins"]
}'
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
10
Response
{
"responseCode": "2001100",
"responseMessage": "Successful",
"referenceNo": "2020102977770000000009",
"partnerReferenceNo": "2020102900000000000001",
"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"
},
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
11
"registrationStatusCode": "0001",
"status": "0001"
}
}
General Errors
BCA OpenAPI Account Balance Uses following general error schema:
{
"responseCode": "5001100",
"responseMessage": "General error",
"referenceNo": "",
"partnerReferenceNo": "2020102900000000000001",
"accountNo": "1234567890",
"name": "",
"accountInfos": {
"balanceType": "",
"amount": {
"value": "",
"currency": ""
},
"floatAmount": {
"value": "",
"currency": ""
},
"holdAmount": {
"value": "",
"currency": ""
},
"availableBalance": {
"value": "",
"currency": ""
},
"ledgerBalance": {
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
12
"value": "",
"currency": ""
},
"currentMultilateralLimit": {
"value": "",
"currency": ""
},
"registrationStatusCode": "",
"status": ""
}
}
Sample Errors
BCA OpenAPI Account Balance Uses following sample error schema:
{
"responseCode": "4001102",
"responseMessage": "Invalid Mandatory Field accountNo",
"referenceNo": "",
"partnerReferenceNo": "2020102900000000000001",
"accountNo": "1234567890",
"name": "",
"accountInfos": {
"balanceType": "",
"amount": {
"value": "",
"currency": ""
},
"floatAmount": {
"value": "",
"currency": ""
},
"holdAmount": {
"value": "",
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
13
"currency": ""
},
"availableBalance": {
"value": "",
"currency": ""
},
"ledgerBalance": {
"value": "",
"currency": ""
},
"currentMultilateralLimit": {
"value": "",
"currency": ""
},
"registrationStatusCode": "",
"status": ""
}
}
Here is the list of error codes that can be returned.
HTTP Code Error Code Error Message (Indonesian)
400 4001100 Bad request
400 4001101 Invalid Field Format {Field}
400 4001102 Invalid Mandatory Field {Field}
401 4011100 Unauthorized. [Reason]
401 4011101 Invalid token (B2B)
403 4031101 Feature Not Allowed
403 4031118 Inactive Account
404 4041111 Invalid Account
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
14
HTTP Code Error Code Error Message (Indonesian)
409 4091100 Conflict
500 5001100 General Error
504 5041100 Timeout
Tech. Doc. OpenAPI-Account-Balance API v1.6| PT. Bank Central Asia, Tbk.
15
