Retrieve accounts and balances.
GET {{baseUrl}}/swift-cash-management/v1/accounts?account-identification=&account-servicer=¤cy=EZS&offset=0&limit=25
The endpoint will retrieve all accounts with balance information for a specific account owner meeting the query parameters when supplied. The endpoint will return an empty array when no resource is found. Specifying Request Filter Parameters are specified in the form name=value. A parameter list is appended to a URI after a Note that the query parameters are not URL encoded for readability. Use of logical operator OR (account-identification DE27212110090000000235698765 or DE27212318890001010223463456) Use of logical operator AND (account-servicer and account-identification)?
. Multiple parameters are separated by &
.
Body
PARAM
| Key | Datatype | Required | Description |
account-identification
|
null | Unique and unambiguous identification for the account between the account owner and the account servicer. It can be in IBAN or proprietary format. RECOMMENDATION IN ORDER OF PREFERENCE: IBAN - International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. When available IBAN must be specified for instance endpoint or hyper link to work. Other - Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. In the absence of IBAN, this must be an unique account identification used for routing of the payment to the account via clearing system. A format which is agreed between the account owner and the account servicer. For example a SWIFT BIC/Branch Code and Account number. | |
account-servicer
|
null | Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. Valid BICs for financial institutions are registered and published by the ISO 9362 Registration Authority in the ISO directory of BICs, and consist of eight (8) or eleven (11) contiguous characters. Usage - The parameter provides the ability to a consumer requesting account related to a specific BIC. | |
currency
|
string | Specifies the currency of the account. The Currency Code must be registered, or have already been registered with the ISO 4217 Maintenance Agency, consist of three (3) contiguous letters, and may be or not be withdrawn on the day the message containing the Currency is exchanged. | |
offset
|
number | Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. | |
limit
|
number |