Swift API Sandbox Collections API Documentation
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.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"uetr": "97ed4827-7b6f-4491-a06f-b548d5a7512d",
"transaction_status": "ACSP",
"transaction_status_reason": "G000",
"transaction_cancellation_status": "RJCR",
"cases": "1",
"initiation_date_time": "2022-08-30T09:00:00.0Z",
"last_update_date_time": "2022-08-30T11:00:02.0Z",
"cancellation_event": [
{
"network_reference": "220830SNFSUS30XXXX0003000007",
"message_name_identification": "192",
"service_level": "G002",
"tracker_event_type": "CTCA",
"valid": true,
"case_identification": "case123",
"original_instruction_identification": "ABC123",
"cancellation_request_details": [
{
"cancellation_reason_information": "DUPL",
"indemnity_agreement": "INDM",
"creator": "GPIABICXXXX"
}
],
"from": "GPIBBICXXXX",
"to": "TRCKCHZZXXX",
"sender_acknowledgement_receipt_date_time": "2022-08-30T10:00:01.0Z",
"event_creation_date_time": "2022-08-30T10:00:02.0Z"
},
{
"network_reference": "220830TRCKCHZZGXXX0001000002",
"message_name_identification": "199",
"service_level": "G002",
"tracker_event_type": "CTTS",
"valid": true,
"cancellation_request_tracking_status": [
"S000"
],
"from": "TRCKCHZ0XXX",
"to": "GPIBBICXXXX",
"sender_acknowledgement_receipt_date_time": "2022-08-30T10:00:03.0Z",
"event_creation_date_time": "2022-08-30T10:00:03.0Z"
},
{
"network_reference": "220830TRCKCHZZGXXX0001000002",
"message_name_identification": "199",
"service_level": "G002",
"tracker_event_type": "CTTS",
"valid": true,
"cancellation_request_tracking_status": [
"S001"
],
"from": "TRCKCHZ0XXX",
"to": "GPIBBICXXXX",
"sender_acknowledgement_receipt_date_time": "2022-08-30T10:00:04.0Z",
"event_creation_date_time": "2022-08-30T10:00:04.0Z"
},
{
"network_reference": "190830SNFSUS30XXXX0003000007",
"message_name_identification": "192",
"service_level": "G002",
"tracker_event_type": "CTCA",
"valid": true,
"case_identification": "case123",
"original_instruction_identification": "ABC123",
"cancellation_request_details": [
{
"cancellation_reason_information": "DUPL",
"indemnity_agreement": "INDM",
"interbank_settlement_date": "2022-08-30T00:00:00.000Z",
"interbank_settlement_amount": {
"currency": "USD",
"amount": "1000"
},
"creator": "GPIABICXXXX"
}
],
"cancellation_request_tracking_status": [
"S001"
],
"from": "TRCKCHZZXXX",
"to": "GPICBICXXXX",
"sender_acknowledgement_receipt_date_time": "2022-08-30T10:00:05.0Z",
"event_creation_date_time": "2022-08-30T10:00:07.0Z"
},
{
"network_reference": "220830TRCKCHZZGXXX0001000002",
"message_name_identification": "199",
"service_level": "G002",
"tracker_event_type": "CTTS",
"valid": true,
" Curl curl -X GET 'https://sandbox.swift.com/swift-apitracker-gsrp/v6/payments/:uetr/cancellations' -H 'Accept: application/json' ENDPOINTS |