Skip to main content
POST
Start hosted payment-method setup

Authorizations

Authorization
string
header
required

Verified Batch Relay dashboard session token. This is distinct from a scoped Batch Relay API key.

Headers

X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

account_id
string
required
Required string length: 1 - 256

Body

application/json
cancel_url
string<uri>
required
Pattern: ^https://
success_url
string<uri>
required
Pattern: ^https://

Response

Hosted setup session

id
string
required
url
string<uri>
required
expires_at
integer