Glossary

Term	Definition
Checkout session	A hosted payment flow created via POST /v1/checkout/sessions. It produces a url you redirect the customer to and resolves to COMPLETE, EXPIRED, CANCELLED, or FAILED.
Order	The merchant-level record of an intended money movement (a PAYMENT, REFUND, PAYOUT, or TRANSFER). An order may be fulfilled by one or more transactions.
Transaction	A single attempt at the provider/network level — a PAYMENT, REFUND, AUTHORIZATION, CAPTURE, VOID, PAYOUT, or TRANSFER — with its own status, amounts, and provider references.
Authorization	A hold placed on the cardholder's funds without moving them. Created by capture_method: "manual"; settled by a capture or released by a void.
Capture	Settling funds held by an authorization. A final capture closes the authorization and releases any uncaptured remainder; a partial capture with final: false keeps the remainder capturable.
Void	Releasing an authorization's remaining held funds without capturing them.
Provider	An upstream payment processor or acquirer that Orchestr routes to on your behalf.
Merchant reference	Your own unique identifier for an order; also used as an idempotency key.
API key	A Bearer credential (sk_… secret, pk_… publishable) that authenticates requests.
Card token	A durable, non-sensitive reference (tok_…) to a card vaulted by Orchestr. Returned by Orchestr.js at collection; used to confirm the payment and to charge saved cards.
Client secret	A short-lived grant returned in a collect_card next_action, authorizing Orchestr.js to collect a card for one specific payment. Not an API key.
Consent	The recorded cardholder agreement (captured_at, type, reference) that you assert to save a card for future use. Also required on a transfer to a card.
Signing secret	A secret used to compute and verify the HMAC-SHA256 X-Signature on requests, responses, and webhooks.
Webhook	An HTTPS POST Orchestr sends to your endpoint to notify you of an event.
Event	A record of something that happened (e.g. payment.succeeded), delivered via webhook inside an envelope.
Settlement	The final movement of funds; transactions expose settlement amount/currency once known.

Status values

Enum values appear in lowercase on the wire (see Conventions).

Checkout session (status): open, pending_action, complete, failed, expired, cancelled.

Order (status): pending, processing, requires_action, authorized, succeeded, failed, canceled. There is no captured order status — a non-final partial capture leaves the order authorized, and it reaches succeeded when the authorization closes.

Transaction (status): initial, pending, processing, completed, failed, canceled.

Payment (status, returned by POST /v1/payments and the capture/void/3-DS endpoints): completed, requires_action, authorized, settling, canceled, failed.

Note the spelling: checkout sessions use cancelled (two Ls); orders and transactions use canceled (one L).

Other enums

Transaction type: payment, refund, authorization, capture, void, payout, transfer. Transaction direction: in, out. Order type: payment, refund, payout, transfer. Order subtype: checkout_session, direct_payment.