DOCSEARCHbyAlgolia
Submit Docs

Voucherly Documentation

website·Indexed 32 days ago

https://docs.voucherly.it

Developer guides and API reference for Voucherly, a payment platform for online and in-person transactions. Includes documentation for the v1 WebAPI, Voucherly.js library for custom checkout components, hosted checkout pages, and integrations for e-commerce platforms like WooCommerce and PrestaShop, as well as specialized solutions for kiosks, smart vending machines, and pay-at-table services.

Tokens
40.8K
Snippets
115
Records
273
Agent score
58%

What's inside Voucherly

  1. Overview of Edenred integration with Voucherly

    Voucherly provides a pre-built technical integration for merchants to accept Ticket Restaurant Edenred vouchers on web checkouts and in-app. Because the infrastructure, SSO flow, and payment pages already comply with Edenred's standards, no custom development is required from the merchant. The integration process consists of three phases: Integration and development, Validation and UAT (User Acceptance Testing), and Production environment setup.

  2. Overview of Voucherly electronic receipt integration

    Voucherly integrates with the Italian Revenue Agency's (Agenzia delle Entrate) "Documento Commerciale on line" web procedure to automate the issuance of electronic receipts. When a customer pays, Voucherly authenticates on Fisconline to generate the commercial document. This automation is supported by ruling no. 413 of 25/09/2020. A critical requirement is that VAT rates must be included in every payment request; otherwise, the Revenue Agency will reject the document generation.

  3. Overview of Voucherly payment integration

    Voucherly provides a prebuilt payment environment that enables merchants to accept online payments, including meal vouchers, without needing to integrate each payment gateway individually. The system handles the complexity of multiple gateways by redirecting customers to a Voucherly Checkout page where they can select their preferred payment method and complete the transaction securely.

  4. Overview of Voucherly Components

    Voucherly Components allow you to accept payments directly within your own checkout page instead of redirecting users to a hosted checkout. The library handles the rendering of payment forms (including cards, meal vouchers, Apple Pay, Google Pay, and prepaid quotas) within an iframe or popup, ensuring sensitive payment details never reach your server.

    Two components are available:

    1. Payment Component: A full payment form featuring an accordion of available payment methods, meal voucher flows, and a pay button.
    2. Express Checkout Component: A row of one-click buttons (Apple Pay, Google Pay, personal credit, prepaid quota) designed to be placed above a form for faster checkout.

  5. Overview of Pay at Table Upselling

    Upselling allows merchants to propose a curated list of extra products (e.g., coffee, desserts) to customers about to pay at the table. Proposed products are only added to the table order if the payment succeeds; abandoned or declined payments do not affect the order. All product details (name, description, price, image, and allergens) are pulled directly from the product catalogue to ensure consistency.

  6. Understand the Voucherly asynchronous payment flow on Shopify

    Since Shopify does not support external payment methods directly within its checkout process, Voucherly payments are handled asynchronously:

    1. Selection: The customer selects the Voucherly manual payment method during checkout.
    2. Notification: The customer automatically receives an email containing a secure payment link.
    3. Payment: The customer clicks the link, is redirected to Voucherly, and completes the payment.
    4. Completion: Once the payment is successful, the Shopify order is automatically marked as paid.

  7. Handle no response from Edenred regarding e-commerce activation

    Activation of the e-commerce channel typically takes about two weeks. If Edenred does not respond within this timeframe, the request may not have reached the correct person. You should send a follow-up email including the date of the original request and a specific deadline, copying both your Edenred sales contact and assistenzanetwork-it@edenred.com.
    We are writing again about our request of [date], whose text you will find below. Please get back to us by [date], even just to let us know the expected timing.

  8. Choose a Voucherly integration method

    Depending on your technical requirements, you can integrate Voucherly using one of the following methods:

    • E-commerce plugins: Pre-built plugins for PrestaShop, WooCommerce, and Shopify (minimal development).
    • Hosted checkout: Your server creates a Payment and redirects the customer to a Voucherly-hosted page.
    • Voucherly Components: An embedded payment form rendered directly on your own page.
    • Custom integration: A full REST API implementation for complete control over the payment flow.
    • In-person payments: For kiosks, vending machines, or physical sales.

  9. Manage organization entities using the Company API

    A Company in Voucherly represents a business entity or organization. It serves as a logical grouping for one or more customers, allowing for centralized management and reporting. Companies can be configured with specific attributes including default delivery addresses, pricing rules, and discounts.

  10. Understand PaymentGateway in Voucherly

    A PaymentGateway represents a payment processor (such as Visa, Mastercard, Edenred, or Satispay) used by Voucherly to settle payments. Merchants can enable specific subsets of available gateways and configure the necessary parameters for each.

  11. Payment object schema reference

    The Payment object represents a transaction and contains detailed information about amounts, payment methods, and transaction status. All monetary amounts are represented as integers in cents.
    {
  "requestedAmount": 1000, // Total requested in cents
  "amount": 1000, // Actual amount processed in cents
  "digitalAmount": 0,
  "voucherAmount": 0,
  "fringeAmount": 0,
  "cashAmount": 0,
  "confirmedAmount": 0, // Captured amount
  "refundedAmount": 0,
  "currency": "EUR",
  "status": "Paid", // See TransactionStatus values
  "paidOnUtc": "2023-10-01T12:00:00Z"
}

  12. Understand the ConceptStore data model

    A Concept Store represents a brand used to group multiple Stores belonging to the same Merchant. It is used to organize store hierarchies under a single brand identity.
    {
  "id": "conce_01kg2gestgepdbmsn7hs6bsrwp",
  "name": "string",
  "externalId1": "string",
  "externalId2": "string",
  "createdOnUtc": "2024-07-29T15:51:28.071Z"
}