---
title: "Receives notifications from Shinkansen"
method: POST
path: "/notifications"
tags: ["Metadata Notifications"]
---

# Receives notifications from Shinkansen

`POST /notifications`

## Request

- Base URL: `https://example.customer.url`
- URL: `https://example.customer.url/notifications`
- Auth: API key in header `Shinkansen-JWS-Signature`

Webhook for receiving metadata notifications related to payout transactions

## Request body

- ParticipantMetadataNotificationMessage: Metadata notifications related to payouts, sent by Shinkansen
  - `document` object, required: Envelops the message content
    - `header` ForwardedMessageHeader, required: Header with meta-data of the forwarded message
      - `message_id` string, uuid, required: UUID Unique identifier of the message. Generated by the participant initiating the transactions, sending the responses or sending notifications.
      - `shinkansen_message_id` string, uuid, required: UUID Unique identifier of the message. Generated by Shinkansen.
      - `creation_date` string, date-time, required: Creation date of the message in ISO 8601 format. Generated by the participant initiating the transactions (or sending the responses).
      - `sender` object, required: The identifier for a financial institution
        - `fin_id_schema` string, required: Identification schema for financial institution, namely, any participant in Shinkansen Network. Use `"SHINKANSEN"` for Shinkansen's native network ids and full support on any participant and service of the Shinkansen network. Other schemas might be used when interfacing with other networks but they are *not* recommended unless you *really* know what you are doing or have been explicitly instructed to do so by Shinkansen.
        - `fin_id` string, required: Identification according to schema. When the `"SHINKANSEN"` schema is used (as recommended), this is the ID assigned by Shinkansen to the participant in the network. In the context of the `header`, it refers to the Shinkansen network participant that sends (Sender) or receives (Receiver) the message. In the context of the `transactions`, it refers to the financial institution from which the resources leave or where the resources arrive. The ID assigned by Shinkansen to the financial institution can be found in https://docs.shinkansen.tech/docs/instituciones-financieras. When sending a transaction to Shinkansen, this value must always be SHINKANSEN. When sending a payout order to Shinkansen Treasury, this value must be SHINKANSEN_TREASURY
      - `receiver` object, required: The identifier for a financial institution
        - `fin_id_schema` string, required: Identification schema for financial institution, namely, any participant in Shinkansen Network. Use `"SHINKANSEN"` for Shinkansen's native network ids and full support on any participant and service of the Shinkansen network. Other schemas might be used when interfacing with other networks but they are *not* recommended unless you *really* know what you are doing or have been explicitly instructed to do so by Shinkansen.
        - `fin_id` string, required: Identification according to schema. When the `"SHINKANSEN"` schema is used (as recommended), this is the ID assigned by Shinkansen to the participant in the network. In the context of the `header`, it refers to the Shinkansen network participant that sends (Sender) or receives (Receiver) the message. In the context of the `transactions`, it refers to the financial institution from which the resources leave or where the resources arrive. The ID assigned by Shinkansen to the financial institution can be found in https://docs.shinkansen.tech/docs/instituciones-financieras. When sending a transaction to Shinkansen, this value must always be SHINKANSEN. When sending a payout order to Shinkansen Treasury, this value must be SHINKANSEN_TREASURY
    - `notifications` MetadataNotification[], required: One or more notifications with metadata related to payouts.
      - `notification_id` string, required: The unique identifier of the notification
      - `notification_type` string, required: The type of the notification
      - `payment_operator_metadata` object, required: Extra information about payouts
        - `receipt_url` string
        - `batch_payment_id` string
        - `batch_payment_name` string
        - `reference_number` string
        - `tracking_key` string
      - `shinkansen_delivered_at` string, date-time: The timestamp when the transaction was delivered by Shinkansen to the bank
      - `shinkansen_transaction_ids` string[], required: The Shinkansen transaction IDs related to the payouts

## Response `200`

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

## Other responses

- `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)'

---

[API](https://skmtc.dev/shinkansen/apis/payouts-participant-webhooks.md) - [All operations](https://skmtc.dev/shinkansen/apis/payouts-participant-webhooks/llms.txt) - [OpenAPI document](https://skmtc.dev/shinkansen/apis/payouts-participant-webhooks/revisions/be13d993109f?raw)