Gallery Platform API
Reference

Settle or void a payable

Updates a payable's status (e.g. mark it `paid` or `void`), payee, or notes. Marking it paid without an explicit amount settles the full owed amount.

PATCH
/gallery/payables/{id}

Updates a payable's status (e.g. mark it paid or void), payee, or notes. Marking it paid without an explicit amount settles the full owed amount.

Authorization

bearerAuth payables:update
AuthorizationBearer <token>

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

In: header

Scope: payables:update

Path Parameters

id*string

Query Parameters

dry_run?boolean

Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.

Header Parameters

Idempotency-Key?string

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Settle (status: paid) or void a payable, or edit its payee/notes.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "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",  "created_at": "string",  "updated_at": "string"}

Render a consignor statement PDF POST

Renders the branded consignor/artist statement to PDF on demand and returns a short-lived signed download URL.

Refund a payment POST

Initiates a full or partial Stripe refund of a settled card/ACH/Affirm payment. The refund settles into the ledger asynchronously via webhook.