Retrieve a collection of accounts information
This API endpoint is designed to retrieve a collection of account information, providing a convenient way to access data related to multiple accounts within your system. The retrieved data includes fields such as "currency," "availableBalance," and "forecastedBalance."
Query Parameters
- page integer
Default value:
1
The collection page number
- itemsPerPage integer
Possible values:
<= 50
Default value:
30
The number of items per page
- type string
Possible values: [
normal
,collateral
,guarantee
]Select accounts by type
Responses
- 200
- 401
- 403
OK - The request was processed successfully.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- id integer
- type string
Possible values: [
normal
,collateral
,guarantee
] - currency string
- availableBalance number
- forecastedBalance number
- ]
[
{
"id": 1,
"type": "normal",
"currency": "CHF",
"availableBalance": "1000.00",
"forecastedBalance": "950.00"
}
]
Unauthorised -- Your access token is wrong.
- application/json
- Schema
- Example (from schema)
Schema
- type string
- title string
- detail string
{
"type": "string",
"title": "string",
"detail": "string"
}
Forbidden -- Access to the requested resource or action is forbidden.
- application/json
- Schema
- Example (from schema)
Schema
- type string
- title string
- detail string
{
"type": "string",
"title": "string",
"detail": "string"
}
Loading...