Notification

A classical Notification mechanism (aka IPN, Instant Payment Notification) is available.

Important notes:

Notifications are sent from 2 fixed IPs that may need to be whitelisted in merchant's infrastructure to properly receive the requests.
Requests use python-requests as User Agent. It may also be required to authorize this.
Use an https url (secure url), not http.

Success

The merchant backend can be notified of the purchase completion if the optional parameter paymentNotificationUrl is provided when the purchase is created.

This webhook is a POST and its body is a JSON which fields depend on the payment mode (see back mode, transfer mode).

Error

The merchant backend can be notified of an error occurring after the payment screen if the optional parameter errorNotificationUrl is provided when the purchase is created.

The notification is sent if the purchase state transitions to one of the following statuses:

`state`	`acceptance_state`
`ABORTED`	`ABANDONED`
`BI_CANCELLED`	`ABANDONED`
`BI_KO`	`REJECTED`
`BI_SCORING_KO`	`REJECTED`
`CONNECTOR_KO`	`REJECTED`
`FICP_FILTER_KO`	`REJECTED`
`FIRCOSOFT_FILTER_KO`	`REJECTED`
`IDENTIFICATION_CANCELLED`	`ABANDONED`
`IDENTIFICATION_KO`	`REJECTED`
`MERCHANT_TIMEOUT`	`REJECTED`
`PRIMARY_KO`	`REJECTED`
`RULE_ENGINE_FILTERS_KO`	`REJECTED`
`RULE_ENGINE_OPEN_BANKING_KO`	`REJECTED`
`SCORING_KO`	`REJECTED`
`SIGNATURE_CANCELLED`	`ABANDONED`
`SIGNATURE_KO`	`REJECTED`
`SUMMARY_CANCELLED`	`ABANDONED`
`TAX_NOTICE_CANCELLED`	`ABANDONED`
`TAX_NOTICE_KO`	`REJECTED`
`TMX_SCORING_KO`	`REJECTED`
`VCP_KO`	`REJECTED`

Important note on terminal vs. non-terminal error states:
Most error notifications correspond to terminal states (e.g., SCORING_KO, RULE_ENGINE_FILTERS_KO, SIGNATURE_KO, TAX_NOTICE_KO, MERCHANT_TIMEOUT, ABORTED, or any *_CANCELLED status). Once reached, the purchase is permanently closed and no further state transition will occur.
Currently, PRIMARY_KO and IDENTIFICATION_KO are the only identified error statuses that trigger an error notification while keeping the checkout session active (non-terminal states). The customer may still recover or complete the flow.

In case acceptance_state is REJECTED, acceptance_rejection_type and acceptance_rejection_subtypes will be populated with details.
In case acceptance_state is ABANDONED, acceptance_rejection_type and acceptance_rejection_subtypes will remain empty.
The notification is a POST request on errorNotificationUrl.

This webhook is a POST and its body is a JSON with the following fields:

json

{
   "reference" : "purchase_reference",
   "state" : "REVENUE_KO",
   "acceptance_state": "REJECTED",
   "acceptance_rejection_type": "NOT_ELIGIBLE",
   "acceptance_rejection_subtypes": ["Insufficient revenue"],
   "uid" : "pur_6c48d42b-f29b-4f84-bee8-3cb2b964b600",
   "loan_short_id": "1UW7Z0F5D21"
}

Notification ​

Success ​

Error ​

Notification

Success

Error