Skip to main content
POST
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Authorization
string
header
required

JWT token for authenticated customers

Headers

x-spree-api-key
string
required
Authorization
string
required

Body

application/json
payment_method_id
string
required

Payment method ID

Example:

"pm_abc123"

external_data
object

Provider-specific data passed to the gateway

Response

payment setup session created

id
string
required
status
string
required
external_id
string | null
required
external_client_secret
string | null
required
external_data
object
required
payment_method_id
string | null
required
payment_source_id
string | null
required
payment_source_type
string | null
required
customer_id
string | null
required
payment_method
object
required