Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-2642128296.2 KB
Payables

Create payables

Creates one or more payables, atomically, for the signed sender's entity. Each payable may carry its full payment instruction (debtor, creditor, routing/policy hints) or be completed later with a PATCH. The pair (entity, external_id) is unique, so a retry cannot duplicate a commitment: a repeated external_id is a 409 and rolls the whole batch back.

The request body is a signed envelope; the Shinkansen-JWS-Signature header must carry a JWS detached signature over the raw body, validated against the customer's certificates.

post/payables

Request body

Example request

{
  "document": {
    "header": {
      "message_id": "014a74cb-597c-46a1-8217-63e58a336b0d",
      "creation_date": "2026-07-15T18:25:43-04:00",
      "sender": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "BUK"
      },
      "receiver": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN_TREASURY"
      }
    },
    "payables": [
      {
        "external_id": "RD-2026-000123",
        "payable_type": "redemption",
        "amount": "150000",
        "currency": "CLP",
        "state": "waiting_order",
        "due_date": "2026-07-20",
        "description": "Redemption settlement - fund A",
        "dispatch_policy": "automatic",
        "execution_hint": "internal",
        "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_schema": "CLID",
            "id": "12383287-6"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "SCOTIABANK_CL"
          }
        }
      }
    ]
  }
}

Response

Payables successfully created. Returns the created batch with their system-assigned fields.

Example response

{
  "payables": [
    {
      "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"
    }
  ]
}