Payout orders
Sends one or more payout orders to be automated
Creates one or more payout orders that are automatically reviewed by the Treasury Copilot system according to predefined organizational rules. This endpoint supports batch processing, allowing you to submit multiple payout orders in a single request.
Each payout order is subject to validation against the configured rules. If approved, funds will be moved from the account of one participant of the network to some account on an external network (e.g., traditional bank accounts).
post/payout_orders
Request body
Example request
{
"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": "BUK"
},
"receiver": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "SHINKANSEN_TREASURY"
}
},
"payout_orders": [
{
"payout_order_id": "8af773eb-761d-44a5-86a9-1435189d215c",
"currency": "CLP",
"amount": "30000",
"execution_date": "2022-04-11T10:30:00-03:00",
"description": "Salary payment - Employee 1",
"reference_number": "1234567",
"tracking_key": "AAA1234567",
"payment_purpose_category": "default",
"payment_rail": "default",
"execution_mode": "default",
"po_connection": "default",
"debtor": {
"name": "Buk SpA",
"identification": {
"id_schema": "CLID",
"id": "12383287-6"
},
"financial_institution": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "BANCO_BICE_CL"
},
"account": "123451",
"account_type": "current_account",
"email": "payments@buk.com"
},
"creditor": {
"name": "Romulo Gallegos",
"identification": {
"id_schema": "CLID",
"id": "12383287-6"
},
"financial_institution": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "SCOTIABANK_CL"
},
"account": "1513523451",
"account_type": "current_account",
"email": "romulo.gallegos@shinkansen.finance"
}
},
{
"payout_order_id": "9bf884fc-872e-55b6-97b0-2546290e326d",
"currency": "CLP",
"amount": "45000",
"execution_date": "2022-04-11T10:30:00-03:00",
"description": "Salary payment - Employee 2",
"reference_number": "1234568",
"tracking_key": "AAA1234568",
"payment_purpose_category": "default",
"payment_rail": "default",
"execution_mode": "default",
"po_connection": "default",
"debtor": {
"name": "Buk SpA",
"identification": {
"id_schema": "CLID",
"id": "12383287-6"
},
"financial_institution": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "BANCO_BICE_CL"
},
"account": "123451",
"account_type": "current_account",
"email": "payments@buk.com"
},
"creditor": {
"name": "Maria Garcia",
"identification": {
"id_schema": "CLID",
"id": "15678432-1"
},
"financial_institution": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "BANCO_ESTADO_CL"
},
"account": "2624634562",
"account_type": "current_account",
"email": "maria.garcia@example.com"
}
}
]
},
"batch": {
"description": "Monthly payroll"
}
}Response
Message correctly received. Does NOT mean the payout order will be executed and successful.
Example response
{
"payout_orders": [
{
"payout_order_id": "c5bae6b3-7c11-4b09-aad8-340ecc1a042c",
"shinkansen_payout_order_id": "a517a741-e84f-4ac1-8d9d-922162fc703b"
},
{
"payout_order_id": "6f913677-8d84-4dae-a30d-3639608ec3f3",
"shinkansen_payout_order_id": "4266ca42-b990-4f59-9b08-623660a72ee2"
}
]
}