Logo
Swift API Sandbox Collections API Documentation

Payment Pre-Validation Consumer API

Number of APIs: 14


Move your app forward with the gpi APIs


1. Setup - Refresh Token

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



2. Error Scenario - Bad Request: request body missing account_identification param

POST {{baseUrl}}/payment/account-format



3. Teardown - Revoke Token

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



4. Success Scenario-accounts - Account matches but name does not match - Verify that a beneficiary account could be able to receive incoming funds

POST {{baseUrl}}/accounts/verification



5. Success Scenario-accounts - Validates the instructed institution as Payment Pre-validation Data Provider.

POST {{baseUrl}}/accounts/data-provider



6. Success Scenario-payment - Validates the account format.

POST {{baseUrl}}/payment/account-format



7. Success Scenario-payment - Validates the instructed institution as financial institution.

POST {{baseUrl}}/payment/financial-institution-identity



8. Success Scenario-payment - Validates the purpose code.

POST {{baseUrl}}/payment/purpose-code



9. Success Scenario-payment - Validates the payment purpose.

POST {{baseUrl}}/payment/payment-purpose



10. Success Scenario-payment - Validates the category purpose.

POST {{baseUrl}}/payment/category-purpose



ENDPOINTS