Integration of the Pledg payment solution

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 becomes one of BI_CANCELLED, BI_KO, BI_SCORING_KO, CONNECTOR_KO, PRIMARY_KO, REVENUE_KO, SCORING_KO, TMX_SCORING_KO, VCP_KO, FIRCOSOFT_FILTER_KO, FICP_FILTER_KO, RULE_ENGINE_FILTERS_KO, RULE_ENGINE_OPEN_BANKING_KO, COVERAGE_KO, MERCHANT_TIMEOUT, IDENTIFICATION_KO, SIGNATURE_KO .
  • The related acceptance_state is one of ABANDONED, REJECTED.
  • 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",
   "uid" : "pur_6c48d42b-f29b-4f84-bee8-3cb2b964b600",
   "loan_short_id": "1UW7Z0F5D21"
}

If there is a secret in the configuration of your merchant, it will be used to sign the notification body with jwt. In this case, only the signature is sent.

{
    "signature" : "eyJhbGciOiJIUzI1NiJ9.eyJyZWZlcmVuY2UiOiJwdXJjaGFzZV9yZWZlcmVuY2UiLCJzdGF0ZSI6IlJFVkVOVUVfS08iLCJhY2NlcHRhbmNlX3N0YXRlIjoiUkVKRUNURUQiLCJ1aWQiOiJwdXJfNmM0OGQ0MmItZjI5Yi00Zjg0LWJlZTgtM2NiMmI5NjRiNjAwIiwibG9hbl9zaG9ydF9pZCI6IjFVVzdaMEY1RDIxIn0.iVPkN4Zpih6sfCl0g8EnXUrETIUli0Z7YETUARRich4"
}