Skip to main content
Start hosted setup for a saved payment method

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Headers

Idempotency-Key
string
required

Required caller-generated identifier for one logical mutation. Preserve it when retrying an uncertain response; never reuse it for new work. Do not include credentials or payloads. Stable identifier for one logical mutation.

Required string length: 1 - 128

Body

application/json
success_url
string<uri>
required

BoxRouter website URL after setup; {SETUP_ID} is replaced. Returning here does not prove setup completed.

Maximum string length: 2048
cancel_url
string<uri>
required

BoxRouter website URL if the payer abandons setup.

Maximum string length: 2048

Response

Payment method setup session.

id
string
required
status
enum<string>
required

Confirmed only after Stripe reports the setup succeeded.

Available options:
pending,
confirmed,
canceled
checkout_url
string<uri>
required

Stripe-hosted setup page; no payment is collected.