POST
/
payment-methods
/
{id}
/
document

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

PaymentMethod identifier

Body

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

Response

201 - application/json
​
card
object

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

​
creationDate
string
​
customer
string
​
data
string[]
​
default
boolean
​
enabled
boolean
​
expirationDate
string | null
​
expirationInDays
integer | null
​
gatewayName
enum<string>
Available options:
wallet,
sepa_debit,
stripe,
fake_provider,
paypal,
bank_transfer,
go_cardless,
testing
​
id
string
​
name
string | null
​
paypal
object

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

​
referenceId
string | null
​
sepaDebit
object

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

​
sepaMandate
object | null

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

​
source
enum<string>
default:
api
Available options:
checkout,
customerfront,
api,
add_link
​
status
enum<string>
default:
active
Available options:
active,
action_required,
expired,
revoked,
gateway_unconfigured
​
type
enum<string> | null
Available options:
sepa_debit,
card,
paypal,
bank_transfer,
wallet,
fake_provider

Was this page helpful?

Migrate stripe payment methodsCreate payment method link