Skip to content

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 2-step process:

  1. Request a payment
  2. Redirect the customer

Request a payment

For the full API specification, see the API reference.

    post

    https://api.checkout.com/payments

    Request example

    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
    }

    Response example

    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
      }

      Redirect the customer

      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.


      Get details about a payment

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

      Endpoints

      For the full API specification, see the API reference.

        post

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

        Response example

        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
        }

        Cancel a payment

        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.


        Webhooks

        You may receive the following webhooks when using CV Connect.

        WebhookDescription

        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.


        Testing CV Connect

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

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