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 API supports following functionalities:

• Credit Transfer Payment Initiation
• Direct Debit Initiation

Usage

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

Error Responses

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.

Query Parameters

Each URL query parameter specifies an API query parameter that must be URL encoded.

Contact Support: Name: Standards & Developer Hub Email: developer-support@swift.com

1. Setup - Refresh Token

POST https://sandbox.swift.com/oauth2/v1/token

---

2. payment-initiation-instructions-{uetr} - Clearing System Identification Request Raw

GET {{baseUrl}}/payment-initiation-instructions/:uetr

---

3. payment-initiation-instructions - Get Request Raw

GET {{baseUrl}}/payment-initiation-instructions

---

4. direct-debit-initiation-instruction-{uetr} - Create Direct Debit Initiation Request Raw

PUT {{baseUrl}}/direct-debit-initiation-instruction/:uetr

---

5. direct-debit-initiation-instruction-{uetr} - Direct Debit Initiation Request

GET {{baseUrl}}/direct-debit-initiation-instruction/:uetr

---

6. direct-debit-initiation-instruction - Direct Debit Initiation Request Collection Raw

GET {{baseUrl}}/direct-debit-initiation-instruction

---

7. Teardown - Revoke Token

POST https://sandbox.swift.com/oauth2/v1/revoke

---

8. payment-initiation-instructions-{uetr} - Clearing System Identification Request Raw

PUT {{baseUrl}}/payment-initiation-instructions/:uetr

---