illicado
Beta

Last updated: December 16, 2022

Start accepting payments using illicado – a popular gift card payment method in Europe.

Information

To learn more, reach out to your Customer Success Manager or support@checkout.com.

Model	Gateway
Payment flow	Redirect
Payment method type	Gift card
One-step payment
Authorization
Capture
Refund
Partial refund
Chargeback
Recurring payment

Illicado payments follow a 2-step process:

For the full API specification, see the API reference.

post

https://api.checkout.com/payments


1{
2  "amount": 2000,
3  "currency": "EUR",
4  "source": {
5    "type": "illicado"
6  },
7  "failure_url": "https://example.com/payments/failure",
8  "success_url": "https://example.com/payments/success",
9  "reference": "ORD-5023-4E89",
10  "customer": {
11    "name": "John Smith",
12    "email": "john.smith@example.com",
13    "phone": {
14      "country_code": "+33",
15      "number": "1234567890"
16    }
17  }
18}

If you receive a 202 Accepted response with a status field set to Pending, your request was successful.


1{
2  "id": "pay_3arshuhzwosebdfgy2rs5wwkje",
3  "status": "Pending",
4  "reference": "ORD-5023-4E89",
5  "customer": {
6    "id": "cus_frc2mddwzxvuhliq4ejh2q4xh4",
7    "email": "john.smith@example.com",
8    "name": "John Smith",
9    "phone": {
10      "number": "1234567890",
11      "country_code": "+33"
12    }
13  },
14  "processing": {
15    "partner_payment_id": "977454915227"
16  },
17  "_links": {
18    "self": {
19      "href": "https://api.sandbox.checkout.com/payments/pay_3arshuhzwosebdfgy2rs5wwkje"
20    },
21    "redirect": {
22      "href": "https://payment.limonetikqualif.com/Illicado/Order/PayPage/977454915227?LmkData=c3c9bg=="
23    }
24  }
25}

Redirect your customer to the redirect link’s href in the response. This will allow the customer to authorize the payment, before they are transferred to your predefined success or failure URL.

You can retrieve details about an existing illicado payment with the following endpoint.

For the full API specification, see the API reference.

post

https://api.checkout.com/payments/{id}


1{
2  "id": "pay_3arshuhzwosebdfgy2rs5wwkje",
3  "requested_on": "2022-07-26T09:44:17.566704Z",
4  "source": {
5    "type": "illicado"
6  },
7  "amount": 2000,
8  "currency": "EUR",
9  "payment_type": "Regular",
10  "reference": "ORD-5023-4E89",
11  "status": "Pending",
12  "customer": {
13    "id": "cus_frc2mddwzxvuhliq4ejh2q4xh4",
14    "email": "john.smith@example.com",
15    "name": "John Smith",
16    "phone": {
17      "country_code": "+33",
18      "number": "1234567890"
19    }
20  },
21  "processing": {
22    "partner_payment_id": "977454915227"
23  },
24  "_links": {
25    "redirect": {
26      "href": "https://payment.limonetikqualif.com/Illicado/Order/PayPage/977454915227?LmkData=c3c9bg=="
27    },
28    "self": {
29      "href": "https://api.sandbox.checkout.com/payments/pay_3arshuhzwosebdfgy2rs5wwkje"
30    },
31    "actions": {
32      "href": "https://api.sandbox.checkout.com/payments/pay_3arshuhzwosebdfgy2rs5wwkje/actions"
33    }
34  }
35}


1{
2  "id": "pay_evkjtjurnowuffjxfabj6736mu",
3  "requested_on": "2022-07-26T09:35:28.0367406Z",
4  "source": {
5    "type": "illicado"
6  },
7  "amount": 2000,
8  "currency": "EUR",
9  "payment_type": "Regular",
10  "reference": "ORD-5023-4E89",
11  "status": "Captured",
12  "approved": true,
13  "balances": {
14    "total_authorized": 2000,
15    "total_voided": 0,
16    "available_to_void": 0,
17    "total_captured": 2000,
18    "available_to_capture": 0,
19    "total_refunded": 0,
20    "available_to_refund": 2000
21  },
22  "customer": {
23    "id": "cus_frc2mddwzxvuhliq4ejh2q4xh4",
24    "email": "john.smith@example.com",
25    "name": "John Smith",
26    "phone": {
27      "country_code": "+33",
28      "number": "1234567890"
29    }
30  },
31  "processing": {
32    "partner_payment_id": "228755788078"
33  },
34  "_links": {
35    "self": {
36      "href": "https://api.sandbox.checkout.com/payments/pay_evkjtjurnowuffjxfabj6736mu"
37    },
38    "actions": {
39      "href": "https://api.sandbox.checkout.com/payments/pay_evkjtjurnowuffjxfabj6736mu/actions"
40    },
41    "refund": {
42      "href": "https://api.sandbox.checkout.com/payments/pay_evkjtjurnowuffjxfabj6736mu/refunds"
43    }
44  }
45}

Illicado supports both partial and full refunds. You can refund a payment through the Dashboard or using the refund API.

post

https://api.checkout.com/payments/{id}/refunds


1{
2  "amount": 10
3}


1{
2  "action_id": "act_5efjt4mzurnebnbxcfgzwvrnga",
3  "_links": {
4    "payment": {
5      "href": "https://api.sandbox.checkout.com/payments/pay_evkjtjurnowuffjxfabj6736mu"
6    }
7  }
8}

Once a payment is created, you cannot void it. If you wish to void a payment in progress, please wait for the payment_captured webhook, and then process a refund. Communicating this in advance to your end customer can help you avoid chargebacks.

If the customer cancels or fails to complete their payment, we will send a payment_canceled webhook.

You may receive the following webhooks when using illicado.

Webhook	Description
`payment_pending`	Sent when a payment request has been successfully initiated.
`payment_declined`	Sent when a payment request has been rejected.
`payment_capture_pending`	Sent when a customer has successfully completed the redirect checkout flow.
`payment_captured`	Sent when the payment has been successfully captured.
`payment_canceled`	Sent when the customer cancels their payment or the payment expired automatically.
`payment_refund_accepted`	Sent when the refund of the payment has been (fully or partially) accepted.
`payment_refunded`	Sent when the payment has been (fully or partially) refunded.
`payment_refund_declined`	Sent when a refund has been declined.

View all of our webhook notifications.

To start testing, you'll need to contact your Customer Success Manager or Implementation Engineer to activate illicado payments in the sandbox environment.

Create an illicado transaction by following the Request a payment instructions.
Follow the redirect link in the response to illicado’s website.
Enter your card number and cryptogram.
Select Ajouter.
Confirm the values and select Terminer ma commande. You should be redirected to your provided success URL.

We've made some changes to our API

illicado
Beta

Information

Request a payment

Request example

Response example

Redirect the customer

Get details about a payment

Response example

Refund a payment

Request example

Response example

Cancel a payment

Webhooks

Testing illicado