Get statement with transaction.
GET {{baseUrl}}/swift-cash-management/v1/accounts/:account-identification/statements?offset=0&limit=1000&from-date=2021-09-15&to-date=2021-09-15
The API endpoint is used by the consumer of the API to get the entries booked to the account, and the balance information on the account at a given period in time. Provides underlying details of transactions that have been included in the entry. Corporate can receive information from their bank(s) about the activity happening on a given account for cash management balance reporting. This will include all entries booked to the account for the specified period. It contains information on booked entries only.
Response: The endpoint will return HTTP response code 404 if the requested account does not exists. The endpoint will return an empty array if the requested account exists but no statement found or no statement found by the query criteria.
Body
PARAM
| Key | Datatype | Required | Description |
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 | The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. | |
from-date
|
string | (Required) The query parameter can use either a specific creation_from_date or date range in the form of creation_from_date and creation_to_date. The result will be filtered on creation_date_time. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage - The parameter is mandatory and default behaviour is to provide the end of day statement for the current date. When used in conjunction with statement-period (weekly, monthly, yearly), returns the statement where the from date fall within that period. | |
to-date
|
string | The query parameter can use either a specific creation_from_date or date range in the form of creation_from_date and creation_to_date. For a specific date, creation_to_date must not be provided. The result will be filtered on creation_date_time. Expressed in the YYYY-MM-DD format. The date cannot be in the future. Usage - When used in conjunction with the statement-period (weekly, monthly, yearly) and from date, the endpoint returns the statement where the from date to date fall within that period. The parameter must not be used for the statement period EODY. If supplied, the parameter will be ignored. |
HEADERS
| Key | Datatype | Required | Description |
X-Request-ID
|
Curl curl -X GET 'https://sandbox.swift.com/swift-cash-management/v1/accounts/:account-identification/statements?offset=0&limit=1000&from-date=2021-09-15&to-date=2021-09-15?offset=0&limit=1000&from-date=2021-09-15&to-date=2021-09-15' -H 'X-Request-ID: do deserunt' -H 'X-UserContext: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF-e14JmCtQ' -H 'X-BIC: DEUTDEFF' -H 'Accept: application/json' ENDPOINTS |