Webhook notifications

Real-time communication between your platform and Olipay's.

Webhook notifications are a way to keep real time communication alive between the platforms.

This allows to, for example, communicate to your users using your branding about the pending installments, payments, or any changes in the history of the loan.

The events listed below are the common to all integrations, but depending on the needs we can add custom ones to one integration.

Structure of an event

Events, regarding of been originated by OliPay or your platform, always have the same structure:

{
  "type": "category.event_name",
  "payload": {
    ...
  }
}

The list of valid type values depends on them been outgoing (from OliPay to your platform) or incoming (from your platform to OliPay).

payload keys and values are defined per-event.

Outgoing webhook notifications

Outgoing webhook notifications are sent from OliPay to your platform. The endpoint is defined at onboarding time and can be updated via the control panel.

Type

Payload keys

Description

loan.emitted

  • document: Users document number.
  • id: offer identifier, present in the authorization response payload.
  • ccb_url: URL of the digitally signed document.

Informs about a new loan emitted.

loan.canceled

  • id: offer identifier, present in the authorization response payload.

Informs about a loan that was cancelled. Could happen because the user regret it or some other post-capture event.

loan.paid

  • id: offer identifier.

Informs that the whole loan was paid.

installment.paid

  • id: offer identifier.
  • installment_id: id identifying the installment.
  • number: Installment number.
  • amount: amount paid.
  • timestamp: ISO8601 timestamp with the date it was paid.
  • method: if it was via pix or boleto.

Notifies about an installment being paid.

installment.overdue

  • id: offer identifier.
  • installment_id: id identifying the installment.
  • number: Installment number.
  • amount: amount paid.
  • due_date: ISO8601 date with the date it was supposed to be paid.

Notifies about an installment been overdue.

Incoming webhook notifications

Type

Payload keys

Description

activity.