NICEPAY API
...
API SNAP BI
Payout API (Disbursement) - SN...

Balance Inquiry - API Payout (Disbursement) SNAP

7min

About Balance Inquiry - API Payout (Disbursement) SNAP



This API with SNAP standards uses to request check balance inquiry from an account on Disbursement process.



Balance Inquiry - API Payout (Disbursement) SNAP



Please request the access token firsthand before doing the authentication through the Request Access Token API - SNAP section.

API Endpoint

HTTP Method

POST

Description

Check Balance

Content-type

application/json



Request Balance Inquiry Payout (Disbursement) Header Parameter

Parameter

Type

Length

Mandatory

Description

Content-Type

String

127

Mandatory

Application/Json

Authorization

String

Variable

Mandatory

Bearer “accessToken

X-TIMESTAMP

String

25

Mandatory

Using ISO 8601 as timestamp format.

Transaction date time, in format YYYYMMDDTHH:mm:ss+07:00.

Time must be in GMT+7 (Jakarta time).

2022-03-21T10:11:40+07:00.

X-SIGNATURE

String

Variable

Mandatory

Signature will be generated automatically by Merchant

X-PARTNER-ID

String

20

Mandatory

Unique Partner ID, Partner ID = Client ID

X-EXTERNAL-ID

String

40

Mandatory

Unique messaging reference id generated by Merchant. Numeric String. Reference number that should be unique in every transaction

CHANNEL-ID

String

5

Mandatory

Device identification on which the API services is currently being accessed by the End User (Customer)



Request Balance Inquiry Payout (Disbursement) Body Parameter

Parameter

Type

Length

Mandatory

Description

accountNo

String

10

Mandatory

Merchant identifier that is unique per each Merchant

additionalInfo

Object

Variable

Optional

Additional information

"additionalInfo": { ... }

msId

String

20

Conditional

Merchant Seller ID



Response Balance Inquiry Payout (Disbursement) Parameter

Parameter

Type

Length

Mandatory

Description

responseCode

String

7

Mandatory

responseMessage

String

150

Mandatory

accountNo

String

10

Mandatory

Merchant identifier that is unique per each merchant

accountInfo

Array of Object





Account information

"accountInfo": [{ ... }]

availableBalance

Object

20

Mandatory

Balance Information

"availableBalance": {...}

value

String

12

Mandatory

Transaction amount, If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00

currency

String

3

Mandatory

Currency code based on ISO

additionalInfo

Object

Variable

Optional

Additional information

"additionalInfo": { ... }

msId

String

20

Optional

Merchant Seller Id



Sample Parameter

Request Body
Sample Response