Swift API Sandbox Collections API Documentation
Get Request Raw
GET {{baseUrl}}/payment-initiation-instructions
Get all payment initiation instructions allows to retrieve all customer credit transfer initiations. 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 | |
requested-execution-date
|
string | Date and time at which the payment is executed and the cash is at the disposal of the credit account owner. The result will be filtered on requested_execution_date. 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 | |
instructed-amount
|
string | Specifies the amount as ordered in the payment initiation instruction before any deduction. | |
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. | |
Curl curl -X GET 'https://sandbox.swift.com/swift-payment-initiation/v1/payment-initiation-instructions?end-to-end-identification=<string>&creation-from-date=8104-02-29T04:16:47-01:51&creation-to-date=8104-02-29T04:16:47-01:51&requested-execution-date=8104-02-29T04:16:47-01:51&instructed-amount=0003309919349.46&offset=0&limit=25' -H 'X-Request-ID: <string>' -H 'X-UserContext: <string>' -H 'X-ServiceProvider: <string>' -H 'X-BIC: GEBABEBB' -H 'Accept: application/json' ENDPOINTS |