Integrating vouchers
Vouchers are a prepaid payment method that can be used to make purchases both online and in-store. These vouchers typically come in the form of physical cards, which carry a set value. Employers often provide vouchers as part of a benefits package, allowing their employees to spend them on specific categories such as meals, eco-friendly products, sports activities, or cultural events. Mollie makes it easy to accept vouchers for point-of-sale payments.
Supported brands
The following brands are supported:
- Edenred: Cadeau(Compliments), Eco, Meal, and Sports & Culture
- Monizze: Gift, Eco, Meal, and Sports & Culture
- Pluxee(Sodexo): Cadeau, Eco, Lunch(Meal), and Sports & Culture
Contracting and settlement
In order to accept vouchers for point-of-sale, there are a few prerequisites:
- You should be eligible for point-of-sale and you should have the Point-of-sale payment method enabled. You can activate Point-of-sale via the Mollie Dashboard.
- You should have a contract with the owner of the brand(s) you want to accept. For example, with Pluxee Belgium for the Pluxee vouchers, Monizze for Monizze vouchers.
- Once you have a contract, you can request the setup for point-of-sale from the brand, by providing the configuration details you can retrieve from Mollie via the Mollie Dashboard.
For Edenred branded vouchers, Mollie will handle the settlement for you in the same way as we currently do for Mastercard payments. The reason for this is that the Edenred cards are Mastercard co-branded, which allows us to treat them as regular card payment, which can only be used for eligible products.
For Monizze and Pluxee vouchers Mollie does not handle settlement on your behalf.
Integration via the Mollie API
Vouchers can only be used to pay for certain product categories. These categories are eco
, meal
, gift
and sport_culture
. For every payment, you have to indicate which are applicable. The table below depicts an overview of each supported brand and which category is applicable.
Brands | Category |
---|---|
Edenred Cadeau(Compliments) Monizze Gift Pluxee Cadeau | gift |
Edenred Eco Monizze Eco Pluxee Eco | eco |
Edenred Meal Monizze Meal Pluxee Lunch(Meal) | meal |
Edenred Sports & Culture Monizze Sports & Culture Pluxee Sports & Culture | sport_culture |
Refer to the website of the voucher brand to see for which category your product is eligible.
Creating a payment
When creating a voucher payment for one of your terminals, you have to select pointofsale
as a payment method - in the same way as for the regular cards Point of Sale payments. See the required parameters for Point-of-sale payments in our public API docs.
Additionally you have to indicate the eligible voucher category of the product sold in the payment request. It is therefore required to add a line item using the lines
property of the Payments API . By adding the applicable category to the lines.categories
property, you can indicate which category is applicable.
Vouchers via Point of Sale payments only support a single category.
{
"amount": {
"currency": "EUR",
"value": "10.00"
},
"description": "Edenred voucher payment",
"method": "pointofsale",
"terminalId": "term_7MgL4wea46qkRcoTZjWEH",
"lines": [
{
"description": "Edenred voucher payment",
"quantity": 1,
"unitPrice": {
"currency": "EUR",
"value": "10.00"
},
"totalAmount": {
"currency": "EUR",
"value": "10.00"
},
"categories": [
"meal"
]
}
]
}
Once the Point-of-sale voucher payment is created, it will be sent to the specified terminal. The shopper can then complete the payment with a voucher card. It is not possible to complete the payment with a credit or debit card.
The shopper will then have to use a voucher card to pay for the payment, otherwise the payment will be declined and marked as failed. In other words, the shopper cannot change their mind and try the payment with a credit card at this point. If that’s the case, a new payment will have to be created
In the case only a partial basket is eligible for a voucher payment, please initiate two payment requests, one for the voucher, a second one for the remaining amount.
Get payment details
After a payment is created, you can get the details of the payment via the Get Payment endpoint. The payment will include specific details about the voucher that was used. For example, the details.issuer
will show the brand that was used.
Edenred co-branded cards
Edenred cards are Mastercard co-branded. Therefore the
details
object will also contain card related properties such ascardNumber
andcardLabel
. See the card specific parameters for more info.
Example of an API response:
{
"resource": "payment",
"id": "tr_7UhSN1zuXS",
// [Other payment properties]
"details": {
"terminalId": "term_7MgL4wea46qkRcoTZjWEH",
"cardNumber": "5017",
"cardAudience": "consumer",
"cardLabel": "Mastercard",
"cardCountryCode": "BE",
"cardFingerprint": "txXSDSDSDS-fW3b8lr_UpAsz_7",
"issuer": "edenred",
"vouchers": [
{
"issuer": "edenred",
"amount": {
"value": "0.01",
"currency": "EUR"
}
}
]
}
}
Refunds
Edenred voucher payments can be refunded in the same way as a regular Mastercard payment. For Monizze and Pluxee, you cannot perform refunds due to the limitation set by the brand issuers.
Updated 25 days ago