HTTP Method

POST

Endpoint

open/bi/private/1.0.0/balance-inquiry

SNAP Service Code

11

X-TIMESTAMP

String

M

25

The request timestamp. Formatted with "yyyy-MM-ddTHH:mm:ssZ". E.g. 2022-09-06T13:00:00+07:00

X-SIGNATURE

String

M

2048

The Merchant or Client generated signature. Using Asymmetric-Signature mechanism to get the token, encrypted with SHA256withRSA. 

e.g. 

stringToSign = <HTTP Method> + ":" + <Service Endpoint> + ":" + toLowercase(hexEncode(SHA256(minify(<Request Body>)))) + ":" + <X-TIMESTAMP>

X-SIGNATURE = SHA256withRSA(PrivateKey, stringToSign)

X-ORIGIN

String

M

256

Client’s host origin.

X-PARTNER-ID

String

M

32

The Merchant or Client Id. Provided by BNC.

X-EXTERNAL-ID

String

M

36

The Merchant External ID of request. 

e.g. 77778042022091500001

CHANNEL-ID

String

M

5

PJP Channel ID. 88881

partnerReferenceNo

String

O

64

Transaction identifier on service consumer system

2020102900000000000001

bankCardToken

String

C

128

Card tokenfor payment.must be filled if accountNo is null and Authorizatio n-Customer is Null

6d7963617264746f6b656e

accountNo

String

C

16

Bankaccount number.must be filled if bankCardTok en is Nulland Authorizatio n-Customer is Null

7382382957893840

balanceTypes

Array of String

O

BalanceTypes of this parameter doesn’texist, itsmean to inquiry all Balance Type on the account

["Cash","Coins"]

additionalInfo

Object

O

Additionalinformation

{

"submerchantflag":"1",

"channel":"mobilephone",

"deviceId":"12345679237",

"channel": "mobilephone",

"mchNm": "merchant xyz"

}

Note:

Flag of "submerchantflag":

"1" = Merchant (1^st tier merchant)

"2" = Merchant (2nd tier merchant)

responseCode

String

M

7

Response code

2001100

responseMessage

String

M

150

Response description

Request hasbeen processed successfully

referenceNo

String

O

64

Transactionidentifier on service provider system. Must be filled upon successful transaction

2020102977770000000009

partnerReferenceNo

String

O

64

Transactionidentifier on service consumer system

2020102900000000000001

accountNo

String

O

32

Registeredaccount number

115471119

name

String

O

140

Customer account name

JONOMADE

accountInfos

Array

O

balanceType

String

O

70

Account type name

Balance, OvoCash, ShopeeCoins

amount

Object

O

value

String(ISO4217)

M

16,2

Net amountof the transaction. If it’s IDR then value includes 2 decimal digits.e.g. IDR10.000,- will be placed with10000.00

200000.00

currency

String

M

3

Currency

IDR

floatAmount

Object

O

value

String(ISO4217)

M

16,2

Amount ofdeposit that is not effective yet (due toholiday, etc.).
If it’s IDR then value includes 2 decimal digits.e.g. IDR50.000,- will be placed with50000.00

50000.00

currency

String

M

3

Currency

IDR

holdAmount

Object

O

value

String(ISO4217)

M

16,2

Hold amount that cannot be used.If it’s IDRthen value includes 2 decimal digits.e.g. IDR20.000,- will be placed with20000.00

20000.00

currency

String

M

3

Currency

IDR

availableBalance

Object

O

value

String(ISO4217)

M

16,2

Account balance that can be used for financial transaction

130000.00

currency

String

M

3

Currency

IDR

ledgerBalance

Object

O

value

String(ISO4217)

M

16,2

Accountbalance atthe beginning of each day

30000.00

currency

String

M

3

Currency

IDR

currentMultilateralLimit

Object

O

value

String(ISO4217)

M

16,2

Credit limit of the account / plafon

10000.00

currency

String

M

3

Currency

IDR

registrationStatusCode

String

O

4

Customerregistration status

1

status

String

O

4

AccountStatus

1 = ActiveAccount

2 = ClosedAccount

4 = NewAccount

6 = Restricted Account

7 = FrozenAccount

9 = DormantAccount

1

additionalInfo

Object

O

Additional information

{

"submerchantflag":"1",

"channel":"mobilephone",

"deviceId":"12345679237",

"channel": "mobilephone",

"mchNm": "merchant xyz"

}

Note:

Flag of "submerchantflag":

"1" = Merchant (1^st tier merchant)

"2" = Merchant (2nd tier merchant)

2002400

200

any

00

Successful

Successful

4002400

400

any

00

Bad Request

General request failed error, including message parsing failed.

4002401

400

any

01

Invalid Field Format {field name}

Invalid format

4012400

401

any

00

Unauthorized. [reason]

General unauthorized error (No Interface Def, API is Invalid, Oauth Failed, Verify Client Secret Fail, Client Forbidden Access API, Unknown Client, Key not Found)

4012401

401

any

01

Invalid Token (B2B)

Token found in request is invalid (Access Token Not Exist, Access Token Expiry)

4012403

401

any

03

Token Not Found (B2B)

Token not found in the system. This occurs on any API that requires token as input parameter

4042408

404

any

08

InvalidMerchant

Merchant does not exist or status abnormal

4042411

404

any

11

Invalid Card/Accoun t/Customer [info]/Virtual Account

Card information may be invalid, or the card account may be blacklisted, or Virtual Account number maybe invalid.

4042412

404

any

12

Invalid Bill/Virtual Account [Reason]

The bill is blocked/suspended/not found.Virtual account is suspend/not found.

4042413

404

any

13

InvalidAmount

The amount doesn't match with what supposed to

4092401

409

any

01

Duplicate partnerReferenceNo

Transaction has previously been processed indicates the same partnerReferenceNo already success

5002402

500

Any

02

External Server Error

Backend system failure, etc

M

Mandatory

Mandatory

ME

Mandatory Equal

Mandatory Equal – value in the request and the response must be the same.

C

Conditional

Conditional

CE

Conditional Equal

Conditional Equal – value in the request and the response must be the same.

O

Optional

Optional