Results

Receives a Result Webhook from Shinkansen Treasury for a final state of a Payout Order.

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": "2024-04-08T18:25:45-04:00",
      "sender": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN_TREASURY"
      },
      "receiver": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "MONSTER_INC"
      }
    },
    "payout_order_results": [
      {
        "shinkansen_payout_order_id": "8ddfed18-4e75-47ef-ae42-716cbe97d5a0",
        "payout_order_result_id": "1eace19d-189a-4a5c-812c-a2b741dd4ba5",
        "payout_order_id": "c3a3194a-3a31-45ff-91f0-d1025aa11eb8",
        "payout_response_statuses": [
          "ok"
        ],
        "payout_response_messages": [
          "ok"
        ],
        "payout_order_status": "succeeded",
        "split_details": {
          "total_chunks": 3,
          "succeeded_chunks": 3,
          "failed_chunks": 0,
          "currency": "CLP",
          "original_amount": "2994012.00",
          "transferred_amount": "2994012.00",
          "chunks": [
            {
              "index": 1,
              "amount": "998004.00",
              "currency": "CLP",
              "status": "succeeded",
              "payout_response_status": "ok",
              "payout_response_message": "ok"
            },
            {
              "index": 2,
              "amount": "998004.00",
              "currency": "CLP",
              "status": "succeeded",
              "payout_response_status": "ok",
              "payout_response_message": "ok"
            },
            {
              "index": 3,
              "amount": "998004.00",
              "currency": "CLP",
              "status": "succeeded",
              "payout_response_status": "ok",
              "payout_response_message": "ok"
            }
          ]
        }
      }
    ]
  }
}

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.