Send transfers

Sends a new transfer message request to Switch, the transfer will be processed asynchronously and you will receive the status of the transaction in your webhook (https://docs.shinkansen.tech/reference/post-response-webook_transfers).

Body

application/json

Transfer message, as sent originally by the financial institution originating the transfer

document
Type: object
required

Envelops the message content

Properties: 2

Responses

post/transfers

curl https://sandbox-gateway.shinkansen.finance/api/transfers \
  --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": "TENPO",
      "receiver": "SHINKANSEN"
    },
    "transactions": [
      {
        "transaction_type": "transfer",
        "transaction_id": "8af773eb-761d-44a5-86a9-1435189d215c",
        "currency": "CLP",
        "amount": "30000",
        "reference": "A simple TEF operation",
        "debtor": {
          "name": "Ursula De Tena",
          "identification": {
            "id_schema": "CLID",
            "id": "22222222-2"
          },
          "financial_institution": "TENPO",
          "account": "111122222222",
          "account_type": "cash_account",
          "customer_type": "individual",
          "email": "ursuladetena@example.org"
        },
        "creditor": {
          "name": "Romulo Gallegos",
          "identification": {
            "id_schema": "CLID",
            "id": "11111111-1"
          },
          "financial_institution": "SCOTIABANK_CL",
          "account": "1513523451",
          "account_type": "current_account",
          "email": "romulo.gallegos@shinkasen.finance"
        },
        "network_metadata": {
          "originator_ipv4": "100.200.3.4",
          "operation_number": "1007700809165",
          "debtor_has_made_transfers_to_creditor_before": false,
          "is_batch_transfer": false,
          "customer_segment_code": "001",
          "filler": "Field free to be used"
        }
      }
    ]
  }
}'

Show Schema

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

Message correctly received and accepted to be processed by Shinkansen Gateway, this does NOT mean the transaction was succesful. You receive asynchronously the status of the transaction in your webhook (https://docs.shinkansen.tech/reference/post-response-webook_transfers).

Transactions & Responses

Send transfer responses