Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-2642128296.2 KB
Transactions & Responses

Returns the transaction response of a non-pending transaction

Can be used when the participant needs to re-check the response for a given transaction (e.g: if an unexpected error means they lost a response)

get/transactions/{shinkansen_id}/response

Response

The response of a non-pending transaction.

transaction_type'transfer' | 'reversal' required

The type of transaction. For the transfer product it's always "transfer".

transaction_idstring uuid required

The transaction ID that was included in the original request sent to Shinkansen.

shinkansen_transaction_idstring uuid required

The transaction ID assigned by Shinkansen.

shinkansen_transaction_status'ok' | 'error' | 'pending' required

The status of the transaction as assigned by Shinkansen. It can be one of the following:

  • ok: The transaction was successful
  • error: The transaction failed.
  • pending: The transaction is pending. (for consultation purposes)
shinkansen_response_idstring uuid required

The unique ID associated with this response in the Shinkansen network.

response_status'approved' | 'error_reversal_insufficient_balance' | 'error_creditor_account_over_limits' | 'error_creditor_account_not_found' | 'error_creditor_fi_offline' | 'error_creditor_fi_timeout' | 'error_creditor_account_closed' | 'error_creditor_rut_invalid' | 'error_ifr_service_unavailable' required

This is a reduced list of the possible responses from the underlying network. The complete list can be found in the Shinkansen documentation.

  • approved: Approved Transaction/Reversal
  • error_reversal_insufficient_balance: Rejected due to insufficient balance. (for reversals)
  • error_creditor_account_over_limits: Destination account restricted for deposits.
  • error_creditor_account_not_found: Destination account not found.
  • error_creditor_fi_offline: IFR host unavailable.
  • error_creditor_fi_timeout: Timeout at destination bank.
  • error_creditor_account_closed: Destination account is closed.
  • error_creditor_rut_invalid: Invalid beneficiary RUT.
  • error_ifr_service_unavailable: Unspecified error.
response_messagestring required

A message further describing the status of the transaction from the underlying network.

Example response

{
  "transaction_type": "transfer",
  "transaction_id": "3c11df48-dfab-41eb-a3c1-b9f90a0da063",
  "shinkansen_transaction_id": "455765a6-0b51-4e48-8827-06192824a1ab",
  "shinkansen_transaction_status": "ok",
  "shinkansen_response_id": "8d267f06-84c8-448b-bebb-1eaf4c60b986",
  "response_status": "approved",
  "response_message": "Approved Transaction",
  "network_metadata": {
    "operation_timestamp": "2022-04-08T18:25:45-04:00",
    "authorization_code": "000000",
    "response_code": "000"
  }
}