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. 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

The service verifies that an account exists and is capable of receiving incoming funds. The service uses the beneficiary bank subscribed as data provider to perform the account verification that usually implies that the account is open, properly identified by the given number and, depending on the jurisdiction and market practices in use where the account is held, that the creditor name matches the name of the account holder. When the beneficiary bank did not subscribe as data provider, SWIFT will use pseudonymized account statistics to perform the account number verification that implies that the account exists and is likely to receive funds and the creditor name will not be verified. SWIFT and the beneficiary banks subscribed as data provider do not take liability for the response and do not provide any guarantee on the outcome of an actual transaction being sent to this account. The information provided is meant to be as accurate as possible at the time that the request was processed. The requester must pass the creditor name and the service provider can use this information as part of the verification or not.



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

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

Validates if the instructed institution is registered in the SWIFT reference data as Data Provider for Payment Pre-validation Data Provider API services. If no institution instructed for validation, provides all the registered Payment Pre-validation Data Providers.



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

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

The service performs the format validation of the instructed account identifier against all the format that apply to the instructed context (country and/or the financial institution that holds the account).



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

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

Validates if the instructed institution is registered in the SWIFT reference data as financial institution.



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

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

This request validates the payment purpose code against the list of payment purpose codes available in the SWIFT referential data for the instructed country.



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

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

This request validates the instructed information regarding the purpose of the payment (purpose code, purpose description) based on the specific requirements available in the SWIFT repository, for the instructed payment context (creditor country, creditor account currency and local payment market infrastructure).



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

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

This request validates the instructed category purpose code against the list of category purpose codes available in the SWIFT reference data for the instructed payment context (creditor country).



9. Success Scenario-payment - Validates the instructed amount.

POST {{baseUrl}}/payment/amount

Validates the instructed amount against the requirements available in the SWIFT reference data for the instructed country and payment market infrastructure.



10. Success Scenario-payment - Verify the payment for Rulebook eligibility and obtain payment predictability.

POST {{baseUrl}}/payment/eligibility-check

This service validates whether the given payment information satisfies the Rulebook eligibility requirements for the payment. The validation happens on the amount and the currency and whether a valid route exists for the payment to be processed as per the applicable Rulebook.

In addition to validating payment information, this eligibility service also returns payment predictability information such as routing options, end to end interbank fees and payment’s time to creditor, in order for financial institutions to support the payment end originators and increase the predictability of the execution of payments.

This service supports SWIFT Go only.

Note - The data in the request and response examples are fictitious.



11. Success Scenario-payment - Validates the payment instruction.

POST {{baseUrl}}/payment/payment-instruction

This service validates various elements of the payment instruction whether it is a partial or complete payment instruction. And provides a comprehensive response with the result of the individual validations performed as well as the overall result of the validation.



12. Error Scenario - Bad Request: invalid x-bic format

POST {{baseUrl}}/accounts/verification

The service verifies that an account exists and is capable of receiving incoming funds. The service uses the beneficiary bank subscribed as data provider to perform the account verification that usually implies that the account is open, properly identified by the given number and, depending on the jurisdiction and market practices in use where the account is held, that the creditor name matches the name of the account holder. When the beneficiary bank did not subscribe as data provider, SWIFT will use pseudonymized account statistics to perform the account number verification that implies that the account exists and is likely to receive funds and the creditor name will not be verified. SWIFT and the beneficiary banks subscribed as data provider do not take liability for the response and do not provide any guarantee on the outcome of an actual transaction being sent to this account. The information provided is meant to be as accurate as possible at the time that the request was processed. The requester must pass the creditor name and the service provider can use this information as part of the verification or not.



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

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

The service performs the format validation of the instructed account identifier against all the format that apply to the instructed context (country and/or the financial institution that holds the account).



14. Teardown - Revoke Token

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



ENDPOINTS