POST
/
payment-methods
/
{id}
/
document

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

id
string
required

PaymentMethod identifier

Body

customer
string | null
gatewayName
enum<string>
Available options:
wallet,
sepa_debit,
stripe,
fake_provider,
paypal,
bank_transfer,
go_cardless,
testing
type
enum<string> | null
Available options:
sepa_debit,
card,
paypal,
bank_transfer,
wallet,
fake_provider
referenceId
string | null
customerReferenceId
string | null
default
boolean
status
enum<string>
default: active
Available options:
active,
action_required,
expired,
revoked,
gateway_unconfigured
source
enum<string>
default: api
Available options:
checkout,
customerfront,
api
enabled
boolean
isInternal
boolean
name
string | null
data
string[]
expirationDate
string | null
notifications
string[]
webhookResults
string[]
gatewayData
string[]

Response

201 - application/json
id
string
customer
string | null
gatewayName
enum<string>
Available options:
wallet,
sepa_debit,
stripe,
fake_provider,
paypal,
bank_transfer,
go_cardless,
testing
type
enum<string> | null
Available options:
sepa_debit,
card,
paypal,
bank_transfer,
wallet,
fake_provider
referenceId
string | null
default
boolean
status
enum<string>
default: active
Available options:
active,
action_required,
expired,
revoked,
gateway_unconfigured
source
enum<string>
default: api
Available options:
checkout,
customerfront,
api
enabled
boolean
name
string | null
data
string[]
creationDate
string
expirationDate
string | null
sepaMandate
object

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

card
object | null

The card data of the payment method, if the type is "card"

sepaDebit
object | null

The sepa mandate data of the payment method, if the type is "sepa_debit"

paypal
object | null

The paypal data of the payment method, if the type is "paypal"

expirationInDays
integer | null

Was this page helpful?

Migrate stripe payment methodsGet transactions