Gallery Platform API
Reference

List payables

Lists the gallery's payables (what it owes consignors from sales), newest first, with cursor pagination. Filter by `status` or `payee_contact_id`.

GET
/gallery/payables

Lists the gallery's payables (what it owes consignors from sales), newest first, with cursor pagination. Filter by status or payee_contact_id.

Authorization

bearerAuth payables:read
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: payables:read

Query Parameters

limit?integer

Page size. Defaults to 20; the maximum is 100.

Range1 <= value <= 100
Default20
cursor?string

Opaque cursor from the previous page's next_cursor. Omit for the first page.

status?string

Filter to the given status; the schema's enum lists the values.

Value in

  • "pending"
  • "paid"
  • "void"
payee_contact_id?string

Filter to the given payee contact id.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "data": [    {      "id": "string",      "sale_id": "string",      "sale_item_id": "string",      "artwork_id": "string",      "payee_contact_id": "string",      "payee_name": "string",      "kind": "consignor",      "status": "pending",      "amount_cents": -9007199254740991,      "currency": "string",      "basis_bps": 0,      "basis_amount_cents": -9007199254740991,      "paid_amount_cents": -9007199254740991,      "paid_at": "string",      "notes": "string",      "metadata": {        "property1": "string",        "property2": "string"      },      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string"}

Get a payable GET

Returns one consignor payable: the owed amount and currency, the payee, the sale and line it arose from, the frozen basis, and its settlement status.

Pay a consignor payable via Stripe POST

Transfers a pending payable's amount from the gallery's connected account to the consignor's Stripe account and marks it paid. Requires a payouts-enabled Stripe connection; returns 503 when Stripe isn't configured in this environment.