POST
/
payment-methods
/
link
curl -X POST \
 /payment-methods/link \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "customer": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "sendEmail": "1"
}'
{
  "link": "https://my.customerfront.app/self-service/payment-method-link/1234"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Body

The new PaymentMethod resource
​
customer
string
required

The customer id

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

​
allowedPaymentMethodTypes
enum<string>

The allowed payment method types. If none is provided, all available will be shown.

Available options:
sepa_debit,
card,
paypal,
bank_transfer,
wallet
Example:

"card"

​
sendEmail
boolean
default:true

Whether to send an email to the customer with the link.

Example:

true

Response

201
application/json
The link to add a new payment method
​
link
string

The link to add a new payment method

Example:

"https://my.customerfront.app/self-service/payment-method-link/1234"

Was this page helpful?

Suggest editsRaise issue
Upload a document for a payment methodGet transactions