Skip to main content
POST
Create a setup link

Authorizations

x-api-key
string
header
required

Your platform key for buyer management, or a buyer key for everything else.

Body

application/json
returnUrl
string

Where the page sends the cardholder when they finish or back out, with setup_link and status (completed or canceled) added to the query. HTTPS only.

Maximum string length: 2048
cardholderEmail
string<email>

Pre-fills the page's email field; the cardholder can change it

Maximum string length: 254
expiresInMinutes
number
default:30

How long the link stays usable

Required range: 5 <= x <= 1440

Response

201

The link. url holds a one-time code and is only returned here