Gallery Platform API
Reference

Create a card-present payment intent

Creates a card-present Stripe PaymentIntent on the gallery's connected account for the invoice's outstanding balance (or a partial amount) and returns its client secret for the Terminal SDK. Requires a connected Stripe account with charges enabled.

POST
/gallery/invoices/{id}/terminal-payment-intents

Creates a card-present Stripe PaymentIntent on the gallery's connected account for the invoice's outstanding balance (or a partial amount) and returns its client secret for the Terminal SDK. Requires a connected Stripe account with charges enabled.

Authorization

bearerAuth payments:create
AuthorizationBearer <token>

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

In: header

Scope: payments:create

Path Parameters

id*string

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.

Create a card-present PaymentIntent on the gallery's connected account for an in-person tap.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "stripe_payment_intent_id": "string",  "client_secret": "string",  "amount_cents": -9007199254740991,  "currency": "string",  "status": "string"}

Calculate invoice tax POST

Computes automatic sales tax for the invoice with Stripe Tax against its tax (ship-to) address, writes each line's tax, and rolls it up into the invoice totals. Requires a connected Stripe account with charges enabled and a tax address on the invoice.

Update an invoice PATCH

Updates an invoice's status, dates, or amounts (e.g. record a payment or mark it paid).