Sends a payout message

Sends a new payout message, which — if successful — will move funds from the account of one participant of the network to some account on an external network (e.g: traditional bank accounts)

Body

application/json

Payout message, as sent originally by the participant instructing the payout

document
Type: object
required

Envelops the message content

Properties: 2

Responses

application/json
application/json
403

Forbidden (e.g: wrong API Key)
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)'

Callbacks

post/messages/payouts

curl https://api.shinkansen.finance/v1/messages/payouts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Shinkansen-JWS-Signature: YOUR_SECRET_TOKEN' \
  --header 'Shinkansen-Api-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "document": {
    "header": {
      "message_id": "014a74cb-597c-46a1-8217-63e58a336b0d",
      "creation_date": "2022-04-08T18:25:43-04:00",
      "sender": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "EMPRESA_A"
      },
      "receiver": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN"
      }
    },
    "transactions": [
      {
        "transaction_type": "payout",
        "transaction_id": "8af773eb-761d-44a5-86a9-1435189d215c",
        "currency": "CLP",
        "amount": "30000",
        "execution_date": "2022-04-11T10:30:00-03:00",
        "description": "Salary payment",
        "reference_number": "1234567",
        "tracking_key": "AAA1234567",
        "debtor": {
          "name": "Empresa A SpA",
          "identification": {
            "id_schema": "CLID",
            "id": "11111111-1"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "BANCO_BICE_CL"
          },
          "account": "123451",
          "account_type": "current_account",
          "email": "pagos@empresa-a.example.com"
        },
        "creditor": {
          "name": "Romulo Gallegos",
          "identification": {
            "id_schema": "CLID",
            "id": "11111111-1"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "SCOTIABANK_CL"
          },
          "account": "1513523451",
          "account_type": "current_account",
          "email": "romulo.gallegos@shinkasen.finance"
        }
      }
    ]
  }
}'

Show Schema

{
  "transactions": [
    {
      "transaction_id": "c5bae6b3-7c11-4b09-aad8-340ecc1a042c",
      "shinkansen_transaction_id": "a517a741-e84f-4ac1-8d9d-922162fc703b"
    },
    {
      "transaction_id": "6f913677-8d84-4dae-a30d-3639608ec3f3",
      "shinkansen_transaction_id": "4266ca42-b990-4f59-9b08-623660a72ee2"
    }
  ]
}

Message correctly received. Does NOT mean the transaction was succesful. Transaction result is communicated back on another message.

Transactions & Responses

Returns transactions from Shinkansen