SHshinkansen
Metadata Notifications

Receives notifications from Shinkansen

Webhook for receiving metadata notifications related to payout transactions

post/notifications

Request

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

Request body

Example request

{
  "document": {
    "header": {
      "message_id": "d562602e-2fec-4072-81a0-d84b6b0ea5d3",
      "shinkansen_message_id": "0421c147-1d4a-484c-b855-9dcd8b9b67d9",
      "creation_date": "2022-04-08T18:25:45-04:00",
      "sender": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN"
      },
      "receiver": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN_SPA"
      }
    },
    "notifications": [
      {
        "notification_id": "4e0309bd-7228-46ae-887e-41764f9d5ac7",
        "notification_type": "metadata",
        "payment_operator_metadata": {
          "receipt_url": "https://simulatedbank.shinkansen.tech/payouts/b68dda58-411a-474e-8a77-11cc58d21b42",
          "batch_payment_id": 74493480,
          "batch_payment_name": "SHINKANSEN_SPAnomina389601.txt",
          "reference_number": 789,
          "tracking_key": "H2HS01002503310000670672"
        },
        "shinkansen_transaction_ids": [
          "6f11ea4d-d2fa-4da3-b102-8c07112c1635"
        ]
      }
    ]
  }
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.