Skip to main content

Getting started

The instructions below will guide you on how to integrate your platform with our APIs.

Configuration​

1. Create a Sandbox account​

Visit the Dashboard and register a new account.
Verify your email address by clicking the link sent to your inbox.

2. Obtain API keys​

In the Sviluppatori section, you will find both secret and publishable keys.
Use the secret key to authenticate API calls, as explained in API Authentication.

The publishable key is meant for the browser: it initializes Voucherly Components, the payment form embedded in your page. It cannot call the API.

3. Enable Payment gateways​

Activate payment gateways in Impostazioni > Pagamenti > Gateway di pagamento.

Voucher payments often require supplementation with a standard transaction, such as a card payment. Therefore, activating at least one non-voucher payment gateway is strongly recommended.

tip

For sandbox testing, we recommend activating Demo Voucherly and MultiSafepay. These are sufficient to replicate all payment behaviors.
Please refer to the Payment gateways resource for more information about payment gateways.

4. Let's start​

Make your first API call with the Quickstart, then pick the integration that suits you in Online payments:

  • E-commerce plugins — developed in-house for PrestaShop, WooCommerce and Shopify, they require minimal or no development effort and let you start testing immediately.
  • Hosted checkout — your server creates a Payment and redirects the customer to a page hosted by Voucherly.
  • Voucherly Components — the payment form rendered inside your own page.
  • Custom integration — your own gateway selector on top of the REST API, for full control over the payment flow.

Selling in person, from a kiosk or a vending machine, is covered in In-person payments.

5. Before going live​

To start processing real transactions, we need to verify and approve your merchant account information.

  1. Activate your account providing information about your company.
  2. Ensure your website aligns with Website checklist.

Once submitted, we will perform know your customer (KYC) checks. If approved, your account will go live.