Get information on account balance
This method retrieves the specific account balances by using the account ID included in the request.
Endpoint URL | Method | Authentication requirements |
|---|---|---|
| POST |
|
{
"dateTimeStamp": "2024-12-31T10:40:00+02:00",
"requestID": "df797efb-b588-4234-8ae1-5cb748559830",
"merchantId": "APIS-300505",
"banks": [
{
"code": "SVMB01",
"consentId":"urn:SVMB01:kac-5a166b7d-8cdb-443a-a67a-80ad7a5b95b3",
"accountId": "100004000000000000000002"
}
]
}JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
DateTimeStamp | Mandatory | Stamp denoting the date and time of the request | Date |
RequestID | Mandatory | Unique request identification | Alphanumeric |
merchantId | Mandatory | Unique merchant identification | Alphanumeric |
banks | Mandatory | Array of banks and consents | Object |
code | Mandatory | Unique bank identification code | Alphanumeric |
consentId | Mandatory | Unique consent identification | String |
accountId | Mandatory | Unique account identification as per the consent | String |
{
"success": true,
"payload": [
{
"code": "SVMB01",
"data": {
"accountId": "100004000000000000000002",
"balance": [
{
"amount": {
"amount": "7896.21",
"currency": "Currency"
},
"creditDebitIndicator": "Debit",
"type": "Type",
"dateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"creditLine": [
{
"included": true,
"type": "New_Line",
"amount": {
"amount": "5000.00",
"currency": "Currency"
}
}
]
}
]
},
"links": {
"self": "https://"
},
"meta": {
"totalPages": 0
}
}
]
}JSON Tag | Description |
|---|---|
success | Process success status represented as |
payload | Payload tag carrying response information |
code | Unique bank code identification |
data | Tag carrying account and balance data included in the response |
accountId | Unique account identification |
balance | Tag carrying account balance information |
amount | Tag carrying cash balance information |
amount | Cash balance amount |
currency | Default currency of the account in which the balance is indicated |
creditDebitIndicator | Indicates whether the balance is a credit or a debit balance |
type | Indicator type details |
dateTime | Date and time information of the indicator |
creditLine | Tag carrying credit line information |
included | Status of credit line as |
type | Type of credit line details |
amount | Tag carrying amount information of credit line |
amount | Available amount in credit line |
currency | Currency in which the credit line balance is indicated |
links | Redirect link |
self | Own link/URL details |
meta | Meta tag |
totalPages | Information displayed in terms of pages |