List payables for the entity

Returns a paginated list of payables scoped to the entity named by shinkansen_fin_id (authorized against the authenticated customer). This is the only read on the Integrator API and needs no signature (there is no body to sign).

Every endpoint under /payables requires an API key whose scopes include payables:all (or the catch-all all).

Filtering, sorting and pagination follow the standard Flop conventions used across the Treasury API:

Pagination: page and page_size (max 100, defaults to 50).
Sorting: order_by (one or more of id, bank_account_id, amount, due_date, inserted_at, updated_at) and order_directions (asc / desc).
Filtering: filters[N][field], filters[N][op], filters[N][value]. Filterable fields: id, external_id, state, payable_type, currency, amount, due_date, description, bank_account_id, payment_rail, dispatch_policy, execution_hint, inserted_at, updated_at, and search — a free-text ilike over external_id and description, its only supported operator. Example: filters[0][field]=state&filters[0][op]=%3D%3D&filters[0][value]=waiting_order.

A field that is filterable but not sortable (external_id, state, …) is rejected with a 422 when passed in order_by.

Query Parameters

shinkansen_fin_id
Type: string
required

Shinkansen id of the entity whose payables to list. Required.
page
Type: integer

Current page to fetch (defaults to 1 if not specified).
page_size
Type: integer
min:
1
max:
100

Maximum number of payables to return per page (can't be greater than 100; defaults to 50).
order_by
Type: array of stringenum

Fields to sort by (defaults to inserted_at).

values
idbank_account_idamountdue_dateinserted_atupdated_at
order_directions
Type: array of "asc" or "desc"enum

Sort directions, positional to order_by (defaults to desc).

Responses

application/json
401

The Shinkansen-Treasury-Api-Key header is missing or does not match a Treasury customer. The body is the plain text Unauthorized.
403

The API key is valid but lacks the payables:all scope. The body is the plain text Forbidden.
application/json
application/json

get/payables

curl 'https://api.treasury.shinkansen.finance/v1/payables?shinkansen_fin_id=' \
  --header 'Shinkansen-Treasury-Api-Key: YOUR_SECRET_TOKEN'

Show Schema

{
  "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": "11111111-1",
          "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"
    }
  ],
  "meta": {
    "current_page": 1,
    "current_offset": 0,
    "total_count": 1,
    "total_pages": 1,
    "start_cursor": null,
    "end_cursor": null,
    "has_next_page?": false,
    "has_previous_page?": false
  }
}

A paginated list of payables for the entity, plus pagination metadata.

Payables

Create payables