Notifications and Reports Overview

Payabli has a notifications engine that lets you create notifications for various events using different communication channels: email, phone (SMS) and web (webhooks). The engine also lets you autogenerate reports and send them via email or webhook.

​

Notifications

Get near-instant notifications via email, SMS, or webhooks for important events like new payment disputes, merchant activations, fraud alerts, approved transactions, settlement history, vendor payouts, and more. Use webhooks with notifications to get real-time updates and automate operations based on key those key events.

An event alerts you when an action has been completed. When you create a notification for an event, Payabli adds a notification to the notification queue within 5 minutes of the event trigger. The notification engine sends the notification’s information to the target via the channel you configure, either web (webhooks), SMS, or email. The information provided with each notification varies by type.

In the following tables:

• The Event column is the eventType value used with the notification API.
• The Trigger column describes what triggers the event.
• The Name in Web App column describes the notification name in the web app’s notification settings page.

​

Money in events

​

Money out events

​

Boarding events

​

Other

For email and SMS methods, The notification includes only the notification content in the email body or in the text for SMS.

​

Set up and receive events using Web (webhooks)

For webhook notifications, Payabli offers flexibility so you can build and use the notifications as needed.

The web notifications are sent to the target URL via HTTP POST. When you create the notification, specify any custom headers or fields to submit with the event in the request. The notification uses standard HTTPS ports: 80, 443, 8080, or 4443.

If needed, you can include an Authorization header for your webhook server in the field webHeaderParameter in the content object. For example, if your webhook server requires basic authorization and your key is AD4566F3S2T76901, then your request would look like this:

{
  "ownerId": 20,
  "ownerType": 0,
  "method": "web",
  "frequency": "untilcancelled",
  "target": "https://mywebhook.domain.com/entrypoint",
  "content": {
    "eventType": "ApprovedPayment",
    "webHeaderParameters":[
    {"Authorization":"Basic AD4566F3S2T76901"}
    ]
  }
}

You can also send any other variable in the body with some custom data using the field internalData in the content object:

{
  "ownerId": 20,
  "ownerType": 0,
  "method": "web",
  "frequency": "untilcancelled",
  "target": "https://mywebhook.domain.com/entrypoint",
  "content": {
    "eventType": "ApprovedPayment",
    "webHeaderParameters":[
    {"Authorization":"Basic AD4566F3S2T76901"}
    ],
    "internalData":[
    {"myData1":"Value1"},
    {"myData2":"Value2"}
    ]
  }
}

​

Retry logic

If sending the webhook fails, Payabli retries the webhook POST 5 times in 5-minute intervals. If the request fails after 5 retries, it stays in the queue with the status failed for 48 hours. You can request that Payabli re-send it manually if necessary.

​

Send a 200 response

Your webhook server must send a 200 response when the payload is successfully received. If you send nothing, or anything other than a 200 response, Payabli assumes it has failed and the retry logic causes the payload to be sent several times.

​

Automated reports

Automated reporting lets you gather critical reports without manually filtering and exporting the data. Get automated daily, weekly, and monthly report for daily sales, ACH returns, settlements, and more. You can send these reports via email or via webhook.

The notification engine lets you schedule autogenerated reports with different frequencies: “daily”, “weekly”, “biweekly”, “monthly”, “quarterly”, “semiannually”, “annually”. The reports are sent to the target (destination) using either report-email or report-web where the expected targets are email address or a URL.

For method report-email the report is attached to an email. For the method report-web the file is sent via HTTP POST as “multipart/form-data” and in the field file. Like with events, you can specify custom headers and internal data to be passed to your application in the HTTP request.

You can generate the files in CSV, XLSX, and JSON format.

This example creates a daily transaction report and sends it via email:

{
  "ownerId": 20,
  "ownerType": 0,
  "method": "report-email",
  "frequency": "daily",
  "target": "myemail@myDomain.com",
  "content": {
      "fileFormat":"csv",
      "reportName":"Transaction"
  }
}

​

Notification status

When you create or manage a notification or autogenerated report via the API, you can enable or disable it with the status parameter. Setting a notification to Inactive disables it, and setting it to Active enables it.