Skip to content

Create payment method

POST
/v1/payment_methods/

Create a new payment method.

PaymentMethodCreate
object
customer_id
required
Customer Id
string format: uuid
provider
required
Provider
string
>= 1 characters <= 50 characters
provider_payment_method_id
required
Provider Payment Method Id
string
>= 1 characters <= 255 characters
type
required
Type
string
>= 1 characters <= 50 characters
is_default
Is Default
boolean
details
Details
object
key
additional properties
any

Successful Response

PaymentMethodResponse
object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
customer_id
required
Customer Id
string format: uuid
provider
required
Provider
string
provider_payment_method_id
required
Provider Payment Method Id
string
type
required
Type
string
is_default
required
Is Default
boolean
details
required
Details
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Unauthorized – invalid or missing API key

Validation error