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. Authorization - Refresh Token
POST https://sandbox.swift.com/oauth2/v1/token
2. v6-Success Scenarios - Stop and Recall request.
PUT {{baseUrlv6}}/payments/:uetr/cancellation
This API submits a payment stop and recall request via the tracker.
3. v6-Success Scenarios - Stop and Recall Response.
PUT {{baseUrlv6}}/payments/:uetr/cancellation/status
This API responds to a payment stop and recall request via the tracker.
4. v6-Success Scenarios - Stop And Recall Details.
GET {{baseUrlv6}}/payments/:uetr/cancellations
This API is a query to get detailed information regarding (a) Stop and Recall request(s) for a given payment. It requires the UETR to be known.
5. 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
Get parties in a payment transaction and their case and/or stop and recall reachability status.
6. 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
This API is a delta query to get all updated payment cancellation information starting from a given date and time. This API allows synchronization of a local database with the tracker database. The fromdatetime, todatetime parameters must be passed with each request. Alternatively, for paginated responses, only the parameter next must be passed.
7. v6-Error Scenarios - Bad Request: Missing from value
PUT {{baseUrlv6}}/payments/:uetr/cancellation
This API submits a payment stop and recall request via the tracker.
8. v6-Error Scenarios - Not Found
GET {{baseUrlv6}}/payments/:uetr/cancellations
This API is a query to get detailed information regarding (a) Stop and Recall request(s) for a given payment. It requires the UETR to be known.
9. v5-Cancel Transaction-Success - Request to cancel a transaction
PUT {{baseUrlv5}}/payments/:uetr/cancellation
This API informs the tracker about the cancellation of a given transaction
10. v5-Cancel Transaction-Error - Return HTTP error code 5XX
PUT {{baseUrlv5}}/payments/:uetr/cancellation
This API informs the tracker about the cancellation of a given transaction
11. v5-Transaction Cancellation Status-Success - Update the status of a cancelled transaction status RJCR CUST
PUT {{baseUrlv5}}/payments/:uetr/cancellation/status
This call informs the tracker about the updated status of a given payment
12. v5-Transaction Cancellation Status-Error - Unknown UETR
PUT {{baseUrlv5}}/payments/:uetr/cancellation/status
This call informs the tracker about the updated status of a given payment
13. Teardown - Revoke Token
POST https://sandbox.swift.com/oauth2/v1/revoke
ENDPOINTS