Spirit of Cadeau
Intro
Spirit Of Cadeau and PassCadeau are French gift cards offered by FIS.
With an value range between 20 and 250€ per card, these gift cards are flexible and safe payment methods.
The integration is very easy, as you only have to send one additional parameter along with your request. You redirect your customers to the Spirit Of Cadeau payment page where they enter their gift card data (card number and cryptogram). They can combine up to three gift cards for a single purchase and even use their credit card for the remaining amount.
Onboarding
To use Spirit of Cadeau for either in our test/live environment, follow these steps:
- Sign a contract with Spirit of Cadeau and receive activation credentials in return.
- Send the activation credentials (MID/password and possibly other credentials) to us.
- We do the necessary onboarding and provisioning check.
- We activate the payment method in your account.
France
Integration
Redirect your customers to the Spirit of Cadeau payment page via our Hosted Checkout Page. Find a high level overview in the "Process flows" chapter.
Add the following properties to a standard CreateHostedCheckout request:
{
"order": {
"amountOfMoney": {
"currencyCode": "EUR",
"amount": 1700
},
"customer": {
"contactDetails": {
"emailAddress": "jean.dupont@test.com"
}
}
},
"hostedCheckoutSpecificInput": {
"locale": "fr_FR"
},
"redirectPaymentMethodSpecificInput": {
"paymentProductId": 3116,
"returnUrl": "https://yourReturnUrl.com"
}
}| Property | Remarks |
|---|---|
|
order.amountOfMoney |
amount: The gross amount you want to charge for this order. currencyCode: The ISO 4217 currency code for this amount. |
|
order.customer.contactDetails.emailAddress |
Your customer's e-mail address. |
|
hostedCheckoutSpecificInput.locale |
The language version of our Hosted Checkout Page. |
|
redirectPaymentMethodSpecificInput |
paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Overview" chapter. It instructs our platform to send your customers directly to the Spirit of Cadeau payment page. If left out, our platform sends your customers to the Hosted Checkout Page instead, allowing them to choose this or any other payment method in your account. returnUrl: The URL we redirect your customers to after the payment has been finalised.
|
Find detailed information about this object and its properties in our CreateHostedCheckoutAPI.
Process flows
- Your customers finalise an order in your shop and select Spirit Of Cadeau.
- You send this CreateHostedCheckout request to our platform.
- You redirect your customers via the redirectUrl to the Spirit Of Cadeau payment page. They confirm the order with their gift card credentials. If your customers need to pay a remaining amount, they use either another Spirit Of Cadeau and/or their credit card (Visa/MasterCard) on the Spirit Of Cadeau payment page.
- We receive the transaction result.
- We redirect your customer to your returnUrl
- You request the transaction result from our platform via GetHostedCheckout or receive the result via webhooks.
- If the transaction was successful, you can deliver the goods / service.
Testing
Refer to our Test cases for test data and detailed instructions.
Make sure to use the right endpoint and switch back to the live URL as soon as you have finished your tests.