Batch-settle payables
Marks many pending payables paid at once (each settled at its owed amount). Idempotent: already-paid or voided payables, and any not in this gallery, are skipped. Returns the payables actually settled.
Marks many pending payables paid at once (each settled at its owed amount). Idempotent: already-paid or voided payables, and any not in this gallery, are skipped. Returns the payables actually settled.
Authorization
bearerAuth payables:createA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: payables:create
Query Parameters
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
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.
Mark many pending payables paid at once (idempotent).
Response Body
application/json
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "dry_run": true, "effect": { "summary": "string", "count": 0, "targets": [ { "type": "string", "id": "string", "label": "string" } ], "amount": { "minor": -9007199254740991, "currency": "str" }, "details": { "property1": "string", "property2": "string" }, "irreversible": true }}{ "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", "created_at": "string", "updated_at": "string" } ]}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}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.
Get an artist/consignor statement GET
Returns everything the gallery owes one payee — line detail plus per-currency totals net of the consignor's reimbursable (consignor_100) production costs.