Notifications

Receives notifications from Shinkansen

post

Webhook for receiving notifications

Authorizations

Shinkansen-JWS-Signature

Shinkansen-JWS-SignaturestringRequired

Not really an API Key, but a JWS Detached signature of the whole body.

Body

application/json

Notifications, sent by Shinkansen

Responses

200

Message correctly received. Does NOT mean the transaction was succesful. Further responses might be sent back on another message.

No content

400

Invalid message (e.g: invalid signature)

409

Message ignored, because it was already seen and processed before by the receiver. Typically happens when a message is re-sent because the sender isn't sure if it was correctly received (e.g: network failure when the 2xx response was in flight)'

post

/notifications

HTTPcURLJavaScriptPython

POST /notifications HTTP/1.1
Host: example.customer.url
Shinkansen-JWS-Signature: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1278

{
  "document": {
    "header": {
      "message_id": "d562602e-2fec-4072-81a0-d84b6b0ea5d3",
      "shinkansen_message_id": "0421c147-1d4a-484c-b855-9dcd8b9b67d9",
      "creation_date": "2023-08-11T08:14:45-04:00",
      "sender": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN"
      },
      "receiver": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "BUDA"
      }
    },
    "notifications": [
      {
        "notification_id": "c5599fc3-4408-452b-9c49-da09f646e76f",
        "original_notification_id": "xyz123",
        "notification_date": "2023-08-11T08:14:41.078Z",
        "transaction_date": "2023-08-11T08:14:40.078Z",
        "transaction_accounting_id": "xyz1234567890",
        "transaction_accounting_date": "2023-08-12T09:00:00.000Z",
        "notification_type": "payin",
        "referenced_shinkansen_transaction_ids": [
          "ccf5b5b0-5b9b-4b5a-9c1a-7b1b5b9b5b9b"
        ],
        "referenced_shinkansen_notification_ids": [
          "c5599fc3-4408-452b-9c49-da09f646e76f"
        ],
        "currency": "CLP",
        "amount": "1000000.000000",
        "description": "Abono a cuenta CLP",
        "debtor": {
          "name": "Matheiu Van Der Poel",
          "identification": {
            "id_schema": "CLID",
            "id": "78527970-0"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "SCOTIABANK_CL"
          },
          "account": "1234567890"
        },
        "creditor": {
          "name": "Buda SpA",
          "identification": {
            "id_schema": "CLID",
            "id": "88888888-8"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "SCOTIABANK_CL"
          },
          "account": "012180000118901234"
        }
      }
    ]
  }
}

No content