Cpay
Intro
Cpay is a consumer credit card offered by the French acquirer BNP Paribas Personal Finance (BNP PF).
You can offer to your customers worldwide to pay by a varying amount of instalments (3, 5, 10, 20 or any other amount of months). Cpay cards are also usable as MasterCard.
Cpay specifics
Modalities
By default, the following modalities must be proposed to the customers:
- Credit
- Debit
- 5 months
- 10 months
- 20 months
You can profit from many more modalities. Please contact BNP PF to learn more about that.
Brands
Cpay cards are issued into many brands and split into two different type of cards:
- Enseigne (branded)
- Non-Enseigne (not branded)
Depending on whether you want to offer only one of them or both, branded ones must be configured. Each configured brand will be displayed as a different payment button on the Hosted Checkout Page.
Modalities must be individually configured per brand. A brand will only be displayed on the payment page once at least one modality is configured. Find an overview on all available modalities here.
Once you have agreed on the brands / modalities you would like to offer with BNP PF, our customer care team will take care of the configuration for you.
Integration
Process transactions 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": 12000
},
"customer": {
"billingAddress": {
"countryCode": "FR"
},
"contactDetails": {
"emailAddress": "customer@merchant.com"
}
},
"references": {
"merchantOrderId": "123456787",
"merchantReference": "",
"descriptor": "COM/DESC"
}
},
"hostedCheckoutSpecificInput": {
"locale": "fr_FR",
"returnUrl": "https://www.merchant.com",
"showResultPage": "true"
},
"cardPaymentMethodSpecificInput": {
"requiresApproval": true,
"skipAuthentication": false,
"paymentProduct5100SpecificInput": {
"brand": "CREDIT IN 5 MONTHS"
}
}
}
Properties | Remarks |
---|---|
order.customer.contactDetails.emailAddress |
Your customer’s e-mail address. |
cardPaymentMethodSpecificInput |
brand: 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 Cpay-branded version of our Hosted Checkout Page requiresApproval: Set to either "true"/"false" depending on whether you want to process payments in authorisation/direct sale mode. |
- Si vous définissez
requiresApproval
sur "true", assurez-vous de capturer la transaction plus tard via le Merchant Portal ou une requête CapturePayment. Ce n'est qu'alors que la transaction aurastatus="CAPTURED"
/statusOutput.statusCategory="COMPLETED"
/statusOutput.statusCode=9
, pour laquelle vous recevez le paiement réel de la transaction. - Avant de commencer à traiter des transactions, assurez-vous que les modalités de base au moins sont configurées dans votre compte Worldline. Apprenez-en plus à ce sujet ici.
Find detailed information about this object and its properties in our CreateHostedCheckoutAPI.
Process flows
- Your customers finalise an order in your shop and select Cpay.
- You send this CreateHostedCheckout request to our platform.
- You redirect your customers via the redirectUrl. Your customers enter their credit card number and select a modality. Depending on your customers’ choice, two scenarios are possible:
3'. (optional) Credit/Debit: We might redirect the customer to her/his issuing bank for 3-D Secure authentication. If the identification was successful, the flow continues at step 5. If the identification was unsuccessful, we redirect your customers to your returnUrl, ending the flow.
3’’. (optional) Instalment: You customers are redirected to a new page on which we show the financial conditions. If they accept, the flow continues at step 5. If not, we redirect your customers to your returnUrl, ending the flow. - We submit the actual financial transaction to the acquirer to process it. 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 / services.
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.
Additional information
Available features
Guaranteed payment | Yes |
Chargeback | No |
Refund | Yes (For payments with instalments, refunds are allowed only on the day of the authorization) |
Pre-authorization | No |
Authorisation | Yes (capture possible within 24hrs after the authorisatioin) |
Cancellation | Yes |
Alias | No |
Recurring | No |
Amount Limits | Depends on the chosen instalment |
List of modalities
As described in our payment methods specifics chapter, BNP PF offers a extensive range of different modalities. Please contact BNP PF to make them available for your customers!
Code | Modalities |
Does the consumer have to accept the financial conditions to open the credit? |
Minimum amount (€) / Maximum amount (€) |
04 | Credit | No | - |
05 | Cash | No | - |
09 | CREDIT 25 MONTHS | Yes |
330 / 4500 |
10 | CREDIT 9 MONTH FREE | Yes |
100 / 4500 |
14 | CREDIT IN 19 MONTHS | Yes |
150 / 4500 |
20 | CREDIT 8 MONTHS | Yes |
50 / 3000 |
21 | CREDIT 12 MONTHS | Yes |
300 / 1500 |
23 | CREDIT IN 15 MONTHS | Yes |
210 / 4500 |
33 | CREDIT IN 5 MONTHS | Yes |
75 / 4500 |
34 | CREDIT IN 10 MONTHS | Yes |
130 / 4500 |
35 | CREDIT IN 20 MONTHS | Yes |
270 / 4500 |
36 | CREDIT 9 MONTHS | Yes |
100 / 4500 |
37 | CREDIT 30 MONTH FREE | Yes |
400 / 4500 |
38 | CREDIT 30 MONTHS | Yes |
380 / 4500 |
48 | CREDIT IN 5 MONTHS FREE | Yes |
75 / 4500 |
50 | CREDIT 8 MONTHS FREE | Yes |
50 / 3000 |
51 | CREDIT 18 MONTHS FREE | Yes |
200 / 3000 |
52 | CREDIT 11 MONTHS | Yes |
120 / 1600 |
53 | CREDIT 11 MONTH FREE | Yes |
120 / 1600 |
54 | CREDIT IN 12 MONTHS FREE | Yes |
300 / 1500 |
55 | CREDIT IN 15 MONTHS FREE | Yes |
300 / 4500 |
56 | CREDIT IN 19 MONTHS FREE | Yes |
150 / 4500 |
57 | CREDIT 22 MONTHS | Yes |
120 / 1600 |
58 | CREDIT 22 MONTH FREE | Yes |
120 / 1600 |
65 | CREDIT IN 10 MONTHS FREE | Yes |
160 / 4500 |
68 | CREDIT IN 20 MONTHS FREE | Yes |
300 / 4500 |
69 | CREDIT 18 MONTHS | Yes |
200 / 3000 |
70 | 2 MONTHS DTS | Yes |
45 / 1500 |
71 | CREDIT IN 3 MONTHS | Yes |
45 / 4500 |
72 | 5M GENERIC CREDIT | Yes |
80 / 1500 |
73 | 10M GENERIC CREDIT | Yes |
165 / 1500 |
74 | 20M GENERIC CREDIT | Yes |
350 / 1500 |
75 | 25 MONTH FREE CREDIT | Yes |
350 / 1500 |
76 | 2 MONTHS FREE DTS | Yes |
45 / 1500 |
77 | CREDIT IN 3 MONTHS FREE | Yes |
45 / 1500 |