Transactions & Responses

Sends a payout response (used by payout operators)

Changed on

The payout operator reply to the payout transaction using this endpoint

post/messages/responses

Request

  • Base URL
    https://api.shinkansen.finance/v1
  • Auth
    API key in header Shinkansen-JWS-Signature and API key in header Shinkansen-Api-Key

Request body

Example request

{
  "document": {
    "header": {
      "message_id": "1df9acc5-4ec3-4866-b3ee-f6522841dfce",
      "creation_date": "2022-04-08T18:25:45-04:00",
      "sender": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "BANCO_BICE_CL"
      },
      "receiver": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN"
      }
    },
    "responses": [
      {
        "transaction_type": "payout",
        "transaction_id": "326779d2-56c0-4344-9d47-a0d87ba01600",
        "shinkansen_transaction_id": "db93ad2b-a641-418e-bed9-662d93eb97ae",
        "response_id": "ce4a51dd-e008-4623-ad3f-1fb90b4531ce",
        "response_status": "ok",
        "response_message": "Success or Error Message"
      }
    ]
  }
}

Response

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

Changes

    • info

      added the new error_creditor_account_closed enum value to the request property ///////

    • info

      added the new error_creditor_account_currency_mismatch enum value to the request property ///////

    • info

      added the new error_creditor_reject enum value to the request property ///////

    • info

      added the new error_debtor_account_detail_mismatch enum value to the request property ///////

    • info

      added the new error_debtor_account_not_found enum value to the request property ///////

    • info

      added the new error_debtor_fi_offline enum value to the request property ///////

    • info

      added the new error_debtor_reject enum value to the request property ///////

    • info

      added the new error_expired enum value to the request property ///////