Logo
Swift API Sandbox Collections API Documentation

GPI Stop and Recall API

Number of APIs: 13


Retrieve status and payment events from the tracker, and manage transaction cancellations.

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


1. v5-Cancel Transaction-Error - Return HTTP error code 5XX

PUT {{baseUrlv5}}/payments/:uetr/cancellation



2. v5-Transaction Cancellation Status-Success - Update the status of a cancelled transaction status RJCR CUST

PUT {{baseUrlv5}}/payments/:uetr/cancellation/status



3. v6-Success Scenarios - Stop And Recall Details.

GET {{baseUrlv6}}/payments/:uetr/cancellations



4. Authorization - Refresh Token

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



5. v6-Success Scenarios - Stop and Recall request.

PUT {{baseUrlv6}}/payments/:uetr/cancellation



6. v6-Success Scenarios - Stop and Recall Response.

PUT {{baseUrlv6}}/payments/:uetr/cancellation/status



7. v6-Success Scenarios - Get parties in a payment transaction and their case and/or stop and recall reachability status.

GET {{baseUrlv6}}/payments/:uetr/cancellations/parties



8. v6-Success Scenarios - Changed Stop And Recall Details.

GET {{baseUrlv6}}/payments/changed/cancellations?from_date_time=2019-01-10T00:00:00.000Z&to_date_time=2019-04-11T23:59:59.000Z&maximum_number=50&next=1



9. v6-Error Scenarios - Bad Request: Missing from value

PUT {{baseUrlv6}}/payments/:uetr/cancellation



10. v6-Error Scenarios - Not Found

GET {{baseUrlv6}}/payments/:uetr/cancellations



ENDPOINTS