Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-2642128296.2 KB
Participant Webhooks

Receives responses

Webhook for receiving responses (here receives 0210 (Transfer Response) and 0430 (Reversal Response) messages). The response is sent after the transfers/reversals have been received by the Gateway from the Switch (CCA).

post/responses

Request body

Example request

{
  "document": {
    "header": {
      "shinkansen_message_id": "0421c147-1d4a-484c-b855-9dcd8b9b67d9",
      "creation_date": "2022-04-08T18:25:45-04:00",
      "sender": "SHINKANSEN",
      "receiver": "TENPO"
    },
    "responses": [
      {
        "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": "Transaction approved successfully by the IFR host",
        "network_metadata": {
          "authorization_code": "000000",
          "operation_timestamp": "2025-10-02T14:42:54-03:00",
          "response_code": "000"
        }
      }
    ]
  }
}

Response

Message correctly received and accepted to be processed by Participant, this is a notification with the status of the transaction. If you dont receive the status oportuniy, you can request the status of the transaction in our endpoint (https://docs.shinkansen.tech/reference/get-transaction-status-by-id-3).

message_idstring uuid required

Message ID generated by Participant receiving the response

Example response

{
  "message_id": "903feb07-8a90-4e2a-ab4c-cec902903263",
  "responses": [
    {
      "response_id": "c5bae6b3-7c11-4b09-aad8-340ecc1a042c",
      "shinkansen_response_id": "a517a741-e84f-4ac1-8d9d-922162fc703b"
    },
    {
      "response_id": "6f913677-8d84-4dae-a30d-3639608ec3f3",
      "shinkansen_response_id": "4266ca42-b990-4f59-9b08-623660a72ee2"
    }
  ]
}