Premiere V2 API

Appearance

v12.11.0

V2 Staging API Documentation​

Download OpenAPI Document

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers​

https://v2-staging.tscheckout.comCurrent host

One-time (idempotent, safe to re-run) backfill of finalization rows for orders stuck under the legacy permanent claim. Intended to be run once via cron before enabling the recoverable-lease feature flag for a merchant, and safe to leave in the crontab afterward since it is a no-op once nothing is stuck.​

GET
/api/v2/internal/finalization-recovery/backfill/{token}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

token*
Type
string
Required

Responses​

Backfill result

Playground​

Authorization
Variables
Key
Value

Samples​

Shadow/report-only view of everything currently recoverable, with zero side effects. Run and review this before pointing the recover() cron job at automatic retries for a merchant (plan §7).​

GET
/api/v2/internal/finalization-recovery/report/{token}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

token*
Type
string
Required

Query Parameters

maxAttempts
Type
integer
limit
Type
integer

Responses​

Recoverable leases and outbox rows, read-only

Playground​

Authorization
Variables
Key
Value

Samples​

Bounded recovery pass: retries every recoverable finalization lease (via the same verify-payment path a client retry would take) and drains the finalization outbox. Never throws for an individual order's failure; intended to be run periodically via cron.​

GET
/api/v2/internal/finalization-recovery/recover/{token}

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

token*
Type
string
Required

Query Parameters

maxAttempts
Type
integer
limit
Type
integer

Responses​

Recovery pass result

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI