Skip to main content
POST
Create Setup Intent

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Headers

Idempotency-Key
string

Deduplicates retried requests with the same key and parameters instead of creating a second resource. Recommended: an opaque, randomly-generated value such as a UUID.

Body

application/json
provider_customer_id
string
required

Existing provider customer ID the payment method will be saved against. Must belong to your own configuration.

usage
string

One of "on_session", "off_session". Default "off_session".

metadata
object

Free-form string key/value pairs forwarded to the payment provider.

Response

Success.

data
object
required