Payables
Update a payable
Updates the mutable attributes of a single payable and/or triggers the integrator state transition to taken. The payable is named by the external_id path parameter; the signed envelope's payables array must carry exactly one element with the fields to change.
Attributes may only be edited while the payable is waiting_order. The only state transition an integrator may trigger here is waiting_order → taken (the core takes the record to pay it itself); any other value for state is rejected. The request is signed with the Shinkansen-JWS-Signature header.
patch/payables/{external_id}
Path parameters
external_idstring required
Identifier of the payable in the source system.
Request body
Example request
{
"document": {
"header": {
"message_id": "8af773eb-761d-44a5-86a9-1435189d215c",
"creation_date": "2026-07-15T19:10:00-04:00",
"sender": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "BUK"
},
"receiver": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "SHINKANSEN_TREASURY"
}
},
"payables": [
{
"state": "taken",
"metadata": {
"core_operation_id": "SP-99812"
}
}
]
}
}Response
The payable was successfully updated. Returns the updated payable.
Example response
{
"payable": {
"id": 41,
"external_id": "RD-2026-000123",
"local_entity_id": 7,
"payable_type": "redemption",
"amount": "150000.00000",
"currency": "CLP",
"state": "waiting_order",
"due_date": "2026-07-20",
"description": "Redemption settlement - fund A",
"metadata": {
"core_operation_id": "SP-99812"
},
"debtor": {
"financial_institution": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "BANCO_BICE_CL"
},
"account": "123451",
"account_type": "current_account"
},
"creditor": {
"name": "Romulo Gallegos",
"email": "romulo.gallegos@example.com",
"account": "1513523451",
"account_type": "current_account",
"identification": {
"id": "12383287-6",
"id_schema": "CLID"
},
"financial_institution": {
"fin_id": "SCOTIABANK_CL",
"fin_id_schema": "SHINKANSEN"
}
},
"payment_rail": "default",
"execution_mode": "default",
"dispatch_policy": "automatic",
"execution_hint": "internal",
"inserted_at": "2026-07-15T18:25:43Z",
"updated_at": "2026-07-15T18:25:43Z"
}
}