Skip to main content
POST
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

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

Body

application/json
type
string
required

Wire shorthand from the payment method types endpoint.

Example:

"check"

name
string
required
description
string | null
active
boolean
storefront_visible
boolean

False keeps the method to the dashboard; true also offers it on the storefront.

capture_method
enum<string> | null

When customers are charged for this method. Null inherits the store setting.

Available options:
checkout,
on_dispatch,
manual
position
integer
metadata
object
preferences
object

Values for the provider's preference schema, from the payment method types endpoint.

Response

payment method created