Swift API Sandbox Collections API Documentation
Direct Debit Initiation Request Collection Raw
GET {{baseUrl}}/direct-debit-initiation-instruction
Get all direct debit initiation instructions allows to retrieve all direct debit initiation instruction. If the number of results exceeds the default limit, the response will be paginated. The operation allows filtering the results based on the creation from date and creation to date. The result is filtered based on creation_date_time
. The endpoint will return an empty array when no resource is found.
Body
PARAM
| Key | Datatype | Required | Description |
end-to-end-identification
|
string | Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. The consumer of the API can filter the response using end to end identification when the "uetr" is not available. | |
creation-from-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. The result will be filtered on creation_date_time. If a origin server do not support the time component, it can ignore the time component. Expressed in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS format. For example - 2021-04-01T12:01:01.000 or 2021-04-01T12:01:01 | |
creation-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. If a origin server do not support the time component, it can ignore the time component. Expressed in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS format. For example - 2021-04-01T12:01:01.000 or 2021-04-01T12:01:01 | |
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. |
HEADERS
| Key | Datatype | Required | Description |