This API is to get account balances of a customer account
<br> <p><strong>OAuth2 related details</strong></p> <p><em>Token URL for Third Party Apps: https://sandboxapi.rakbank.ae/rb/api/v1/customer_signin/oauth2/token</em>
<br>scope : account_balances
<br>grant_type : authorization_code | refresh_token
</p> <br>
| Attachment | Size |
|---|---|
 Postman Collection | 1.03 KB |
Paths
/accounts/{account_id}/balances
Get account balances.
Account id of which balances are required. Only MASKED value to be passed. Masking logic to be followed : - First 4 and last 3 characters to be unmasked. All chracters in between to be masked by replacing with 'x'. e.g. 1234xxxxxx567
{
"maxLength": 13
}Unique Id sent by client. Value should be a unique identifier of the transaction in UUID format.
{
"maxLength": 50
}200 OK
Unauthorized Error
Forbidden Error
Error in case of Invalid request
Internal Sever Error
Definitions
Balance details
{
"properties": {
"type": {
"type": "string",
"enum": [
"LedgerBalance",
"UnclearedBalance",
"ClearedBalance",
"LienAmount+SystemReservedAmount",
"DrawingPower",
"AvailableBalance",
"EffectiveAvailableBalance",
"PoolBalance",
"LienAmount",
"LedgerBalanceHomeCurrency"
],
"description": "Holds balance type",
"example": "EffectiveAvailableBalance"
},
"balance": {
"description": "Holds account balance corresponding to 'type'",
"$ref": "#/definitions/value"
}
},
"additionalProperties": false,
"required": [
"type",
"balance"
]
}
Amount details
{
"properties": {
"amount": {
"type": "string",
"description": "Holds value of the amount (Number format - 20,4)",
"example": "2000.00"
},
"currency": {
"type": "string",
"description": "currency",
"example": "AED"
}
},
"additionalProperties": false,
"required": [
"amount",
"currency"
]
}
Response in case of error
{
"properties": {
"status": {
"type": "string",
"description": "HTTP Status"
},
"response_code": {
"type": "string",
"description": "API specific error code"
},
"property": {
"type": "string"
},
"response_message": {
"type": "string",
"description": "brief type of the error"
},
"description": {
"type": "string",
"description": "detailed description of the error"
}
},
"additionalProperties": false,
"required": [
"status",
"response_code",
"response_message"
]
}
Returns the collection of balances along with some meta data
{
"properties": {
"total_count": {
"type": "integer",
"description": "Holds the total no. of balances returned",
"example": 10
},
"href": {
"type": "string",
"description": "href value to fetch this resource",
"example": "https://sandboxapi.rakbank.ae/rb/api/v1/accounts/1234xxxxxx123/balances"
},
"balances": {
"type": "array",
"items": {
"$ref": "#/definitions/balances"
},
"description": "array of balances"
}
},
"additionalProperties": false,
"required": [
"href",
"balances"
]
}