Register Webhook Endpoints

Sovera sends webhooks to your callback URLs for the following notifications:

• Transaction Notifications, enlisted via Notification Enlist POST

• Credit Movements Notifications, also enlisted via Notification Enlist POST (beta)

• Integrated KYC Notifications, enlisted manually by our onboarding team during integration.

Register Webhook Endpoint

The transactions generated by the Mastercard network by cards created in the Sovera API are detailed in notifications via webhook that must be stored in a database to be consumed in a transaction management module.

These notifications are sent to a dedicated URL shared with the Sovera team securely by consuming the NotificationsEnlist POST endpoint. For the clients that uses our credit core, a new field named creditNotificationsURL was added, where is expected another dedicated URL to receive notifications related with the credit core, that contemplate information such as interests, executed values and amount owed.

The structure of the call employed to enlist a URL to receive Transaction Notifications and Credit Notifications is detailed below:

{
  "URL": "string",
  "Password": "string",
  "apiKey": "string",
  "creditNotificationsURL": "string"
}

{
  "id": "string",
  "clientid": "string",
  "Message": "Enlist created",
  "URL": "string",
  "apiKey": "",
  "creditNotificationsURL": "string",
  "creationDate": "2024-08-06T09:24:57.4887257+00:00"
}

The values for apiKey and password are optional, it is only necessary if the URL value has an authentication method to receive the webhooks. If not necessary an apiKey, it can be left as an empty value, between quotes, or not be included on the request. The Password, however, must be included on the request body and must be a non-empty string (an empty value is rejected by the API).

During integration, once the NotificationEnlist POST call is successfully made, a test should be managed with the Sovera integration team to verify the successful reception of transaction payloads.