Integration StepsStep 1: Checkout Widget

Step 1: Checkout Widget

Step 1: Configure the Checkout Widget

The Checkout Widget is what your customers interact with when they complete a payment. Before you can create any transaction, you need at least one widget configured.

Navigate to: Dashboard → Checkout Widget

What the Widget Controls

A Checkout Widget defines:

  • Your branding (logo, brand colour)
  • Supported fiat currencies
  • Supported payment methods (APMs) for those currencies
  • Supported crypto tokens

You can create multiple widget templates and reuse them across transactions. Each widget has a unique ID called the paymentLinkId. Your customers will see this widget in the Apara-hosted page while making their payment.

How to Create or Update a Checkout Widget

Create: Dashboard → Checkout Widget → click Create New Widget

Update: Dashboard → Checkout Widget → click on the existing widget

Creating a Widget

  1. Navigate to Dashboard → Checkout Widget
  2. Add your branding details (logo and brand colour)
  3. Select the currencies you want to accept
  4. Enable the payment methods for each currency
  5. Select supported crypto tokens if applicable
  6. Save — you'll receive a paymentLinkId

Widget Customization Options

You can customize:

  • Logo
  • Brand color
  • Supported fiat currencies
  • Payment Methods per currency
  • Supported crypto tokens

You will get a live preview of the widget on your screen while you are making the customizations. After adding your brand's colours and logo you can select the payment methods that you want to enable for your customers.

You will also get custom code for the template you created in Node.js, Python, PHP and Java, plus a sample cURL which you can import into Postman.

Reusing a Widget

You do not need to create a different widget for each currency. You can add all the currencies and crypto tokens that you want to collect in a single widget template. To collect the payment in a particular currency, simply pass that currency in the currency param of the API.

You do not need a new widget for every transaction. Create once, reuse everywhere. You will simply need to pass the paymentLinkId of that widget in the API.

Important Widget Rules

  • Only payment methods enabled in the widget will appear in checkout
  • If you pass a currency in the API but haven't enabled payment methods for it in the widget, nothing will be shown

Common mistake: Passing a currency in the API but forgetting to enable its payment methods in the widget.

Was this page helpful?