---
title: Balance Inquiry - API Payout (Disbursement) SNAP
slug: nicepay-api-snap-balance-inquiry-payout-disbursement
description: Informasi tentang Balance Inquiry - API Payout (Disbursement) SNAP yang terdapat pada sistem NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/4Nh16reBfAYcb7Tu9Khh7_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2023-02-17T11:11:53.000Z
---
# Tentang Balance Inquiry - API Payout (Disbursement) SNAP
***
API ini digunakan untuk mengajukan pemeriksaan *balance inquiry* dari suatu akun dalam proses Disbursement.
# Request Balance Inquiry - API Payout (Disbursement) SNAP
***
:::hint{type="warning"}
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian [Request Access Token API - SNAP](docId\:GcGqBIYXG1Etcd0Ji9cHX).
:::
| **Service Code** | `11` |
| ---------------- | ---------------------------------------------------------------------------------------------------------- |
| **API Endpoint** | [`/nicepay/api/v1.0/balance-inquiry`](https://www.nicepay.co.id/nicepay/api/v1.0/transfer/balance-inquiry) |
| **HTTP Method** | **POST** |
| **Description** | Check balance
|
| **Content-type** | `application/json` |
## Request Balance Inquiry Disbursement Header Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** | **Contoh** |
| --------------- | -------- | ---------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `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 by Merchant.
[Panduan X-Signature - Symmetric](docId\:UZex33ReLyENKOgbJJnYp) | |
| `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 | 20 | Mandatory | Unique Channel Merchant Credential ID Number
Client ID + "01" = Channel ID
`"IONPAYTEST" + "01" = "IONPAYTEST01"` | IONPAYTEST01 |
## Request Balance Inquiry Disbursement Body Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** |
| ---------------- | -------- | ---------- | ------------- | ------------------------------------------------------- |
| `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 Disbursement Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** |
| ------------------ | --------------- | ---------- | ------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `responseCode` | String | 7 | Mandatory | Refer to [General Response Code and Message - API SNAP](docId\:lKqJXSl5CMKdXYXxHYYSs) list |
| `responseMessage` | String | 150 | Mandatory | Refer to [General Response Code and Message - API SNAP](docId\:lKqJXSl5CMKdXYXxHYYSs) list |
| `accountNo` | String | 10 | Mandatory | Merchant identifier that is unique per each
merchant |
| `accountInfos` | Array of Object | | | Account information
`"accountInfos": [{ ... }]` |
| `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
:::CodeblockTabs
Request Body
```json
//HEADER SECTION
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJQREpCIiwiZXhwIjoiMjAyNC0wNi0yNVQwNTozMzowOFoifQ==.1is9UaIjMi_xowEX-IyuwNUy0ufkJR6jsLIDduKTca0=
X-TIMESTAMP: 2024-06-25T11:59:00+07:00
X-SIGNATURE: SeDmpduK08TVYkaZ83+OqVg2bjXX/oQT05wG4fUdRTDPYjMRcMLfDuQ2K3Q1AdXb/GzBm6qMlORyNfOQ8YgObQ==
X-PARTNER-ID :IONPAYTEST
X-EXTERNAL-ID: tXid202406251402271707638102
CHANNEL-ID: IONPAYTEST
{
"accountNo": "IONPAYTEST",
"additionalInfo": {
"msId": ""
}
}
```
Sample Response
```json
{
"responseCode": "2001100",
"responseMessage": "Successful",
"accountNo": "IONPAYTEST",
"accountInfos": [
{
"availableBalance": {
"value": "41570962.00",
"currency": "IDR"
}
}
],
"additionalInfo": {
"msId": ""
}
}
```
:::