Logo
Swift API Sandbox Collections API Documentation

GPI Case resolution API

Number of APIs: 28


1. Setup - Refresh Token

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



2. v6-Success Scenarios - Cancel case request.

PUT {{baseUrl}}/swift-apitracker-gcase/v6/cases/:uetr/:case_identification/cancel

Cancel case request.



3. v6-Success Scenarios - Assignee of the case accepts the request.

PUT {{baseUrl}}/swift-apitracker-gcase/v6/cases/:uetr/:case_identification/assign

This API is used by the assignee of the case to update the Tracker to confirm the acceptance of the case or that the case is assigned to another party in the chain.



4. v6-Success Scenarios - Conclude case.

PUT {{baseUrl}}/swift-apitracker-gcase/v6/cases/:uetr/:case_identification/conclude

After investigation is finished, the Assignee updates the Tracker. This API informs of a conclude investigation case.



5. v6-Success Scenarios - Create case request.

POST {{baseUrl}}/swift-apitracker-gcase/v6/cases

This API, initiated by the Assigner of the case, creates a case.



6. v6-Success Scenarios - Get changed case details.

GET {{baseUrl}}/swift-apitracker-gcase/v6/cases/changed?from_date_time=2021-07-10T00:00:00.000Z&to_date_time=2021-08-11T23:59:59.000Z&maximum_number=50

Retrieves the events for each investigation case, for all UETRs, that have been modified since a certain data and time.



7. v6-Success Scenarios - Get cases details.

GET {{baseUrl}}/swift-apitracker-gcase/v6/cases/:uetr

This API returns a list of cases linked to an UETR. Each case may include a list of events.



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

GET {{baseUrl}}/swift-apitracker-gcase/v6/cases/parties/:uetr

This API returns a list of cases linked to an UETR. Each case may include a list of events.



9. v6-Error Scenarios - Bad Request: Invalid uetr parameter

PUT {{baseUrl}}/swift-apitracker-gcase/v6/cases/:uetr/:case_identification/cancel

Cancel case request.



10. v6-Error Scenarios - Bad Request: Missing uetr value

POST {{baseUrl}}/swift-apitracker-gcase/v6/cases

This API, initiated by the Assigner of the case, creates a case.



11. v6-Error Scenarios - Not Found: Invalid uetr

GET {{baseUrl}}/swift-apitracker-gcase/v6/cases/:uetr

This API returns a list of cases linked to an UETR. Each case may include a list of events.



12. v6-Error Scenarios - Not Found: Invalid case_identification

PUT {{baseUrl}}/swift-apitracker-gcase/v6/cases/:uetr/:case_identification/conclude

After investigation is finished, the Assignee updates the Tracker. This API informs of a conclude investigation case.



13. v5-Success Scenarios - Cancel case request.

PUT {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases/:uetr/:case_identification/cancel

Cancel case request.



14. v5-Success Scenarios - Assignee of the case accepts the request.

PUT {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases/:uetr/:case_identification/assign

This API is used by the assignee of the case to update the Tracker to confirm the acceptance of the case or that the case is assigned to another party in the chain.



15. v5-Success Scenarios - Conclude case.

PUT {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases/:uetr/:case_identification/conclude

After investigation is finished, the Assignee updates the Tracker. This API informs of a conclude investigation case.



16. v5-Success Scenarios - Create case request.

POST {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases

This API, initiated by the Assigner of the case, creates a case.



17. v5-Success Scenarios - Get changed case details.

GET {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases/changed?from_date_time={{today}} - 30&to_date_time={{today}}&maximum_number=50

Retrieves the events for each investigation case, for all UETRs, that have been modified since a certain data and time.



18. v5-Success Scenarios - Get cases details.

GET {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases/:uetr

This API returns a list of cases linked to an UETR. Each case may include a list of events.



19. v5-Error Scenarios - from_date_time is greater than to_date_time

GET {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases/changed?from_date_time=2020-05-22T00:00:00.000Z&to_date_time=2020-05-12T00:00:00.000Z

Sandbox uetr = 46ed4827-7b6f-4491-a06f-b548d5a7512d



20. v5-Error Scenarios - Invalid request

PUT {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases/:uetr/:case_identification/cancel

Cancel case request.



21. v5-Error Scenarios - Mandatory Field Missing

POST {{baseUrl}}/swift-apitracker-gcase-pilot/v5/cases

This API, initiated by the Assigner of the case, creates a case.



22. v4-Success - Create unable to apply case

POST {{baseUrl}}/swift-apitracker/v4/cases

Sandbox uetr = 46ed4827-7b6f-4491-a06f-b548d5a7512d



23. v4-Success - assign case

PUT {{baseUrl}}/swift-apitracker/v4/cases/:uetr/:case_identification/assign

Sandbox uetr = 46ed4827-7b6f-4491-a06f-b548d5a7512d



24. v4-Success - conclude unable to apply case

PUT {{baseUrl}}/swift-apitracker/v4/cases/:uetr/:case_identification/conclude-unable-to-apply



25. v4-Success - cases details

GET {{baseUrl}}/swift-apitracker/v4/cases/:uetr

Sandbox uetr = 46ed4827-7b6f-4491-a06f-b548d5a7512d



26. v4-Success - changed case details

GET {{baseUrl}}/swift-apitracker/v4/cases/changed?from_date_time={{today}} -30&to_date_time={{today}}

Sandbox uetr = 46ed4827-7b6f-4491-a06f-b548d5a7512d



27. v4-Error - from_date_time is greater than to_date_time

GET {{baseUrl}}/swift-apitracker/v4/cases/changed?from_date_time=2020-05-22T00:00:00.000Z&to_date_time=2020-05-12T00:00:00.000Z

Sandbox uetr = 46ed4827-7b6f-4491-a06f-b548d5a7512d



28. Teardown - Revoke Token

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



ENDPOINTS