The Mangopay Checkout SDK is a code-light, customizable solution to power the payment page of your website or app. It simplifies your implementation, improves security, and supports a variety of payment methods.

​
Supported payment methods

​
Card brands

AMEX

CB (France)

Maestro

Mastercard

Visa

​
APMs

Apple Pay

Google Pay

PayPal

Note – Currency coverage and usageCheckout SDK supports all currencies available for all payment methods.You must use the same currency for a transaction between your app, Checkout SDK, and calls to the Mangopay API to avoid incompatibility errors.

​
Features

  • Simplified card tokenization in full compliance with PCI-DSS
  • Integrated 3DS handling for secure and seamless payment authentication
  • Detection and presentation of user’s co-branded card choice, leveraging Mangopay’s BIN lookup endpoint
  • Customizable design elements to match your branding
  • Localization support for your whole user community
  • Compliance with privacy requirements

​
How it works

  1. The user proceeds to payment on your app or website.
  2. You configure and display your chosen payment methods to the user to collect payment information.
  3. The user selects the payment method and provides the payment information when required (e.g. card details).
  4. The Checkout SDK securely tokenizes the payment data:
    • For card payments, with the tokenization server via the Mangopay API to generate a CardId
    • For Google Pay and Apple Pay, with the payment methods API to generate tokenized payment data
  5. You create a delegate function that gets called by the SDK to start payment processing.
  6. Your server uses the CardId or tokenized payment data to create the transaction via the Mangopay API (pay-in, preauthorization, deposit preauthorization, or card validation).
  7. Your delegate function returns the outcome of the transaction.
  8. If required, the SDK handles additional redirect actions: 3DS authorization or validation via payment method interface (e.g. PayPal).
  9. You present the payment result to the user.

​
Flow diagram

The flow is described in the following diagram (numbered steps correspond to those above):

​
Resources

Live demo

Try out the Checkout SDK online

Web integration

Integrate the Checkout SDK

Changelog

See the SDK changelog on GitHub

Example apps

Start with pre-built examples for React and VueJS

​
Version policy

The Checkout SDK adheres to semantic versioning as the standard for versioning packages. To ensure a smooth integration experience while avoiding potentially breaking changes, we recommend configuring your dependency manager to automatically install only patch updates. For example, when using the web SDK, you can specify the desired patch version in your package.json file using the ~ operator:
Specify patch version
"dependencies": {
  "@mangopay/checkout-sdk": "~1.1.0"
}
This configuration will allow your project to automatically receive patch updates (e.g., 2.0.1, 2.0.2, etc.) for bug fixes and minor improvements. However, it will prevent updates to new minor (2.1.0) or major (3.0.0) versions, which may introduce breaking changes.