Create payment method link

Create a link to request the customer to add a new payment method. The link can be sent to the customer via email.

^{Required permissions: payment-method:add}

POST /payment-methods/link

cURL

cURL

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

201

{
  "link": "https://my.customerfront.app/self-service/payment-method-link/abc123def456"
}

Autorisierungen

Authorization · string · header · erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/jsontext/html

The new PaymentMethod resource

Request body for creating a link to request the customer to add a new payment method.

customer · string · erforderlich

The customer id

Beispiel:

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

allowedPaymentMethodTypes · enum<string>

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

Verfügbare Optionen: sepa_debit, card, paypal, bank_transfer, wallet

Beispiel:

"card"

sendEmail · boolean · Standard: true

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

Beispiel:

true

redirectUrl · string | null

Optional URL to redirect the customer to after the payment method has been added. If not provided, the default status page is used.

Beispiel:

"https://example.com/done"

Antwort

201

application/json

The link to add a new payment method

link · string

The link to add a new payment method

Beispiel:

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