Cofidis 3x/4x
Intro
As Cofidis offer various brands, multiple paymentProductId exist. Find all possible values in the Integration chapter.
Cofidis 3x/4x is an instalment solution offered by Cofidis.
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. Your customers enter their card (Visa, MasterCard or Carte Bancaire) and personal details on the Cofidis payment page. Cofidis then charges your customers automatically for the individual instalments.
Cofidis 3x/4x outsources the risk of payment defaults, as Cofidis pays you upfront and collects the funds from your customers.
The integration is very easy, as you only need to send some additional parameters along with your request.
Boarding
To use Cofidis for either in our test/live enviroment, follow these steps:
- Sign a contract with Cofidis and receive activation credentials in return.
- Send the activation credentials (MID/password and possibly other credentials) to us.
- We do the necessary onboarding and provisioning check.
- We activate the payment method in your account.
France
Integration
Redirect your customers to the Cofidis payment page 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": 100000
},
"customer": {
"personalInformation": {
"name": {
"title": "Mr.",
"firstName": "Wile",
"surname": "Coyote"
},
"gender": "male",
"dateOfBirth": "19490917"
},
"billingAddress": {
"street": "Desertroad",
"houseNumber": "13",
"zip": "84536",
"city": "Monument Valley",
"state": "Utah",
"countryCode": "US"
},
"shippingAddress": {
"street": "Desertroad",
"houseNumber": "1",
"zip": "84536",
"city": "Monument Valley",
"state": "Utah",
"countryCode": "US"
},
"contactDetails": {
"emailAddress": "wile.e.coyote@acmelabs.com",
"phoneNumber": "0611111111"
}
},
"references": {
"merchantReference": "ORDERIDxx"
},
"shoppingCart": {
"items": [
{
"amountOfMoney": {
"currencyCode": "EUR",
"amount": 100000
},
"orderLineDetails": {
"productName": "ACME12",
"discountAmount": 0,
"lineAmountTotal": 100000,
"productCode": "ASO45",
"productPrice": 100000,
"productType": "Fashion",
"quantity": 1,
"taxAmount": 0,
"unit": "piece"
}
}
]
}
},
"hostedCheckoutSpecificInput": {
"locale": "fr_FR"
},
"redirectPaymentMethodSpecificInput": {
"requiresApproval": true,
"paymentProductId": 5129
}
}| Property | Remarks |
|---|---|
|
order.amountOfMoney |
amount: The gross amount you want to charge for this order. currencyCode: The ISO 4217 currency code for this amount. |
|
customer |
Your customers's personal information. |
|
customer |
Your customers's billing/shipping address. If you do not send billingAddress, your customers will have to provide this data on the Cofidis payment page. |
|
shoppingCart |
The content of the shopping cart as an array of items objects. amountOfMoney.amount: The full amount of the items, calculated as orderLineDetails.productPrice X orderLineDetails.quantity Make sure to calculate the value for order.amountOfMoney.amount by adding up all instances of shoppingCart.items.amountOfMoney.amount |
|
hostedCheckoutSpecificInput.locale |
The language version of our Hosted Checkout Page. |
|
redirectPaymentMethodSpecificInput |
paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the list below. It instructs our platform to send your customers directly to the Cofidis payment page. If left out, our platform sends your customers to the Hosted Checkout Page instead, allowing them to choose this or any other payment method in your account. requiresApproval: Set to either "true"/"false" depending on whether you want to process payments in authorisation("true")/direct sale mode ("false").
Make sure that you capture authorised transaction later. Only then will the transaction have status="CAPTURED" / statusOutput.statusCategory="COMPLETED" / statusOutput.statusCode=9, for which you receive the actual payment for the transaction.
returnUrl: The URL we redirect your customers to after the payment has been finalised.
|
Find detailed information about this object and its properties in our CreateHostedCheckoutAPI.
List of available Cofidis brands
| Brand | paymentProductId |
|---|---|
|
Cofidis 3x For splitting the payment into three installments |
5129 |
|
Cofidis 4x For splitting the payment into fourinstallments |
5130 |
Process flows
- Your customers finalise an order in your shop and select Cofidis 3x/4x.
- You send this CreateHostedCheckout request to our platform.
- You redirect your customers via the redirectUrl to the Cofidis payment page. They confirm the order with their card and personal data.
- We receive the transaction result.
- We redirect your customer to your returnUrl
- You request the transaction result from our platform via GetPayment or receive the result via webhooks.
- If the transaction was successful, you can deliver the goods / service.
- Cofidis 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.