You will find in the following sections details on all available API calls.
This page contains information about standard integration for both Web and Retail. For specific cases, technical elements provided by Cofidis must be preferred over the information contains hereafter. Each API section contain a Swagger with full detail about the method.
Please find bellow the list of ‘special characters’ mentioned in the swaggers:
| Characters | ; | . | @ | + | - | % | * | / | _ | |
|---|---|---|---|---|---|---|---|---|---|---|
| Description | Colon | Full Stop | Space | At sign | Plus Sign | Dash | Percent | Asterisk | Fwd Slash | Underscore |
Note: A specific integration might be required for your country, check the menu to see if a section “API – Your Country Name” is present.
Web
Following diagram details the internal states taken by the API. It covers Web integrations with “captureMode” set to “Immediate” cf API initialize. A full list of possible States is also available in API getStatus.
API State Diagram for WEB applications with captureMode field set to IMMEDIATE.
Please find bellow recommended processes. If your specific needs fall outside of the presented process, please contact Cofidis.
Using Webhook
- Call API initialize and redirect customer to Cofidis Journey as soon as you receive the redirection link
- Within 50 minutes after redirection to the journey
- Redirection must be received from Cofidis with a state from the journey
- If not call getStatus, to receive either a decision state or an “Aborted” state
- When receiving state “To_confirm” call API confirm
- confirm return contains the new state, if it’s “Validated” the transaction is Financed, it’s the final state you need to reach for a valid transaction
- If you need to refund part of or the whole transaction
- You might call getStatus to get the available amounts
- Call API refund
- you refunded everything new status will be “Refunded” else it will stay on “Validated”
Without Webhook
- Call API initialize and redirect customer to Cofidis Journey as soon as you receive the redirection link
- Call getStatus after 20minutes then if Status is “Undefined” 30 minutes later.
- If Status is “Pending”
- You can call getStatus between once a day and once every two hours for your “Pending” transactions
- Don’t call getStatus during Weekend or Between 18:00 and 8:00 CEST
- When receiving state “To_confirm” call API confirm
- confirm return contains the new state, if it’s “Validated” the transaction is Financed, it’s the final state you need to reach for a valid transaction
- If you need to refund part of or the whole transaction
- You might call getStatus to get the available amounts
- Call API refund
- If you refunded everything new status will be “Refunded” else it will stay on “Validated”
Retail
Following schematic details, the internal states taken by the API. It covers Retail integrations.
API State Diagram for RETAIL applications.
Please contact Cofidis for a recommended integration depending on your needs, organization, desired products and specific legal requirements.
API integration mostly fall into two categories:
Direct financing
After acceptance by Cofidis, as soon as contract is signed, the financing is triggered (payment of partner and Start of the customer payment schedule)
Two-step financing
After Acceptance by Cofidis, the partner needs to signal the product has been delivered to trigger financing (payment of partner and Start of the customer payment schedule)