Logo
Swift API Sandbox Collections API Documentation

GPI Financial Institutions Transfer API

Number of APIs: 4


About this document

These technical specifications provide information about how to use APIs to access and update the Payment transaction information, it also gives the necessary information to assess the business API..

This document is for the following audience:

  • Business analysts to understand the functionality of the API

  • Business architects to understand the functionality of the API and how to integrate the use of the API within their organisation

  • Software developers of applications using the API to assess the complexity of the API

v5.0.1 Release Notes

  • New element TransactionStatusDate
  • Number of reject return reasons increased.
  • InstructedAgent can be identified with a ClearingSystemMemberIdentification (alternative to BIC)
  • All amounts are 18 digits
  • All identifications are 35 characters

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


1. Authorization - Refresh Token

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



2. Success Scenarios - Status Confirmations(if transaction_status =ACSPand transaction_status_reason=G002)

PUT {{baseUrl}}/payments/:uetr/status

This API is a status confirmation update to inform the tracker about the updated status of a given payment



3. Error Scenarios - error500s

PUT {{baseUrl}}/payments/:uetr/status

This API is a status confirmation update to inform the tracker about the updated status of a given payment



4. Teardown - Revoke Token

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



ENDPOINTS