Skip to main content
POST
Request SPT parameters for an invoice

Authorizations

Authorization
string
header
required

Biscuit-based bearer token. Obtain tokens from the Adaptyv Portal or via the /tokens endpoint. Tokens encode organization membership and role-based capabilities; the API verifies the token's cryptographic signature and authorization claims before processing requests. Use /tokens/attenuate to create restricted tokens for delegation.

Path Parameters

invoice_id
string
required

Foundry invoice UUID or Stripe invoice ID (in_xxx)

Response

SPT parameter bundle

Response returned by the SPT handshake endpoint (POST /invoices/{invoice_id}/spt-request).

The customer calls the handshake to learn exactly what to put in the Shared Payment Token it mints with Stripe: the amount to authorise, the currency, the Adaptyv-Inc seller-network the token must target, when the minted token should expire by, and which Stripe payment-method types are accepted. Armed with this bundle the customer mints the SPT and POSTs it back to /invoices/{id}/pay with the credential in the Authorization: Payment <b64> header. /quotes/{id}/confirm is categorically non-settling and never accepts the credential.

Example

currency
string
required

ISO 4217 currency code the SPT must be denominated in. Always "usd" today; the validator rejects non-USD tokens.

Example:

"usd"

description
string
required

Human-readable description to attach to the payment, naming the experiment being paid for.

Example:

"Adaptyv experiment 1f0b2c3d payment"

expires_at
string<date-time>
required

Suggested latest expiry for the minted SPT (ISO 8601 / RFC 3339). A token expiring before redemption is rejected, so customers should mint with at least this much runway.

Example:

"2026-01-01T00:05:00Z"

max_amount_cents
integer<int64>
required

Maximum amount, in cents, the minted SPT must authorise. Equals the invoice amount due; the validator rejects any SPT authorising less.

Example:

1750

payment_method_types
string[]
required

Stripe payment-method types accepted for the SPT, per Stripe's MPP docs.

Example:
recipient_account_id
string
required

Adaptyv-Inc Stripe seller-network (profile) id the SPT must target. The validator enforces strict equality against this value.

Example:

"profile_test_REDACTED"