Get statement entries with statement batch
GET {{baseUrl}}/swift-cash-management/v1/accounts/:account-identification/statement-lines?offset=0&limit=25&creation-from-time=20:28:47&creation-to-time=20:28:47&credit-debit-code=CRDT
The API endpoint is used by the consumer of the API to get entries reported to the account. This will include all debit and/or credit entries booked to the account for the specified period to enable intraday reconciliation. Includes pending and booked items.
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 entries found or no entries found by the query criteria. For example
statement_line
: [].
Request Params
| 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. | |
creation-from-time | string | (Required) A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are aligned with ISO 8601. | |
| Note on the time format: |
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
The result will be filtered on creation_date_time.
|
| creation-to-time | string | | A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are aligned with ISO 8601.
Note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
The query parameter can use either a specific creation_from_time or time range in the form of creation_from_time and creation_to_time. For upto a requested time, creation_to_time must not be provided. The result will be filtered on creation_date_time.
|
| credit-debit-code | string | | Specifies if an operation is an increase or a decrease.
*CRDT-Operation is an increase.
*DBIT-Operation is a decrease.
|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Request-ID | string | Specify an unique end to end tracking request ID. The element will be populated by the SWIFT API gateway | |
X-ServiceProvider | string | Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. | |
X-BIC | string | (Required) Specify the BIC of the provider of the service. The identification will be used by the API Gateway to forward the request to service provider. |