Developer Dashboard

CheckoutWithCard

🕒 This guide takes 15 minutes to embed a credit card checkout on your app.

👍

June 2023 update

We've made CheckoutWithCard even simpler to use! Developers can now pass in all properties directly on the frontend. No backend required.

Previous docs have been moved to CheckoutWithCard (Advanced).

CheckoutWithCard embeds a form on your app that accepts credit/debit card, Apple Pay, and Google Pay.

This component also handles:

  • Apple Pay and Google Pay
  • Bot and anti-fraud detection
  • 3D Secure (if necessary)
  • Buyer KYC (if necessary)

Example

👍

Try a demo!

📘

This SDK is available in ReactJS and JavaScript.

Integration: ReactJS

  1. Install the ReactJS SDK: 
    npm install @paperxyz/react-client-sdk

    yarn add @paperxyz/react-client-sdk
  2. On your frontend, render the CheckoutWithCard component with your configs.

Example code

import { CheckoutWithCard } from "@paperxyz/react-client-sdk";
  
<CheckoutWithCard
  configs={{
    // Registered contract ID
    contractId: "MY_CONTRACT_ID",
    // Buyer wallet address
    walletAddress: "0x...",
    // Mint method (for custom contracts only)
    mintMethod: {
      name: "claimTo",
      args: {
        _to: "$WALLET",
        _quantity: "$QUANTITY",
        _tokenId: 0,
      },
      payment: { 
        value: "0.1 * $QUANTITY",
        currency: "ETH"
      }
    }
  }}
  onPaymentSuccess={(result) => {
    console.log("Payment successful:", result);
  }}
/>

CheckoutWithCard props

NameTypeDescription
configs *objectA list of configs to create your card checkout element. Fields are the same as the ones found in the Create Checkout Elements Client Secret API.
onPaymentSuccess *({
transactionId: string;
}) => void		This method is called after the payment has been submitted for processing.

This payment may still be rejected by the cardholder's bank.
onError(PaperSDKError) => voidThis method is called when an error is encountered.
onPriceUpdate({
quantity: number;
unitPrice: PriceDetail;
networkFees: PriceDetail;
serviceFees: PriceDetail;
total: PriceDetail;
}) => void

Where PriceDetail is
{
display: string;
valueInSubunits: number;
currency: string;
}		This method is called when the price is updated or loaded for the first time. This summary is helpful to show a granular price breakdown.
localeenum
Valid values: en, fr, es, it, de, ja, ko, zh		The language to show text in.
Defaults to en.
optionsobjectCustomize component styling. See Customization.

Integration: JavaScript

  1. Install the JavaScript SDK with your preferred package manager.
    • npm install @paperxyz/js-client-sdk
    • yarn add @paperxyz/js-client-sdk
  2. Call createCheckoutWithCardElement to insert the iframe on your page. Pass the configs to this component.
    1. If you don't provide elementOrId, this call returns an iframe element for you to insert into your page.

Example code

import { createCheckoutWithCardElement } from "@paperxyz/js-client-sdk";

// Assume a container exists:
//
//		<div id="paper-checkout-container" width="380px" />
//
createCheckoutWithCardElement({
	configs: {
    contractId: "MY_CONTRACT_ID",
    walletAddress: "0x...",
  }
  elementOrId: "paper-checkout-container",
  appName: "My Web3 App",
  options,
  onError(error) {
    console.error("Payment error:", error);
  },
  onPaymentSuccess({ id }) {
    console.log("Payment successful.");
  },
});

// Alternatively, insert the iframe programmatically:
//
//		const iframe = createCheckoutWithCardElement(...)
//		document.getElementById('paper-checkout-container').appendChild(iframe);

Props

NameTypeDescription
configs *objectA list of configs to create your card checkout element. Fields are the same as the ones found in the Create Checkout Elements Client Secret API.
elementOrIdstring | HTMLElementIf provided, the iframe will be appended this element.

You can pass in the DOM element or the id associated with the element.

A minimum width of 380px is recommended.
appNamestringIf provided, the wallet card will display your appName.
localeenum
Valid values: en, fr, es, it, de, ja, ko, zh		The language to show text in.
Defaults to en.
optionobjectCustomize component styling. See Customization.
onLoad() => voidThis method is called when the iframe loads.
onError(error: PaperSDKError) => voidThis method is called when an error occurs during the payment process.
onPaymentSuccess(props : { transactionId: string }) => voidThis method is called when the buyer has successfully paid.
onReview(props: { cardholderName: string, id: string }) => voidThis method is called after the user enters their card details.

Customization

The optional options argument allows you to customize the component's styling. All customization fields are optional.

options object

NameTypeDescription
colorPrimarystring
In hex, e.g. #cf3781		The primary brand color for buttons and links.
colorBackgroundstring
In hex, e.g. #cf3781		The background color of the page.
colorTextstring
In hex, e.g. #cf3781		The color for text on the page and UI elements.
borderRadiusnumber
In px, e.g. 0 for sharp corners, 12 for rounded corners, 24 for pill shape		The roundness of buttons and input elements.
inputBorderColorstring
In hex, e.g. #cf3781		The border color of the input field.
inputBackgroundColorstring
In hex, e.g. #cf3781		The background color of the input field.

Examples

Here's an example component with the following props:

{
	colorBackground: '#fefae0',
	colorPrimary: '#606c38',
	colorText: '#283618',
	borderRadius: 6,
	inputBackgroundColor: '#faedcd',
	inputBorderColor: '#d4a373',
}

FAQ

How do I prevent the 3D Secure or KYC modal from popping up behind my other frontend components?

The SDK uses a z-index of 10000 for these modals. If they are appearing behind other components, please lower your component's z-index values.