v1

latestOpenAPI 3.0.0Proprietary2026-07-2642128296.2 KB

Transactions & Responses

Get a transfer status

Returns the current state of an outbound transfer and its full reversal history as stored in the Gateway. This endpoint queries gateway state only; it does not send a live consult to the switch network.

Use it when the participant needs to confirm transfer and reversal outcomes (for example after a webhook timeout or during SAF retries). The root-level reversed boolean indicates whether the transfer was effectively reversed; reversals lists every reversal attempt with its own status and CCA response.

get/transfers/{shinkansen_id}/status

Response

The current status and detail of a transfer in the Gateway API, including transfer fields at the root, the reversed flag, and the full reversals history.

transaction_idstring uuid required

Participant transaction ID (the ID sent in the original transfer request).

shinkansen_transaction_idstring uuid required

Shinkansen internal transaction ID (returned as shinkansen_transaction_id in the transfer ACK).

status'pending' | 'ok' | 'error' required

Gateway transaction status.

response_statusstring nullable required

Network response code for the transfer (for example approved), or null while pending. See Response codes.

amountstring required

Transfer amount.

currencystring required

Currency code.

referencestring nullable required

Transfer reference from the original request.

tracenumberstring nullable required

IFO trace number (12-digit string), when available.

switch_timestampstring nullable required

Local Chile timestamp from the switch/CCA for the transfer, when available.

gateway_timestampstring date-time required

UTC timestamp when the gateway accepted the transfer.

reversedboolean required

true when at least one reversal for this transfer was applied (status ok / approved by CCA). false when there are no reversals, or every reversal is still pending or ended in error. Clients should use this field instead of inferring reversal outcome from reversals.

Example response

{
  "transaction_id": "957448bf-2d65-4384-a0cd-2a3fbadedd93",
  "shinkansen_transaction_id": "bddc94cb-506a-4dad-a3e1-be52e3454ec6",
  "status": "ok",
  "response_status": "approved",
  "amount": "70000",
  "currency": "CLP",
  "reference": "Shinkansen Test",
  "tracenumber": "000000000293",
  "switch_timestamp": "2026-06-29T11:58:15",
  "gateway_timestamp": "2026-06-29T15:58:15Z",
  "reversed": true,
  "reversals": [
    {
      "reversal_id": "ffb64ae1-bf39-4a66-8858-552f37176c44",
      "shinkansen_reversal_id": "bacf2eba-7dfa-46e8-b7b1-8966681da8b2",
      "reversal_type": "reversal_conditional",
      "status": "ok",
      "response_status": "approved",
      "tracenumber": "000000000293",
      "received_at": "2026-06-29T15:58:29Z",
      "switch_timestamp": "2026-06-29T11:58:29"
    }
  ]
}