Receives responses from Shinkansen

Webhook for receiving transaction responses

Body

application/json

Responses to payin participants, sent by Shinkansen

document
Type: object
required

Envelops the message content

Properties: 2

Responses

200

Message correctly received. Does NOT mean the transaction was succesful. Further responses might be sent back on another message.
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/responses

curl https://example.customer.url/responses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Shinkansen-JWS-Signature: YOUR_SECRET_TOKEN' \
  --data '{
  "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": "EMPRESA_A"
      }
    },
    "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"
      }
    ]
  }
}'

No Body

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

Transactions & Responses

Introduction