SHshinkansen
Transactions & Responses

Receives responses from Shinkansen

Webhook for receiving transaction responses

post/responses

Request

  • Base URL
    https://example.customer.url
  • URL
    https://example.customer.url/responses
  • 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": "BUK"
      }
    },
    "responses": [
      {
        "transaction_type": "payin",
        "transaction_id": "3c11df48-dfab-41eb-a3c1-b9f90a0da063",
        "shinkansen_transaction_id": "455765a6-0b51-4e48-8827-06192824a1ab",
        "shinkansen_transaction_status": "ok",
        "shinkansen_transaction_message": "OK",
        "response_id": "8d267f06-84c8-448b-bebb-1eaf4c60b986",
        "response_status": "ok",
        "response_message": "OK",
        "expected_settlement_date": "2023-04-08T18:25:45-04:00"
      }
    ]
  }
}

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.