The Partner API allows the use of a webhooks to get notified of a transaction status evolution. We use the details used in the initialize call to notify you.
For "Gateway" type integrations, where the customer is redirected to a Cofidis page, you also get informed of the journey output when the customer is redirected back to your page.
The integrator is free to incorporate their own elements into the URLs. However, the domain name used in the different URLs must be identical. It is also possible to have all URL values identical. You will need to contact our integration teams so that they can make the necessary configurations for the use of your notification URLs.
Redirections
Redirection url are specified in the initialize call with the following fields in object “technicalData”:
- “returnUrlSuccess”: If the journey end with an acceptation, you would receive to “to_confirm” status
- “returnUrlOther”: If the journey end with a “Refused” or a “pending”
The data is shared using a Post request, see details bellow:
Content-Type: application/x-www-form-urlencoded
transactionKey: {
"merchantCountry": "fr",
"providerId": "providrid",
"providerTransactionId": null,
"merchantId": "020280098",
"merchantTransactionId": "2YgKoUd4DB",
"merchantTransactionDate": "20260227"
}
transactionStatus: pending
Notifications
Warning : To have access to notifications, it is necessary to whitelist the domain name IPs with Cofidis. If you intend to use this feature, please reach your Cofidis point of contact.
Notification url are specified in the initialize call with the following fields in object “technicalData”:
- “notificationUrlSuccess”: Used to send a transaction notification when status change to “to_confirm”, if it happens at the end of journey, it will double the redirection to avoid issue in the journey page is closed before redirection.
- “notificationUrlPending”: Used to send a transaction notification:
- In the different ”pending” status and substatus
- For the final decision (to_confirm or refused) on a transaction that was in the pending status.
- “notificationUrlOther”: Used to send a transaction notification when status change to “refused”, ”aborted”, or another status including errors.
The data is shared using a Post request, see details bellow:
Content-Type: application/x-www-form-urlencoded
transactionKey: {
"merchantCountry": "fr",
"providerId": "providrid",
"providerTransactionId": null,
"merchantId": "020280098",
"merchantTransactionId": "2YgKoUd4DB",
"merchantTransactionDate": "20260227"
}
transactionStatus: pending
subState: signed