Retrieve account balance information
GET/accounts/:accountId/balance
Returns account balance information of the specified account.
- Returns the intraday booked balance (ITBD) for the current day, if called without a date.
- Returns the closing booked balance (CLBD) for a specific day, if called for a past date (i.e. the closing booked balance (CLBD) of that day). In case the specified day has not yet been finalized, the response code will be 202.
Request
Responses
- 200
- 202
- 204
- 400
- 401
- 403
- 404
- 405
- 500
- 501
- 502
- 503
- 504
Account balance information of the specified account.
Response Headers
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Accepted - Valid request, requested data not available yet. The request may be attempted at a later time.
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
No content - The server has successfully fulfilled the request. There is no content to return and never will be.
Response Headers
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Bad Request - The format of the request was invalid.
Examples:
-
InvalidPayload:
type: /problems/INVALID_PAYLOAD
title: Payload does not comply with API specification
detail: Malformed JSON
instance: path/to/corresponding/resource -
MissingId:
type: /problems/INVALID_PAYLOAD
title: The payload was not valid
detail: ID is missing
instance: path/to/corresponding/resource -
InvalidParameter:
type: /problems/MALFORMED_PAYLOAD
title: Invalid parameter values have been detected
detail: Data for date in the future cannot be requested
instance: path/to/corresponding/resource -
NoFutureDateSupported: type: /problems/MALFORMED_PAYLOAD title: Invalid parameter values have been detected detail: Data for date in the future cannot be requested instance: path/to/corresponding/resource
Response Headers
always en
i.e. "Bearer error='invalid_token'" according to RFC6750 section-3
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Unauthorized - Either no token or an invalid (e.g., token expired) token was received.
Response Headers
always en
i.e. "Bearer error='invalid_token'" according to RFC6750 section-3
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Forbidden - A valid OAuth Token was received, but access was denied. (Depending on the security requirements, providers can return 404 instead)
Examples:
-
InsufficientPrivileges:
type: /problems/INSUFFICIENT_PRIVILEGES
title: No privileges for the requested operation
detail: Insufficient privileges for the requested operation
instance: path/to/corresponding/resource -
ExpiredToken:
type: /problems/EXPIRED_TOKEN
title: The OAuth Token is expired
detail: The token is no longer valid
instance: path/to/corresponding/resource
Response Headers
always en
i.e. "Bearer error='invalid_token'" according to RFC6750 section-3
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Not Found - Either the endpoint does not exist or a requested resource is not yet available (e.g., account statements)
Examples:
-
InvalidAccounts:
type: /problems/INSUFFICIENT_PRIVILEGES
title: Insufficient privileges to access resource
detail: The provided token does not grant access to the requested account
instance: path/to/corresponding/resource -
InvalidToken:
type: /problems/INSUFFICIENT_PRIVILEGES
title: Insufficient privileges to access resource
detail: The provided token is not valid
instance: path/to/corresponding/resource -
WrongEndpointUrl:
type: /problems/TECHNICAL_ERROR
title: URL not found
detail: The requested endpoint does not exist
instance: path/to/corresponding/resource -
NoIntradayDataSupported:
type: /problems/NOT_IMPLEMENTED
title: Feature is not implemented
detail: This interface does not support intraday data instance: path/to/corresponding/resource
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Method Not Allowed - The method received in the request-line is known by the origin server but not supported by the target resource.
Examples:
- NotSupportedOperation:
type: /problems/WRONG_METHOD
title: This HTTP operation is not allowed on this endpoint
detail: Only GET operations are allowed
instance: path/to/corresponding/resource
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.
Examples:
-
TechnicalServerError:
type: /problems/TECHNICAL_ERROR
title: Technical error on server side
detail: Processing yielded a technical error
instance: path/to/corresponding/resource -
ResourceTooLarge:
type: /problems/RESOURCE_TOO_LARGE
title: Generated resource was too large
detail: The generated resource exceeded the size limit
instance: path/to/corresponding/resource
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Not Implemented - The server does not support the functionality required to fulfill the request.
Examples:
- EndpointNotImplemented:
type: /problems/NOT_IMPLEMENTED
title: Target endpoint is not implemented
detail: This endpoint is not implemented
instance: path/to/corresponding/resource
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Bad Gateway - The server received an invalid response from the upstream server.
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Service Unavailable - The server is currently unable to handle the request due to a temporary overload or scheduled maintenance.
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.
Gateway Timeout - The server did not get a response in time that it needed in order to complete the request.
Response Headers
always en
Client defined ID from request to correlate HTTP requests between a client and a server
Indicates whether the response was created by the bLink platform or by the provider.