curl -X POST \
/payment-methods \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"summary": "Create stripe setup intent",
"description": "The stripe setup intent clientSecret is required to add a stripe credit card payment method. The clientSecret is required to collect credit card data with stripe.js elements.",
"value": {
"gateway": "stripe",
"type": "card",
"customerId": "ad8f7a8d-8f7a-8d8f-7a8d8f7a8d8f",
"isDefault": true,
"futureUsageAllowed": true,
"stripe": {
"paymentMethodId": null,
"customerId": null
}
}
}'{
"status": "action_required",
"actionRequired": {
"action": "client_site_action",
"redirectUrl": null,
"details": {
"clientSecret": "seti_1N5J2n2eZvKYlo2C_secret_abc123",
"publishableKey": "pk_test_1234567890",
"accountId": "acct_1234567890"
}
},
"failReason": null,
"paymentMethod": null
}Create payment method
Create a customer’s payment method
Required permissions:payment-method:addcurl -X POST \
/payment-methods \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"summary": "Create stripe setup intent",
"description": "The stripe setup intent clientSecret is required to add a stripe credit card payment method. The clientSecret is required to collect credit card data with stripe.js elements.",
"value": {
"gateway": "stripe",
"type": "card",
"customerId": "ad8f7a8d-8f7a-8d8f-7a8d8f7a8d8f",
"isDefault": true,
"futureUsageAllowed": true,
"stripe": {
"paymentMethodId": null,
"customerId": null
}
}
}'{
"status": "action_required",
"actionRequired": {
"action": "client_site_action",
"redirectUrl": null,
"details": {
"clientSecret": "seti_1N5J2n2eZvKYlo2C_secret_abc123",
"publishableKey": "pk_test_1234567890",
"accountId": "acct_1234567890"
}
},
"failReason": null,
"paymentMethod": null
}Autorisierungen
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The new PaymentMethod resource
Request body for creating a new payment method for a customer.
The payment gateway to use to process the given payment method type
Possible values:
paypal: PayPal (supports "paypal")stripe: Stripe (supports "card")testing: Testing (supports all)go_cardless: GoCardless (supports "sepa_debit")bank_transfer: Bank Transfer (supports "bank_transfer")sepa_debit: SEPA Credit and Debit with xml file (supports "sepa_debit")wallet: Credit Balance from Wallet (supports "wallet")
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing "stripe"
The payment method type to use for this payment method
Possible values:
sepa_debit: SEPA Debitcard: Credit Cardpaypal: PayPalbank_transfer: Bank Transferwallet: Wallet
sepa_debit, card, paypal, bank_transfer, wallet, fake_provider "card"
The customer that owns this payment method. If not provided, the customer will be determined by the authenticated user.
"ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"
Determines if this payment method should be used as default payment method for the customer
true
Determines if this payment method is allowed to be used for future payments. Otherwise the payment method is only available for this payment.
true
Required when gateway is "stripe". Holds all necessary data for the payment gateway to create the payment method.
Show child attributes
Show child attributes
Required when gateway is "sepa_debit". Holds all necessary data for the payment gateway to create the payment method.
Show child attributes
Show child attributes
Optional for gateway "go_cardless". It is only required when you want to migrate, or assign an existing GoCardless customer or mandate to fynn.
Show child attributes
Show child attributes
The redirect url to redirect the customer to after the payment method was created. This is only required, when you create a payment method with your own flow, independent from provided Hosted-Checkout, Hosted-Customerfront or Fynn.JS. Otherwise this has no effect.
"https://example.com/checkout/confirm"
Antwort
PaymentMethod resource created
The result of creating a payment method. Contains the status, any required actions, and the created payment method.
Possible values:
action_required: The payment method requires an action to be taken by the customersuccess: The payment method was successfully createdfailed: The payment method could not be created
action_required, success, failed The action required if the payment method requires an action to be taken by the customer
- redirect_to_gateway: The customer needs to be redirected to the payment gateway
- client_site_action: The customer needs to take an action on the client site
Show child attributes
Show child attributes
{
"action": "client_site_action",
"details": {
"clientSecret": "test_1234567890",
"publishableKey": "pk_test_1234567890",
"accountId": "acct_1234567890"
}
}
The fail reason if status is failed
The created payment method, if status is success
Show child attributes
Show child attributes
War diese Seite hilfreich?