Payment Initiation API
Number of APIs: 8
The payment initiation API is used by an initiating party to a debtor agent to provide a payment instruction to request movement of funds from the debtor account to a creditor account. The direct debit instruction is used by a creditor to request movement of funds from the debtor account to creditor account. The payment initiation instruction contains customer credit transfer instructions. The API is used to exchange:
* A single instance of a credit transfer initiation
* Payment instructions that result in book transfers at the debtor agent or payments to another financial institution
* Payment instructions that result in an electronic cash transfer to the creditor account
* A single instance of a direct debit collection initiation The API uses common HTTP status codes in the response header to indicate success or failure. Specific error code and description will be returned in the custom error schema. Each URL query parameter specifies an API query parameter that must be URL encoded. Contact Support:
Name: Standards & Developer Hub
Email: developer-support@swift.comThe API supports following functionalities:
Usage
Error ResponsesQuery Parameters
1. Setup - Refresh Token
POST https://sandbox.swift.com/oauth2/v1/token
2. payment-initiation-instructions-{uetr} - Clearing System Identification Request Raw
PUT {{baseUrl}}/payment-initiation-instructions/:uetr
Create a payment initiation instruction. The identifier of the instruction is uetr
. The request accept an instruction which will be validated and created. On successful creation, the instruction can be retrieved using the uetr
. The method is use to create a payment instruction as the consumer will supply the resource identifier (uetr) and the method is idempotent. This operation only supports creation of resource. The operation cannot be used to replace the resource once the resource is created.
3. payment-initiation-instructions-{uetr} - Clearing System Identification Request Raw
GET {{baseUrl}}/payment-initiation-instructions/:uetr
Use this operation to retrieve a payment initiation instruction by ID (UETR).
4. payment-initiation-instructions - 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.
5. direct-debit-initiation-instruction-{uetr} - Create Direct Debit Initiation Request Raw
PUT {{baseUrl}}/direct-debit-initiation-instruction/:uetr
Payment, initiated by the creditor, to debit a debtor's account in favour of the creditor. The Direct Debit Initiation Instruction is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request funds from the debtor account to a creditor.
6. direct-debit-initiation-instruction-{uetr} - Direct Debit Initiation Request
GET {{baseUrl}}/direct-debit-initiation-instruction/:uetr
Use this operation to retrieve a direct debit initiation instruction by ID (UETR).
7. direct-debit-initiation-instruction - 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.
8. Teardown - Revoke Token
POST https://sandbox.swift.com/oauth2/v1/revoke
ENDPOINTS