Description and Details
This API retrieves the balance details of a user’s account using the specified account ID or related identifiers. It is part of the AISP (Account Information Service Provider) functionality in an Open Banking framework, enabling TPPs (Third Party Providers) to access up-to-date balance information for informed financial services.
Endpoint
https://api-dev-isolution.xyz/balanceinquiry
VERB Method
POST
Request Headers Parameters
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json | Specifies the media type of the resource |
| Accept | / | Accepts all response types |
| Cache-Control | no-cache | Disables caching |
| User-Agent | PostmanRuntime/... | Client agent string |
| Connection | keep-alive | Keeps TCP connection open |
| Host | [Auto-calculated] | Set by HTTP client |
| Postman-Token | [Auto-generated] | Used for request tracing in Postman |
Body Request Parameters
| Parameter | Type | Description |
|---|---|---|
| accountId | string | The unique ID of the account to query balance |
| customerId | string | Customer’s unique ID |
| productType | string | Type of banking product (e.g., SAVINGS) |
| productName | string | Name of the banking product |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| availableBalance | string | Current available balance in the account |
| currency | string | Currency type (e.g., USD) |
| accountAlias | string | Account nickname or user-defined name |
| message | string | Status message (e.g., "Balance retrieved") |
| meta | object | Contains code and message |
| meta.code | string | HTTP-like status code (e.g., "200") |
| meta.message | string | Description of result status |
HTTP Codes
| Code | Meaning |
|---|---|
| 200 | OK – Balance retrieved successfully |
| 400 | Bad Request – Invalid or missing fields |
| 401 | Unauthorized – Invalid token/headers |
| 404 | Not Found – Account ID not found |
| 500 | Internal Server Error – Server failure |