- Balance Inquiry
- Account
Balance Inquiry
Account
Retrieve detailed account information including balances.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/balance-inquiry/{account_id} | json | OAuth 2.0 with Access Token |
Request Details
Headers Structure
| Field | Value | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|---|
| X-PARTNER-ID | api_key | Alphanumeric | Mandatory | API key obtained from the merchant dashboard. | b3ed7d4b-a96c-6c08-b3c7-12c3124242d9 | |
| Accept | application/json | Alphabetic | Mandatory | Specifies JSON as the expected response format. | application/json | |
| Authorization | Bearer {bearerToken} | Alphanumeric | Mandatory | Bearer token obtained from the get access token endpoint. | Bearer eyJ0eXAiOiJKV1{…} |
Response Details
Response Structure
| Field | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|
| status | Numeric | Mandatory | 3 | HTTP Status Code | 200 |
| success | Boolean | Mandatory | 1 | 2xx is true. 4xx-500 is false. | true |
| data | Array Object | Conditional | - | - | - |
| > account_id | Numeric | Mandatory | - | Id of the account | 374564354 |
| > pending_balance | Object | Mandatory | - | The amount of savings that cannot be used | - |
| >> value | Numeric | Mandatory | - | Amount of Pending balance | 9000000 |
| >> currency | Alphabetic | Mandatory | - | Currency type | IDR |
| > held_balance | Object | Mandatory | - | The amount of savings that cannot be used | - |
| >> value | Numeric | Mandatory | - | Amount of Held balance | 9000000 |
| >> currency | Alphabetic | Mandatory | - | Currency type | IDR |
| > available_balance | Object | Mandatory | - | Account balance that can be used for transactions | - |
| >> value | Numeric | Mandatory | - | Amount of available balance | 9000000 |
| >> currency | Alphabetic | Mandatory | - | Currency type | IDR |
| > balance | Object | Mandatory | - | Available_balance + pending_balance + held_balance | - |
| >> value | Numeric | Mandatory | - | Total balance | 9000000 |
| >> currency | Alphabetic | Mandatory | - | Currency type | IDR |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": {
"held_balance": {
"value": "0.00",
"currency": "IDR"
},
"available_balance": {
"value": "7500.00",
"currency": "IDR"
},
"pending_balance": {
"value": "0.00",
"currency": "IDR"
},
"balance": {
"value": "7500.00",
"currency": "IDR"
},
"account_id": "01K8N5ZNJH8MPGAK9QM080CXW8"
}
}Error: This is an example of an unsuccessful request.
{
"status": 401,
"success": false,
"error": {
"code": 401,
"message": "Unauthorized partner, please sign in"
}
}