> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/developer-guides/notifications-and-webhooks-overview/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# 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.

### Pay In events

<table>
  <thead>
    <tr>
      <th>
        Event
      </th>

      <th>
        Trigger
      </th>

      <th>
        Name in UI
      </th>

      <th>
        Webhook Payload
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        ApprovedPayment
      </td>

      <td>
        A transaction is approved
      </td>

      <td>
        Approved payment
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#approvedpayment)
      </td>
    </tr>

    <tr>
      <td>
        AuthorizedPayment
      </td>

      <td>
        A transaction is authorized, capture pending
      </td>

      <td>
        Authorized payment
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#authorizedpayment)
      </td>
    </tr>

    <tr>
      <td>
        DeclinedPayment
      </td>

      <td>
        A transaction is declined
      </td>

      <td>
        Declined payment
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#declinedpayment)
      </td>
    </tr>

    <tr>
      <td>
        FundedPayment
      </td>

      <td>
        A transaction is funded
      </td>

      <td>
        Funded payment
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#fundedpayment)
      </td>
    </tr>

    <tr>
      <td>
        InvoiceCreated
      </td>

      <td>
        An invoice is created
      </td>

      <td>
        Invoice created
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#invoicecreated)
      </td>
    </tr>

    <tr>
      <td>
        InvoicePaid
      </td>

      <td>
        Any payment is received for an invoice
      </td>

      <td>
        Invoices paid
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#invoicepaid)
      </td>
    </tr>

    <tr>
      <td>
        InvoiceSent
      </td>

      <td>
        An invoice is sent to customer
      </td>

      <td>
        Invoices sent
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#invoicesent)
      </td>
    </tr>

    <tr>
      <td>
        OriginatedPayment
      </td>

      <td>
        A transaction is originated
      </td>

      <td>
        Originated payments
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#originatedpayment)
      </td>
    </tr>

    <tr>
      <td>
        RefundedPayment
      </td>

      <td>
        A transaction is refunded
      </td>

      <td>
        Refunded payments
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#refundedpayment)
      </td>
    </tr>

    <tr>
      <td>
        RecoveredTransaction
      </td>

      <td>
        A timed-out transaction is recovered
      </td>

      <td>
        Recovered transaction
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#recoveredtransaction)
      </td>
    </tr>

    <tr>
      <td>
        SettledPayment
      </td>

      <td>
        A transaction is settled or sent to funding
      </td>

      <td>
        Settled payments
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#settledpayment)
      </td>
    </tr>

    <tr>
      <td>
        TransferAdjusted
      </td>

      <td>
        A transfer has been adjusted by Payabli
      </td>

      <td>
        Transfer adjusted
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transferadjusted)
      </td>
    </tr>

    <tr>
      <td>
        TransferDisabledCreditFund
      </td>

      <td>
        Credit funding failed because the merchant doesn't have an active credit service
      </td>

      <td>
        Transfer credit fund disabled
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transferdisabledcreditfund)
      </td>
    </tr>

    <tr>
      <td>
        TransferDisabledDebitFund
      </td>

      <td>
        Debit funding failed because the merchant doesn't have an active debit service
      </td>

      <td>
        Transfer debit fund disabled
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transferdisableddebitfund)
      </td>
    </tr>

    <tr>
      <td>
        TransferError
      </td>

      <td>
        Funding execution failed
      </td>

      <td>
        Transfer error
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transfererror)
      </td>
    </tr>

    <tr>
      <td>
        TransferNotAvailableBalance
      </td>

      <td>
        Funding execution pending because available balance doesn't cover the transfer
      </td>

      <td>
        Transfer not available balance
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transfernotavailablebalance)
      </td>
    </tr>

    <tr>
      <td>
        TransferReadyforRetry
      </td>

      <td>
        A transfer is ready to be retried by Payabli
      </td>

      <td>
        Transfer ready for retry
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transferreadyforretry)
      </td>
    </tr>

    <tr>
      <td>
        TransferResolved
      </td>

      <td>
        A transfer has been resolved by Payabli
      </td>

      <td>
        Transfer resolved
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transferresolved)
      </td>
    </tr>

    <tr>
      <td>
        TransferReturn
      </td>

      <td>
        Funding execution experienced a return, which is commonly due to insufficient funds, or problems with the external bank account
      </td>

      <td>
        Transfer return
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transferreturn)
      </td>
    </tr>

    <tr>
      <td>
        TransferSuccess
      </td>

      <td>
        Funding execution was successful
      </td>

      <td>
        Transfer success
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transfersuccess)
      </td>
    </tr>

    <tr>
      <td>
        TransferSuspended
      </td>

      <td>
        Merchant funding suspended
      </td>

      <td>
        Transfer suspended
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#transfersuspended)
      </td>
    </tr>

    <tr>
      <td>
        VoidedPayment
      </td>

      <td>
        A payment is voided or canceled
      </td>

      <td>
        Voided payments
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#voidedpayment)
      </td>
    </tr>
  </tbody>
</table>

### Pay Out events

<table>
  <thead>
    <tr>
      <th>
        Event
      </th>

      <th>
        Trigger
      </th>

      <th>
        Name in UI
      </th>

      <th>
        Webhook Payload
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        BillApproved
      </td>

      <td>
        A bill is approved to be paid
      </td>

      <td>
        Bills were approved
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#billapproved)
      </td>
    </tr>

    <tr>
      <td>
        BillCanceled
      </td>

      <td>
        A bill is canceled
      </td>

      <td>
        Bills were canceled
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#billcanceled)
      </td>
    </tr>

    <tr>
      <td>
        BillDisApproved
      </td>

      <td>
        A bill is disapproved to be paid
      </td>

      <td>
        Bills were rejected
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#billdisapproved)
      </td>
    </tr>

    <tr>
      <td>
        BillPaid
      </td>

      <td>
        A bill is paid
      </td>

      <td>
        Bills paid
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#billpaid)
      </td>
    </tr>

    <tr>
      <td>
        BillProcessing
      </td>

      <td>
        A payout is being processed for a bill
      </td>

      <td>
        Payment for bills in transit
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#billprocessing)
      </td>
    </tr>

    <tr>
      <td>
        PayOutCanceled
      </td>

      <td>
        A payout is canceled
      </td>

      <td>
        Payouts were canceled
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#payoutcanceled)
      </td>
    </tr>

    <tr>
      <td>
        PayOutFunded
      </td>

      <td>
        A payout is funded
      </td>

      <td>
        Payout funded
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#payoutfunded)
      </td>
    </tr>

    <tr>
      <td>
        PayOutPaid
      </td>

      <td>
        A payout is paid
      </td>

      <td>
        Payouts were paid
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#payoutpaid)
      </td>
    </tr>

    <tr>
      <td>
        PayOutProcessed
      </td>

      <td>
        A payout is processed
      </td>

      <td>
        Payouts were processed
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#payoutprocessed)
      </td>
    </tr>
  </tbody>
</table>

### Pay Ops events

#### Fraud and Risk events

<table>
  <thead>
    <tr>
      <th>
        Event
      </th>

      <th>
        Trigger
      </th>

      <th>
        Name in UI
      </th>

      <th>
        Webhook Payload
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        FraudAlert
      </td>

      <td>
        A fraud alert is triggered
      </td>

      <td>
        Fraud alerts
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#fraud-events)
      </td>
    </tr>

    <tr>
      <td>
        HoldTransaction
      </td>

      <td>
        A transaction is held
      </td>

      <td>
        Hold transaction
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#holdtransaction)
      </td>
    </tr>

    <tr>
      <td>
        HoldBatch
      </td>

      <td>
        A batch is held
      </td>

      <td>
        Hold batch
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#holdbatch)
      </td>
    </tr>

    <tr>
      <td>
        ReleasedBatch
      </td>

      <td>
        A held batch is released
      </td>

      <td>
        Released batch
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#releasedbatch)
      </td>
    </tr>

    <tr>
      <td>
        ReleasedTransaction
      </td>

      <td>
        A held transaction is released
      </td>

      <td>
        Released transaction
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#releasedtransaction)
      </td>
    </tr>
  </tbody>
</table>

#### Boarding events

<table>
  <thead>
    <tr>
      <th>
        Event
      </th>

      <th>
        Trigger
      </th>

      <th>
        Name in UI
      </th>

      <th>
        Webhook Payload
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        ActivatedMerchant
      </td>

      <td>
        A new merchant account is activated
      </td>

      <td>
        Paypoints activated
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#activatedmerchant)
      </td>
    </tr>

    <tr>
      <td>
        BoardingApplication
      </td>

      <td>
        An application sent to "boarding" status
      </td>

      <td>
        Paypoints boarded
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#boardingapplication)
      </td>
    </tr>

    <tr>
      <td>
        CreatedApplication
      </td>

      <td>
        A new boarding application is created
      </td>

      <td>
        Applications newly created
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#createdapplication)
      </td>
    </tr>

    <tr>
      <td>
        DeclinedApplication
      </td>

      <td>
        An application is declined
      </td>

      <td>
        Applications declined
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#declinedapplication)
      </td>
    </tr>

    <tr>
      <td>
        HoldingApplication
      </td>

      <td>
        An application is put on hold
      </td>

      <td>
        Application is under review
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#holdingapplication)
      </td>
    </tr>

    <tr>
      <td>
        SubmittedApplication
      </td>

      <td>
        A boarding application is sent to processing
      </td>

      <td>
        Applications submitted
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#submittedapplication)
      </td>
    </tr>

    <tr>
      <td>
        UnderWritingApplication
      </td>

      <td>
        An application is sent to underwriting
      </td>

      <td>
        Application is in underwriting
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#underwritingapplication)
      </td>
    </tr>
  </tbody>
</table>

#### Other

<table>
  <thead>
    <tr>
      <th>
        Event
      </th>

      <th>
        Trigger
      </th>

      <th>
        Name in UI
      </th>

      <th>
        Webhook Payload
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        exportFileError
      </td>

      <td>
        There was an error generating an export file
      </td>

      <td>
        File transmission aborted
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#exportfileerror)
      </td>
    </tr>

    <tr>
      <td>
        exportFileSent
      </td>

      <td>
        A generated export file is sent
      </td>

      <td>
        File sent
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#exportfilesent)
      </td>
    </tr>

    <tr>
      <td>
        importFileError
      </td>

      <td>
        An imported file was rejected because of errors
      </td>

      <td>
        File processing aborted by errors
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#importfileerror)
      </td>
    </tr>

    <tr>
      <td>
        importFileProcessed
      </td>

      <td>
        An imported file was processed
      </td>

      <td>
        File processed
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#importfileprocessed)
      </td>
    </tr>

    <tr>
      <td>
        importFileReceived
      </td>

      <td>
        A file is received for import data via Payabli eXchange
      </td>

      <td>
        File received
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#importfilereceived)
      </td>
    </tr>

    <tr>
      <td>
        UpdatedMerchant
      </td>

      <td>
        Triggered when a paypoint (merchant) record is updated
      </td>

      <td>
        N/A
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#updatedmerchant)
      </td>
    </tr>

    <tr>
      <td>
        ReceivedAchReturn
      </td>

      <td>
        A returned ACH is received
      </td>

      <td>
        ACH returns
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#receivedachreturn)
      </td>
    </tr>

    <tr>
      <td>
        ReceivedChargeBack
      </td>

      <td>
        A chargeback is received
      </td>

      <td>
        Credit card chargebacks
      </td>

      <td>
        [View](/developer-guides/webhook-payloads#receivedchargeback)
      </td>
    </tr>

    <tr>
      <td>
        Report
      </td>

      <td>
        Pre-defined event name for methods 

        **report-email**

         and 

        **report-web**
      </td>

      <td>
        N/A
      </td>

      <td />
    </tr>
  </tbody>
</table>

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)\[#set-up-webhooks]

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

> **Tip**
>
> See [Webhook Payload Reference](/developer-guides/webhook-payloads) for example notification webhook payloads.

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:

```json
{
  "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:

```json
{
  "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:

```json
{
  "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.

<table>
  <thead>
    <tr>
      <th>
        Value
      </th>

      <th>
        Key
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        Active
      </td>

      <td>
        1
      </td>
    </tr>

    <tr>
      <td>
        Inactive
      </td>

      <td>
        0
      </td>
    </tr>
  </tbody>
</table>

> If you're a software company, you're a payments company™