API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
- GETRetrieves completed carts of the current tenant.
- GETRetrieves a cart by its ID.
- GETRetrieves a cart by its ID.
- PUTChanges the quantity of a cart item.
- PUTConfirms a cart.
- PUTConfirms the OTP of a cart.
- GETRetrieves the invoice addresses of a cart.
- GETRetrieves the payment methods of a cart.
- PUTPrepares a cart for stripe.
- GET
Accounting
Confirms a cart.
Confirms a cart.
curl -X PUT \
/public/checkout/cart/{id}/confirm \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"email": "",
"phone": "",
"invoiceAddressId": "https:\/\/example.com\/",
"paymentMethodId": "https:\/\/example.com\/"
}'{
"action": "redirect",
"redirectUrl": "<string>",
"status": "open",
"confirmationMessage": "<string>"
}Authorizations
Value for the Authorization header parameter.
Path Parameters
Cart identifier
Body
The customer email to be used for the cart. This is required when the cart is not attached to a customer.
The customer phone to be used for the cart. This is required when the cart is not attached to a customer.
The new customer address to be used for the cart.
If not provided, we will use the customer country code.
Can be empty if the customer is a company.
255Can be empty if the customer is a company.
255If not provided, we will use the customer vat id.
2 - 255255The street of the customer. If not provided, we will use empty string.
2 - 255The house number of the customer. If not provided, we will use empty string.
255The zip code of the customer. If not provided, we will use empty string.
The city of the customer. If not provided, we will use empty string.
2 - 255Additional address line of the customer. If not provided, we will use empty string.
255Firma, Herr, Frau The cost centre of the customer. If not provided, we will use empty string.
2 - 255TYPE_DEFAULT, TYPE_INVOICE The customer address to be used for the cart.
The new payment method to be used for the cart.
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 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 The customer that owns this payment method. If not provided, the customer will be determined by the authenticated user.
Determines if this payment method should be used as default payment method for the customer
Determines if this payment method is allowed to be used for future payments. Otherwise the payment method is only available for this payment.
Required when gateway is "stripe". Holds all necessary data for the payment gateway to create the payment method.
The Stripe payment method id, which was collected by Fynn.JS or Stripe.JS
If null is provided, you get a action_required response, with the {SETUP_INTENT_CLIENT_SECRET} to perform the authorization in stripe.js, see <a href="https://stripe.com/docs/js/setup_intents/confirm_card_setup">Confirm card setup</a>.
The Stripe customer id, which references the Stripe customer. If none is provided, the stripe customer id will be used, which was created automatically by Fynn, during fetching the stripe setup intent secret.
Required when gateway is "sepa_debit". Holds all necessary data for the payment gateway to create the payment method.
The customer's IBAN
The customer's BIC
The bank account holder's name
The mandate reference will be generated automatically, if none is provided. You can set it when migrating from another payment provider.
35The SEPA mandate signing date. If none is provided, the current date will be used.
The SEPA mandate type. If none is provided, the default type "CORE" will be used.
Possible values:
CORE: The core scheme is used for payments between consumers and companiesB2B: The B2B scheme is used for payments between companies. No refund is possibleCOR1: The COR1 scheme is used for payments between consumers and companies. The payment is processed faster than with the core scheme
CORE, B2B, COR1 The SEPA mandate sequence. If none is provided, the default sequence "FRST" will be used.
Possible values:
FRST: The sepa mandate is used for the first time for a recurring paymentRCUR: The sepa mandate was already used the first time and is now used for recurring paymentsFNAL: The sepa mandate is used for the last time for a recurring paymentOOFF: The sepa mandate is only allowed to be used for one payment
FRST, RCUR, FNAL, OOFF Optional for gateway "go_cardless". It is only required when you want to migrate, or assign an existing GoCardless customer or mandate to fynn.
The GoCardless customer id, which references the GoCardless customer. If none is provided, the GoCardless mandate flow will be started.
The GoCardless mandate id, which references the GoCardless mandate. If none is provided, the GoCardless mandate flow will be started.
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.
The payment method to be used for the cart.
Response
The action to perform after the cart confirmation.
redirect, none, confirmation_message The URL to redirect to after the cart confirmation.
The status of the cart after the cart confirmation.
open, confirming, redirect_to_payment, expired, completed, paid The message to show to the user after the cart confirmation.
Was this page helpful?
curl -X PUT \
/public/checkout/cart/{id}/confirm \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"email": "",
"phone": "",
"invoiceAddressId": "https:\/\/example.com\/",
"paymentMethodId": "https:\/\/example.com\/"
}'{
"action": "redirect",
"redirectUrl": "<string>",
"status": "open",
"confirmationMessage": "<string>"
}