v1

latestOpenAPI 3.0.0Proprietary2026-07-2642128296.2 KB
Participant Webhooks

Receives transfers

Webhook for receiving incoming transfer transactions from network (CCA) in this case the Participant is the IFR.

post/transactions

Request body

Example request

{
  "document": {
    "header": {
      "shinkansen_message_id": "014a74cb-597c-46a1-8217-63e58a336b0d",
      "creation_date": "2022-04-08T18:25:43-04:00",
      "sender": "SHINKANSEN",
      "receiver": "TENPO"
    },
    "transactions": [
      {
        "transaction_type": "transfer",
        "shinkansen_transaction_id": "8af773eb-761d-44a5-86a9-1435189d215c",
        "currency": "CLP",
        "amount": "30000",
        "reference": "A simple TEF operation",
        "debtor": {
          "name": "Romulo Gallegos",
          "identification": {
            "id_schema": "CLID",
            "id": "12383287-6"
          },
          "financial_institution": "SCOTIABANK_CL",
          "account": "1513523451",
          "account_type": "current_account",
          "email": "romulo.gallegos@shinkasen.finance",
          "customer_type": "individual"
        },
        "creditor": {
          "name": "Ursula De Tena",
          "identification": {
            "id_schema": "CLID",
            "id": "12383287-3"
          },
          "financial_institution": "TENPO",
          "account": "1513523451",
          "account_type": "current_account",
          "email": "ursula.detena@example.org"
        },
        "network_metadata": {
          "network_transmission_datetime": "2022-04-08T18:25:45-04:00",
          "network": "CCA",
          "network_identifier": "74700000000000120240115103000",
          "network_identifier_info": "[Origin FI: 747]-[Trace Number: 000000000001]-[Local Date: 0115]-[Local Time: 103000]",
          "mac_1": "ABC123",
          "mac_2": "DEF456",
          "tracenumber": "000000000001",
          "originator_ipv4": "100.200.3.4",
          "debtor_has_made_transfers_to_creditor_before": false,
          "operation_number": "1007700809165",
          "customer_segment_code": "001",
          "filler": "Field free to be used"
        }
      }
    ]
  }
}

Response

Message correctly received and accepted to be processed by Participant, this does NOT mean the transaction was succesful. You process asynchronously the transaction and send the status of the transaction in our endpoint (https://docs.shinkansen.tech/reference/post-transfer-response).

message_idstring uuid required

Message ID generated by Participant receiving the transfer

Example response

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