worldline Direct
Sign up

Pledg

Intro

Pledg is an instalment solution offered by the French banking Group Crédit Agricole.

By offering flexible instalment plans, you make your customers' purchases affordable, which improves your conversion rate and revenue. Your customers may choose to split their payment into three or four equal instalments over several months.

Since Pledg is directly integrated into established banking apps, your customers can use this payment method without any additional effort. Your customers enter their personal data on the Pledg portal. They confirm the order via their mobile device, adding another safety layer to the payment process. Pledg then charges your customers automatically for the individual instalments.
Pledg outsources the risk of payment defaults, as Pledg pays you upfront and collects the funds from your customers.

The integration is very easy, as you only need to send a few additional properties along with your request.

Overview

Payment group:
Payment product id:
5300
Key benefits
  • Low PCI requirements
  • Easy integration
  • Guaranteed payment
  • Allows partial/multiple/full refunds

Onboarding

To activate Pledg in your live account, follow these steps:

  1. Sign a contract with Pledg and receive activation credentials in return.
  2. Enter the credentials in the Merchant Portal and activate Pledg as described in our guide.

Countries & currencies

Supported countries

Supported currencies

  • Euro (EUR)

Integration

Redirect your customers to the Pledg portal 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":10000
      },
      "customer":{
         "merchantCustomerId":"customerId",
         "contactDetails":{
            "emailAddress":"customer.email@address.com"
         },
         "personalInformation": {
             "name": {
                 "firstName": "your-customer-first-name",
                 "surname": "your-customer-last-name"
              },
          },
          "locale":"fr_FR"
      },
      "references":{
         "descriptor":"your-payment-description",
         "merchantReference":"your-payment-reference"
      }
   },
   "hostedCheckoutSpecificInput":{
      "locale":"fr_FR"
   },
   "redirectPaymentMethodSpecificInput":{
      "paymentProductId":5300,
      "requiresApproval":false
   }
}
Properties Description

order.amountOfMoney
    amount
    currencyCode

amount: The gross amount you want to charge for this order.
currencyCode: The ISO 4217 currency code for this amount.

customer
    merchantCustomerId
    contactDetails.emailAddress
    personalInformation
            name
                 firstName
                 surname
    locale

merchantCustomerId: A unique identifier of your customer. Used by Pledg to send notifications.

emailAddress: Your customers' e-mail address. Used by Pledg to send notifications.

personalInformation: Your customers' first and surname.

locale: Just like the Hosted Checkout Page, Pledg is available in various languages. Populate it accordingly to display the Pledg portal in the language of your customers choice. The value is a combination of ISO 639-1 (language) and ISO 3166-1 (country):

  • French: fr_FR
  • English UK: en_UK
  • Spanish: es_ES
  • Italian: it_IT
  • Dutch: nl_NL
  • Portuguese: pt_PT

references
    merchantReference
    descriptor

merchantReference: Your unique reference to this order.

descriptor: A dynamic descriptor appearing on your customers' bank statement.
Although not mandatory, we strongly recommend adding it to your order for maximum transparency.

hostedCheckoutSpecificInput.locale

Our Hosted Checkout Page is available in various languages. The value is a combination of ISO 639-1 (language) and ISO 3166-1 (country). Find a list of all possible values in our Hosted Checkout Page guide.

redirectPaymentMethodSpecificInput
    paymentProductId
    requiresApproval

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 Pledg portal. If omitted, our platform sends your customers to the Hosted Checkout Page instead, allowing them to choose this or any other payment method that is active in your account.

requiresApproval: Set to "false" as this payment method allows only Direct Sale mode.

Find detailed information about this object and its properties in our CreateHostedCheckoutAPI.

Process flows

Depending on your customers' device(s) used, differences apply:

With a desktop and a mobile device

  1. Your customers finalise an order on their desktop device in your shop and select Pledg.
  2. You send this CreateHostedCheckout request to our platform.
  3. You redirect your customers on the desktop device via the redirectUrl  to the Pledg portal. They enter their personal data and select a modality.
  4. Your customers receive a notification in their banking app to confirm the order.
  5. We receive the transaction result.
  6. The mobile device displays the transaction result in the banking app. We redirect your customers to your returnUrl on their desktop device.
  7. You request the transaction result from our platform via GetPaymentDetails/GetHostedCheckout or receive the result via webhooks.
  8. If the transaction was successful, you can deliver the goods / service.
  9. Pledg charges your customers automatically for the remaining instalments within the arranged intervals.

    With a mobile device

    1. Your customers finalise an order on their mobile device in your shop and select Pledg.
    2. You send this CreateHostedCheckout request to our platform.
    3. You redirect your customers via the redirectUrl to the Pledg portal. They enter their personal data and select a modality.
    4. Your customers receive a notification in their banking app to confirm the order.
    5. We receive the transaction result.
    6. We redirect your customers to your returnUrl.
    7. You request the transaction result from our platform via GetPaymentDetails/GetHostedCheckout or receive the result via webhooks.
    8. If the transaction was successful, you can deliver the goods / service.
    9. Pledg charges your customers automatically for the remaining instalments within the arranged intervals.

    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.

    Was this page helpful?

    Do you have any comments?

    Thank you for your response.