Chèque-Vacances Connect
Beta

Last updated: December 16, 2022

Start accepting payments using Chèque-Vacances (CV) Connect, a popular digital wallet service 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	Digital wallet
One-step payment
Authorization
Capture
Refund
Partial refund
Chargeback
Recurring payment

CV Connect has a two-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": "cvconnect"
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_uvvyrp2pspxuff2l4ewolohvwe",
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": "511870202099"
16  },
17  "_links": {
18    "self": {
19      "href": "https://api.sandbox.checkout.com/payments/pay_uvvyrp2pspxuff2l4ewolohvwe"
20    },
21    "redirect": {
22      "href": "https://payment.limonetikqualif.com/CVConnect/Order/PayPage/511870202099"
23    }
24  }
25}


1{
2  "id": "pay_u2knzrnrtutuhixh33nmawx5mu",
3  "requested_on": "2022-08-03T11:42:22.3468736Z",
4  "source": {
5    "type": "cvconnect"
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": "151164437548"
33  },
34  "_links": {
35    "self": {
36      "href": "https://api.sandbox.checkout.com/payments/pay_u2knzrnrtutuhixh33nmawx5mu"
37    },
38    "actions": {
39      "href": "https://api.sandbox.checkout.com/payments/pay_u2knzrnrtutuhixh33nmawx5mu/actions"
40    },
41    "refund": {
42      "href": "https://api.sandbox.checkout.com/payments/pay_u2knzrnrtutuhixh33nmawx5mu/refunds"
43    }
44  }
45}

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 CV Connect 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_uvvyrp2pspxuff2l4ewolohvwe",
3  "requested_on": "2022-07-26T09:06:15.3949215Z",
4  "source": {
5    "type": "cvconnect"
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": "511870202099"
23  },
24  "_links": {
25    "redirect": {
26      "href": "https://payment.limonetikqualif.com/CVConnect/Order/PayPage/511870202099"
27    },
28    "self": {
29      "href": "https://api.sandbox.checkout.com/payments/pay_uvvyrp2pspxuff2l4ewolohvwe"
30    },
31    "actions": {
32      "href": "https://api.sandbox.checkout.com/payments/pay_uvvyrp2pspxuff2l4ewolohvwe/actions"
33    }
34  }
35}

Once a payment is created, you cannot void it. 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 CV Connect.

Webhook	Description
`payment_pending`	Sent when a payment request has been successfully initiated.
`payment_canceled`	Sent when the customer cancels their payment or the payment expires automatically.
`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.

View all of our webhook notifications.

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

Create a CV Connect transaction by following the Request a payment instructions.
Follow the redirect link in the response to CV Connect’s website.
Enter your account email address.
Validate your transaction in your CV Connect mobile app.
You should be redirected to your predefined success URL.

We've made some changes to our API

Chèque-Vacances Connect
Beta

Information

Request a payment

Request example

Response example

Redirect the customer

Get details about a payment

Endpoints

Response example

Cancel a payment

Webhooks

Testing CV Connect