Skip to main content
POST
cURL
This endpoint does not accept payment details. It initiates a flow that the customer completes themselves: they receive an email containing a secure link where they enter their payment information. The payment method is therefore not usable for billing when the response returns — treat the 201 as confirmation that the flow has started, not that the payment method is ready. In a portal UI, prompt the customer to check their inbox rather than waiting on the response.

Authorizations

X-Delegated-Token
string
header
required

Headers

X-Tenant-ID
string
required

Unique identifier of the tenant in the system (usually a store identifier)

Response

201 - application/json

Default Response

id
string<uuid>
required
customer
required

Customer id when not expanded, or the full Customer object when the field name is included in the expand query parameter.

Minimum string length: 1
Example:

"7654321"

instrument
object
billingAddress
null | object