# Webhook notification response reference

> Complete webhook payload reference for all Payabli events. Understand the structure and data sent for transactions, boarding, settlements, disputes, and operational notifications

<AudienceInfo audiences={['developers', 'partners']} />

## Response header

Each response payload has this header:

<CodeBlocks>
  ```curl Sandbox header
  Content-Length: <content length>
  Content-Type: application/json; charset=utf-8
  Accept: */*
  String: string
  Host: 52.3.204.115
  ```

  ```curl Production header
  Content-Length: <content length>
  Content-Type: application/json; charset=utf-8
  Accept: */*
  String: string
  Host: 54.166.54.170
  ```
</CodeBlocks>

## Pay In events

### ApprovedPayment

Triggered when a payment is approved.

```json Response body
{
  "Event": "ApprovedPayment",
  "Paypoint": "Athlete Factory LLC\r\n",
  "Text": "Payment Approved!",
  "transId": "10-33eb676a-da48-401f-9494-e69a324b152d",
  "NetAmount": "100.00",
  "Fee": "0.00",
  "TotalAmount": "100.00",
  "transTime": "04/04/2022 13:56:17",
  "CustomerId": "224",
  "CustomerNumber": "888",
  "Method": "card",
  "WalletType": null,
  "EntryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>",
  "ResponseCode": "100",
  "ResponseCodeText": "Operation successful",
  "ResultCode": "A0000",
  "ResultCodeText": "Approved"
}
```

### AuthorizedPayment

Triggered when a payment is authorized.

```json Response body
{
  "Event": "AuthorizedPayment",
  "Paypoint": "Athlete Factory LLC \r ",
  "Text": "Payment Authorized!",
  "AccountType": "4XXXXXX0000",
  "transId": "10-4e986895-8085-41ac-87db-9f74ff640e19",
  "NetAmount": "100.00",
  "Fee": "2.00",
  "TotalAmount": "102.00",
  "transTime": "5/23/2022 1:50:50 PM",
  "CustomerId": "224",
  "CustomerNumber": "888",
  "Method": "card",
  "WalletType": null,
  "EntryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>",
  "ResponseCode": "100",
  "ResponseCodeText": "Operation successful",
  "ResultCode": "A0000",
  "ResultCodeText": "Approved"
}
```

### DeclinedPayment

Triggered when a transaction is declined. This notification triggers for all declined transactions, including declined cards and ACH.

```json Response body
{
  "Event": "DeclinedPayment",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment Declined!",
  "transId": "10-073d7d504e3c4357be3ff904f9653b4a",
  "NetAmount": "0.05",
  "Fee": "0.00",
  "TotalAmount": "0.05",
  "transTime": "9/18/2023 7:20:14 PM",
  "CustomerId": "1323",
  "CustomerNumber": "customer-xchg_004",
  "Method": "card",
  "WalletType": null,
  "EntryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>",
  "ResponseCode": "201",
  "ResponseCodeText": "Do not honor. The customer's issuing bank is unwilling to accept the transaction.",
  "ResultCode": "D0100",
  "ResultCodeText": "Do not honor"
}
```

### FundedPayment

Triggered when a payment is funded.

```json Response body
{
  "Event": "FundedPayment",
  "Paypoint": "Gruzya Adventure Outfitters",
  "AccountType": "4111 1XXXXXX1111",
  "Text": "Payment Funded",
  "BatchNumber": "BT-2023042102-XXX",
  "Method": "card",
  "SettlementDate": "2023-04-21T00:00:00",
  "ExpectedDepositDate": "2023-04-22T00:00:00",
  "transId": "179-67f4b500f7a840cfXXXXXXdd7a2447b",
  "NetAmount": "1.99",
  "CustomerId": "1000",
  "CustomerNumber": "clgld5wa600XXXX8n8ijx",
  "WalletType": null, 
  "EntryPoint": "entry289", 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### InvoiceCreated

Triggered when an invoice is created.

```json Response body
{
  "Event": "InvoiceCreated",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Invoice Created!",
  "InvoiceId": 3156,
  "InvoiceNumber": "200622",
  "TotalAmount": "0.00",
  "CustomerId": "Lisandra L Sosa",
  "CustomerNumber": "customer-xchg_004",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### InvoicePaid

Triggered when a payment is received for an invoice. This event is triggered by both partial and full payments.

```json Response body
{
  "Event": "InvoicePaid",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment received!",
  "InvoiceId": 127,
  "InvoiceNumber": "66547688",
  "TotalAmount": "2.00",
  "TotalPaidAmount": "2.00",
  "CustomerId": "Peter Rose",
  "CustomerNumber": "12345",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### InvoiceSent

Triggered when an invoice is sent to a customer.

```json Response body
{
  "Event": "InvoiceSent",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Invoice Sent!",
  "InvoiceId": 121,
  "InvoiceNumber": "9011021",
  "TotalAmount": "1.00",
  "CustomerId": "Peter Rose",
  "CustomerNumber": "901102",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### OriginatedPayment

Triggered when a payment was originated.

```json Response body
{
  "Event": "OriginatedPayment",
  "Paypoint": "Mount Athos Homeowners Association",
  "AccountType": "",
  "BatchNumber": "checkcommerce_134159_ach_03-10-2023",
  "Text": "Payment Originated/Batched",
  "Method": "ach",
  "ExpectedDepositDate": "2023-03-10T00:00:00",
  "transId": "31-ff7d46e7-d420-4135-b50b-cdbb3f48fe52",
  "NetAmount": "2558.37",
  "CustomerId": "",
  "CustomerNumber": "",
  "WalletType": null,
  "EntryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### RefundedPayment

Triggered when a payment is refunded.

```json Response body
{
  "Event": "RefundedPayment",
  "Paypoint": "Athlete Factory LLC\r\n",
  "Text": "Payment Refunded!",
  "transId": "10-7c9a106e-60fd-4638-a4e9-a2b86d16dcb0",
  "NetAmount": "-50.00",
  "Fee": "0.00",
  "TotalAmount": "-50.00",
  "transTime": "04/04/2022 13:56:23",
  "Notes": "Refunding Transaction 10-33eb676a-da48-401f-9494-e69a324b152d",
  "CustomerId": "224",
  "CustomerNumber": "888",
  "Method": "card",
  "WalletType": null,
  "EntryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>",
  "ResponseCode": "100",
  "ResponseCodeText": "Operation successful",
  "ResultCode": "A0000",
  "ResultCodeText": "Approved"
  "RefundingTransactionId": "69539-9d327eb7c70b47c5a3156d3cdcfd1a95"
}
```

### RecoveredTransaction

Triggered when a transaction times out and is recovered.

```json Response body
{
  "Event": "RecoveredTransaction",
  "Paypoint": "Gruzya Adventure Outfitters",
  "Text": "We automatically recovered a transaction for Gruzya Adventure Outfitters",
  "Logo": "https://payabli.com/public-logos/pe243.png",
  "transId": "245-c5eb234fc6ab41b9b84e278080b69dfb",
  "NetAmount": "$8.00",
  "Fee": "$0.00",
  "TotalAmount": "$8.00",
  "transDate": "8/23/2023", 
  "transTime": "8/23/2023 19:34:42",
  "Notes": null,
  "Customer": "Greicy Gasca",
  "CustomerEmail": "greicy@example.com",
  "CustomerPhone": "+(786) 555-6341",
  "CustomerNumber": "901102",
  "ContactUs": "https://gruzyaadventures.com/",
  "Method": "card",
  "EntryPoint": "entry289", 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### SettledPayment

Triggered when a payment is settled or sent to funding.

```json Response body
{
  "Event": "SettledPayment",
  "Paypoint": "Mount Athos Homeowners Association",
  "AccountType": "",
  "Text": "Payment Settled",
  "BatchNumber": "checkcommerce_134159_ach_03-10-2023",
  "Method": "ach",
  "SettlementDate": "2023-03-10T00:00:00",
  "ExpectedDepositDate": "2023-03-10T00:00:00",
  "transId": "31-ff7d46e7-d420-4135-b50b-cdbb3f48fe52",
  "NetAmount": "2558.37",
  "CustomerId": "224",
  "CustomerNumber": "888",
  "WalletType": null,
  "EntryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### SubscriptionCreated

Triggered when a subscription is created.

```json Response body
{
  "Event": "SubscriptionCreated",
  "Paypoint": "Example Company Name",
  "Text": "A subscription was created for Example Company Name",
  "SubscriptionId": 12345,
  "Changes": "Created",
  "Status": "Active", 
  "Method": "Card",
  "Last4": "6543",
  "StoredMethodId": "card_123456789", 
  "TotalAmount": "$99.99",
  "NetAmount": "$95.99",
  "FeeAmount": "$4.00",
  "Currency": "USD",
  "StartDate": "2023-06-01",
  "EndDate": "2024-06-01",
  "Frequency": "Monthly",
  "CreatedAt": "2023-06-01 14:30:00",
  "UpdatedAt": "2023-06-01 14:30:00",
  "ContactUs": "support@example.com | (555) 123-4567",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### SubscriptionUpdated

Triggered when a subscription is updated.

```json Response body
{
  "Event": "SubscriptionUpdated",
  "Paypoint": "Example Company Name",
  "Text": "A subscription was updated for Example Company Name",
  "SubscriptionId": 12345,
  "Changes": "EndDate, Frequency",
  "Status": "Active",
  "Method": "Card",
  "Last4": "6543",
  "StoredMethodId": "card_123456789",
  "TotalAmount": "$99.99",
  "NetAmount": "$95.99",
  "FeeAmount": "$4.00",
  "Currency": "USD",
  "StartDate": "2023-06-01",
  "EndDate": "2024-06-01",
  "Frequency": "Monthly",
  "CreatedAt": "2023-06-01 14:30:00",
  "UpdatedAt": "2023-06-05 10:15:00",
  "ContactUs": "support@example.com | (555) 123-4567",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### SubscriptionCanceled

Triggered when a subscription is canceled.

```json Response body
{
  "Event": "SubscriptionCanceled",
  "Paypoint": "Example Company Name",
  "Text": "A subscription was canceled for Example Company Name",
  "SubscriptionId": 12345,
  "Changes": "Cancelled",
  "Status": "Cancelled",
  "Method": "Card",
  "Last4": "6543",
  "StoredMethodId": "card_123456789",
  "TotalAmount": "$99.99",
  "NetAmount": "$95.99",
  "FeeAmount": "$4.00",
  "Currency": "USD",
  "StartDate": "2023-06-01",
  "EndDate": "2024-06-01",
  "Frequency": "Monthly",
  "CreatedAt": "2023-06-01 14:30:00",
  "UpdatedAt": "2023-06-10 16:45:00",
  "ContactUs": "support@example.com | (555) 123-4567",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### SubscriptionCompleted

Triggered when a subscription is completed (past the end date).

```json Response body 
{
  "Event": "SubscriptionCompleted",
  "Paypoint": "Example Company Name",
  "Text": "A subscription was completed for Example Company Name",
  "SubscriptionId": 12345,
  "Changes": "Completed",
  "Status": "Completed",
  "Method": "Card",
  "Last4": "6543",
  "StoredMethodId": "card_123456789",
  "TotalAmount": "$99.99",
  "NetAmount": "$95.99",
  "FeeAmount": "$4.00",
  "Currency": "USD",
  "StartDate": "2023-06-01",
  "EndDate": "2024-06-01",
  "Frequency": "Monthly",
  "CreatedAt": "2023-06-01 14:30:00",
  "UpdatedAt": "2024-06-01 00:00:00",
  "ContactUs": "support@example.com | (555) 123-4567",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### BatchClosed

Triggered when a batch is closed.

```json Response body
{
  "Event": "BatchClosed",
  "Paypoint": "HOA SmartPayments Network",
  "Text": "A batch has been closed for HOA SmartPayments Network",
  "BatchId": 34159,
  "BatchAmount": "$38.00",
  "BatchDate": "5/16/2025 12:00:00\u202fAM",
  "ContactUs": "www.leo-testing.com | (178) 671-2216",
  "ExternalPaypointId": null
}
```

### BatchNotClosed

Triggered when a batch isn't closed.

```json Response body
{
  "Event": "BatchNotClosed",
  "Paypoint": "HOA SmartPayments Network",
  "Text": "A batch has not been closed for HOA SmartPayments Network",
  "BatchId": 34159,
  "BatchAmount": "$38.00",
  "BatchDate": "5/16/2025 12:00:00\u202fAM",
  "ContactUs": "www.leo-testing.com | (178) 671-2216",
  "ExternalPaypointId": null
}
```

### TransferAdjusted

Triggered when a transfer is adjusted.

```json Response body
{
  "Event": "TransferAdjusted",
  "Paypoint": "Mount Athos Homeowners Association",
  "Text": "A transfer was adjusted for Mount Athos Homeowners Association",
  "transferId": 64260,
  "NetAmount": "-1.0",
  "TotalAmount": "0.0",
  "CbAmount": "0.0",
  "RtAmount": "0.0",
  "AdjustedAmount": "10.0",
  "transferTime": "5/24/2025 12:00:00\u202fAM",
  "batchId": 94518,
  "ContactUs": "https://mtathoshoa.com",
  "batchNumber": "split_289_gp_05-23-2025",
  "entryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferDisabledCreditFund

Triggered when funding fails because the merchant doesn't have an active credit service.

```json Response body
{
  "Event": "TransferDisabledCreditFund",
  "Paypoint": "Global Factory LLC",
  "Text": "A transfer was not made due to disabled credit fund action for Global Factory LLC",
  "transferId": 78,
  "NetAmount": "-0.09",
  "TotalAmount": "10.25",
  "CbAmount": "0.00",
  "RtAmount": "0.00",
  "transferTime": "6/19/2023 10:31:07 PM",
  "batchId": 88,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": "mysite.com | +(111) 111-1111",
  "entryPoint": "91908bceab9",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferDisabledDebitFund

Triggered when funding fails because the merchant doesn't have an active debit service.

```json Response body
{
  "Event": "TransferDisabledDebitFund",
  "Paypoint": "Global Factory LLC",
  "Text": "A transfer was not made due to disabled debit fund action for Global Factory LLC",
  "transferId": 78,
  "NetAmount": "-0.09",
  "TotalAmount": "10.25",
  "CbAmount": "0.00",
  "RtAmount": "0.00",
  "transferTime": "6/19/2023 10:31:07 PM",
  "batchId": 88,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": "mysite.com | +(111) 111-1111",
  "entryPoint": "91908bceab9",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferNotAvailableBalance

Triggered when funding is pending because the available balance doesn't cover the transfer amount.

```json Response body
{
  "Event": "TransferNotAvailableBalance",
  "Paypoint": "Gruzya Adventure Outfitters",
  "Text": "A transfer was not made due to insufficient available balance for Gruzya Adventure Outfitters",
  "transferId": 7,
  "NetAmount": "2900.00",
  "TotalAmount": "0.00",
  "CbAmount": "0.00",
  "RtAmount": "0.00",
  "AvailableBalance": "120.00",
  "Difference": "2780.00",
  "transferTime": "5/2/2023 8:10:03 PM",
  "batchId": 26,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": "",
  "entryPoint": "91908bceab9",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferReadyForRetry

Triggered when a transfer is ready to retry.

```json Response body
{
  "Event": "TransferReadyForRetry",
  "Paypoint": "Mount Athos Homeoners Association",
  "Text": "A transfer is ready to be retried for Mount Athos Homeowners Association",
  "transferId": 64260,
  "NetAmount": "-1.0",
  "TotalAmount": "0.0",
  "CbAmount": "0.0",
  "RtAmount": "0.0",
  "transferTime": "5/24/2025 12:00:00\u202fAM",
  "batchId": 94518,
  "ContactUs": "https://mtathoshoa.com",
  "batchNumber": "split_289_gp_05-23-2025",
  "entryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferReturn

Triggered when a transfer has a return event.

```json Response body
{
  "Event": "TransferReturn",
  "Paypoint": "Global Corporation, LLC",
  "Text": "A transfer was returned for Global Corporation, LLC Reason: R01 - Insufficient Funds.",
  "transferId": 748,
  "NetAmount": "6214.00",
  "TotalAmount": "6214.00",
  "CbAmount": "0.00",
  "RtAmount": "0.00",
  "transferTime": "8/5/2023 10:32:48 PM",
  "batchId": 671,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": "http://www.globalcorpllc.com | (555) 555-5555",
  "entryPoint": "91908bceab9",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferResolved

Triggered when a transfer is resolved.

```json Response body
{
  "Event": "TransferResolved",
  "Paypoint": "Mount Athos Homeowners Association",
  "Text": "A transfer was resolved for Mount Athos Homeowners Association",
  "transferId": 64260,
  "NetAmount": "-1.0",
  "TotalAmount": "0.0",
  "CbAmount": "0.0",
  "RtAmount": "0.0",
  "transferTime": "5/24/2025 12:00:00\u202fAM",
  "batchId": 94518,
  "ContactUs": "https://mtathoshoa.com",
  "batchNumber": "split_289_gp_05-23-2025",
  "entryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferSuccess

Triggered when a transfer was successful.

```json Response body
{
  "Event": "TransferSuccess",
  "Paypoint": "Global Factory LLC",
  "Text": "A transfer was sucsessful for Global Factory LLC",
  "transferId": 95,
  "NetAmount": "2.86",
  "TotalAmount": "5.97",
  "CbAmount": "0.00",
  "RtAmount": "1.00",
  "transferTime": "6/27/2023 10:33:37 PM",
  "batchId": 94,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": "mysite.com | +(111) 111-1111",
  "entryPoint": "91908bceab9",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferSuspended

Triggered when transfers are suspended, usually when a deposit to or debit from a merchant's bank account gets returned.

```json Response body
{
  "Event": "TransferSuspended",
  "Paypoint": "Sandwich City LLC",
  "Text": "Funding for Sandwich City LLC was suspended because a transfer has been returned. Batch Number: split_289_gp_05-09-2025. Reason: R03 - No Account/Unable to Locate Account.",
  "transferId": 79757,
  "NetAmount": "-20.00",
  "TotalAmount": "0.00",
  "CbAmount": "0.00",
  "RtAmount": "0.00",
  "transferTime": "5/5/2025 12:00:00\u202fAM",
  "batchId": 90217,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": "https://sandwichcity.com",
  "entryPoint": "91908bceab9",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### TransferError

Triggered when a transfer has an error.

```json Response body
{
  "Event": "TransferError",
  "Paypoint": "Global Factory LLC",
  "Text": "A transfer was declined for Global Factory LLC",
  "transferId": 10,
  "NetAmount": "1.01",
  "TotalAmount": "1.01",
  "CbAmount": "0.00",
  "RtAmount": "0.00",
  "transferTime": "5/4/2023 12:06:10 AM",
  "batchId": 27,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": "mysite.com | +(111) 111-1111",
  "entryPoint": "91908bceab9",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### VoidedPayment

Triggered when a payment is voided or canceled.

```json Response body
{
  "Event": "VoidedPayment",
  "Paypoint": "Athlete Factory LLC\r\n",
  "Text": "Payment Voided/Canceled!",
  "transId": "10-5382b585-8a5c-47ff-a661-3a83eec90de1",
  "NetAmount": "140.00",
  "Fee": "0.00",
  "TotalAmount": "140.00",
  "transTime": "04/04/2022 13:50:31",
  "CustomerId": "224",
  "CustomerNumber": "888",
  "Method": "card",
  "WalletType": null,
  "EntryPoint": "entry289",
  "ExternalPaypointId": "<external_paypoint_ID>",
  "ResponseCode": "100",
  "ResponseCodeText": "Operation successful",
  "ResultCode": "A0000",
  "ResultCodeText": "Approved"
}
```

## Pay Out events

### BillApproved

Triggered when a bill is approved to be paid.

```json Response body
{
  "Event": "BillApproved",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment approved!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "Method": null,
  "TransId": "10-12345678-1234-1234-1234-123456789012",
  "Approvals": [],
  "CustomerId": 123,
  "CustomerName": "Artos Cleaning",
  "CustomerNumber": "7127",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### BillDisApproved

Triggered when a bill is rejected, and won't be paid.

```json Response body
{
  "Event": "BillDisApproved",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment disapproved!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "TransId": "10-ae9cd3f14cac47b3b302fa60a55f3c25",
  "Method": null,
  "Approvals": [],
  "CustomerId": 123, 
  "CustomerName": "Artos Cleaning", 
  "CustomerNumber": "7127",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### BillCanceled

Triggered when a bill is canceled.

```json Response body
{
  "Event": "BillCanceled",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Bill/Payment canceled!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "CustomerId": 123, 
  "CustomerName": "Artos Cleaning", 
  "CustomerNumber": "7127",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### BillProcessing

Triggered when a payout is being processed for a bill.

```json Response body
{
  "Event": "BillProcessing",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment sent!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "TransId": "10-ae9cd3f14cac47b3b302fa60a55f3c25",
  "Method": null,
  "CustomerId": 123, 
  "CustomerName": "Artos Cleaning", 
  "CustomerNumber": "7127",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### BillPaid

Triggered when a bill is paid.

```json Response body
{
  "Event": "BillPaid",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment received!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "TransId": "10-12345678-1234-1234-1234-123456789012",
  "Method": null,
  "CustomerId": 123, 
  "CustomerName": "Artos Cleaning", 
  "CustomerNumber": "7127",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### CardCreated

Triggered when a virtual card is created.

```json Response body
{
  "Event": "CardCreated", 
  "Paypoint": "Athlete Factory LLC",
  "Text": "A vcard was created for Athlete Factory LLC",
  "VCardToken": "1234567890ABCDEFGHIJ",
  "TransactionId": "123",
  "VCardAmount": "1.20",
  "VendorId": "8723",
  "VendorNumber": "MI-vendor-2024031926",
  "PaypointDBA": "Athlete Factory LLC",
  "VCardExpirationDate": "2025-12-31T00:00:00",
  "ContactUs": "https://athletefactory.com",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### CardActivated

Triggered when a virtual card is activated.

```json Response body
{
  "Event": "CardActivated",  
  "Paypoint": "Athlete Factory LLC",
  "Text": "A vcard was activated for Athlete Factory LLC",
  "VCardToken": "1234567890ABCDEFGHIJ",
  "TransactionId": "123",
  "VCardAmount": "1.20",
  "VendorId": "8723",
  "VendorNumber": "MI-vendor-2024031926",
  "PaypointDBA": "Athlete Factory LLC",
  "VCardExpirationDate": "2025-12-31T00:00:00",
  "ContactUs": "https://athletefactory.com",
  "ExternalPaypointId": "<external_paypoint_ID>"
}
```

### CardDeactivated

Triggered when a virtual card is deactivated.

```json Response body
{
  "Event": "CardDeactivated", 
  "Paypoint": "Athlete Factory LLC",
  "Text": "A vcard has been deactivated for Athlete Factory LLC",
  "VCardToken": "1234567890ABCDEFGHIJ",
  "TransactionId": "123",
  "VCardAmount": "1.20",
  "VendorId": "8723",
  "VendorNumber": "MI-vendor-2024031926",
  "PaypointDBA": "Athlete Factory LLC",
  "VCardExpirationDate": "2025-12-31T00:00:00",
  "ContactUs": "https://athletefactory.com",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### CardExpired

Triggered when a virtual card expires.

```json Response body
{
  "Event": "CardExpired", 
  "Paypoint": "Athlete Factory LLC",
  "Text": "A vcard has expired for Athlete Factory LLC",
  "VCardToken": "1234567890ABCDEFGHIJ",
  "TransactionId": "123",
  "VCardAmount": "1.20",
  "VendorId": "8723",
  "VendorNumber": "MI-vendor-2024031926",
  "PaypointDBA": "Athlete Factory LLC",
  "VCardExpirationDate": "2025-12-31T00:00:00",
  "ContactUs": "https://athletefactory.com",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### CardExpiring

Triggered when a virtual card is about to expire.

```json Response body
{
  "Event": "CardExpiring", 
  "Paypoint": "Athlete Factory LLC",
  "Text": "A vcard is about to expire for Athlete Factory LLC",
  "VCardToken": "1234567890ABCDEFGHIJ",
  "TransactionId": "123",
  "VCardAmount": "1.20",
  "VendorId": "8723",
  "VendorNumber": "MI-vendor-2024031926",
  "PaypointDBA": "Athlete Factory LLC",
  "VCardExpirationDate": "2025-12-31T00:00:00",
  "ContactUs": "https://athletefactory.com",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### CardLimitUpdated

Triggered when a virtual card's limit is updated.

```json Response body
{
  "Event": "CardLimitUpdated", 
  "Paypoint": "Athlete Factory LLC",
  "Text": "A vcard had its limit updated for Athlete Factory LLC",
  "VCardToken": "1234567890ABCDEFGHIJ",
  "TransactionId": "123",
  "VCardAmount": "1.20",
  "VendorId": "8723",
  "VendorNumber": "MI-vendor-2024031926",
  "PaypointDBA": "Athlete Factory LLC",
  "VCardExpirationDate": "2025-12-31T00:00:00",
  "ContactUs": "https://athletefactory.com",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### PayOutFunded

Triggered when a payout is funded.

```json Response body
{
  "Event": "PayOutFunded",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment funded!",
  "TransId": "10-2354",
  "TotalAmount": "4.00",
  "CustomerId": "Lakeland Electric",
  "CustomerNumber": "QA-vendor-1678994410",
  "Method": "card",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### PayOutPaid

Triggered when a payout is paid.

```json Response body
{
  "Event": "PayOutPaid",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment paid!",
  "TransId": "10-2335",
  "TotalAmount": "4.00",
  "CustomerId": "Lakeland Electric",
  "CustomerNumber": "QA-vendor-1678994410",
  "Method": "card",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### PayOutProcessed

Triggered when a payout is processed.

```json Response body
{
  "Event": "PayOutProcessed",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment processed!",
  "TransId": "10-2354",
  "TotalAmount": "4.00",
  "CustomerId": "Lakeland Electric",
  "CustomerNumber": "QA-vendor-1678994410",
  "Method": "card",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### PayOutCanceled

Triggered when a payout is canceled.

```json Response body
{
  "Event": "PayOutCanceled",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment canceled!",
  "TransId": "10-2354",
  "TotalAmount": "4.00",
  "CustomerId": "Lakeland Electric",
  "CustomerNumber": "QA-vendor-1678994410",
  "Method": "card", 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### PayOutReturned

Triggered when a payout is returned.

```json Response body
{
  "Event": "PayOutReturned",
  "Paypoint": "Town Crier HOA",
  "Text": "Payment returned!",
  "TransId": "01K0Y9FFFJB8LLERJ7G2S797TT",
  "TotalAmount": "2.00",
  "CustomerId": "Sunset Boulevard Landscaping",
  "CustomerNumber": "6758578",
  "Method": "managed",
  "ExternalPaypointId": "test6-10",
  "ReturnedAmount": "1.00"
}
```

### PayoutSubscriptionCreated

Triggered when a payout subscription is created.

```json Response body
{
  "Event": "PayoutSubscriptionCreated",
  "Paypoint": "Hakim Properties HOA Management",
  "Text": "A subscription was created for Hakim Properties HOA Management",
  "SubscriptionId": 3789,
  "Changes": "",
  "Status": 1,
  "Method": "ach",
  "Last4": "8922",
  "StoredMethodId": 85553,
  "TotalAmount": "$1.50",
  "NetAmount": "$1.50",
  "FeeAmount": "$0.00",
  "Currency": "USD",
  "StartDate": "2026-07-04T00:00:00",
  "EndDate": "2080-07-04T00:00:00",
  "Frequency": "monthly",
  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
  "ExternalPaypointId": null
}
```

### PayoutSubscriptionUpdated

Triggered when a payout subscription is updated.

```json Response body
{
  "Event": "PayoutSubscriptionUpdated",
  "Paypoint": "Hakim Properties HOA Management",
  "Text": "A subscription was updated for Hakim Properties HOA Management",
  "SubscriptionId": 3789,
  "Changes": "",
  "Status": 1,
  "Method": "ach",
  "Last4": "8922",
  "StoredMethodId": 85553,
  "TotalAmount": "$1.50",
  "NetAmount": "$1.50",
  "FeeAmount": "$0.00",
  "Currency": "USD",
  "StartDate": "2026-07-04T00:00:00",
  "EndDate": "2080-07-04T00:00:00",
  "Frequency": "monthly",
  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
  "ExternalPaypointId": null
}
```

### PayoutSubscriptionCanceled

Triggered when a payout subscription is canceled.

```json Response body
{
  "Event": "PayoutSubscriptionCanceled",
  "Paypoint": "Hakim Properties HOA Management",
  "Text": "A subscription was canceled for Hakim Properties HOA Management",
  "SubscriptionId": 3789,
  "Changes": "",
  "Status": 1,
  "Method": "ach",
  "Last4": "8922",
  "StoredMethodId": 85553,
  "TotalAmount": "$1.50",
  "NetAmount": "$1.50",
  "FeeAmount": "$0.00",
  "Currency": "USD",
  "StartDate": "2026-07-04T00:00:00",
  "EndDate": "2080-07-04T00:00:00",
  "Frequency": "monthly",
  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
  "ExternalPaypointId": null
}
```

### PayoutSubscriptionCompleted

Triggered when a payout subscription is completed (past the end date).

```json Response body
{
  "Event": "PayoutSubscriptionCompleted",
  "Paypoint": "Hakim Properties HOA Management",
  "Text": "A subscription was completed for Hakim Properties HOA Management",
  "SubscriptionId": 3789,
  "Changes": "",
  "Status": 1,
  "Method": "ach",
  "Last4": "8922",
  "StoredMethodId": 85553,
  "TotalAmount": "$1.50",
  "NetAmount": "$1.50",
  "FeeAmount": "$0.00",
  "Currency": "USD",
  "StartDate": "2026-07-04T00:00:00",
  "EndDate": "2080-07-04T00:00:00",
  "Frequency": "monthly",
  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
  "ExternalPaypointId": null
}
```

### PayoutSubscriptionReminder

Triggered when a payout subscription is about to be paid.

```json Response body
{
  "Event": "PayoutSubscriptionReminder",
  "Paypoint": "Hakim Properties HOA Management",
  "Text": "A subscription reminder for Hakim Properties HOA Management by 2025-07-07",
  "SubscriptionId": 3789,
  "Changes": "",
  "Status": 1,
  "Method": "ach",
  "Last4": "8922",
  "StoredMethodId": 85553,
  "TotalAmount": "$1.50",
  "NetAmount": "$1.50",
  "FeeAmount": "$0.00",
  "Currency": "USD",
  "StartDate": "2026-07-04T00:00:00",
  "EndDate": "2080-07-04T00:00:00",
  "Frequency": "monthly",
  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
  "ExternalPaypointId": null
}
```

## Pay Ops events

### Boarding events

#### CreatedApplication

Triggered when a boarding application is created.

```json Response body
{
  "Event": "CreatedApplication",
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application created!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "createdAt": "3/22/2023 8:52:06 PM",
  "PolicyId": 1234567890,
  "ApplicationToken": null, 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### FailedBoardingApplication

Triggered when a boarding application fails to process.

```json Response body
{
  "Event": "FailedBoardingApplication",
  "Text": "Boarding Application failed!",
  "LegalName": "Capital Core 3",
  "DbaName": "Capital Core 3",
  "AppID": 5106,
  "createdAt": "10/27/2023 6:06:53\u202fPM",
  "SoftwarePartner": "Homeowners Association USA",
  "PolicyId": null,
  "ApplicationToken": null,
  "ExternalPaypointId": null
}
```

#### ApprovedApplication

Triggered when a boarding application is approved.

```json Response body
{
  "Event": "ApprovedApplication",
  "Text": "Boarding Application Approved!",
  "LegalName": "Capital Central 5",
  "DbaName": "Capital Central 5",
  "AppID": 5106,
  "createdAt": "10/27/2023 6:06:53\u202fPM",
  "SoftwarePartner": "Homeowners Association USA",
  "PolicyId": null,
  "ApplicationToken": null,
  "ExternalPaypointId": null
}
```

#### SubmittedApplication

Triggered when a boarding application is submitted to processing.

```json Response body
{
  "Event": "SubmittedApplication",
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application submitted!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "createdAt": "3/22/2023 8:52:06 PM",
  "PolicyId": 1234567890, 
  "ApplicationToken": null, 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### DeclinedApplication

Triggered when a boarding application is declined.

```json Response body
{
  "Event": "DeclinedApplication",
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application was Declined!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "createdAt": "3/22/2023 8:52:06 PM",
  "PolicyId": 1234567890, 
  "ApplicationToken": null, 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### HoldingApplication

Triggered when an application is put on hold.

```json Response body
{
  "Event": "HoldingApplication",
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application is in Hold!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "createdAt": "3/22/2023 8:52:06 PM",
  "PolicyId": 1234567890, 
  "ApplicationToken": null, 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### UnderWritingApplication

Triggered when an application is sent to underwriting.

```json Response body
{
  "Event": "UnderWritingApplication",
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application in Underwriting process!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "createdAt": "3/22/2023 8:52:06 PM"
}
```

#### BoardingApplication

Triggered when an application is sent to boarding status.

```json Response body
{
  "Event": "BoardingApplication",
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application is in Boarding status!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "createdAt": "3/22/2023 8:52:06 PM",
  "PolicyId": 1234567890, 
  "ApplicationToken": null, 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### ActivatedMerchant

Triggered when a new merchant account is activated.

```json Response body
{
  "Event": "ActivatedMerchant",
  "Text": "Your merchant account is Active!",
  "LegalName": "Vinco Foods",
  "DbaName": "Vinco",
  "AppID": 3049,
  "Entry": "b60f39ad56f",
  "EntryUrl": "https://paypoint-dev.payabli.com/b60f39ad56f/login",
  "createdAt": "2/24/2023 14:35:32",
  "Service": null, 
  "ProcessorId": null, 
  "AccountId": null, 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### PaypointMoved

Triggered when a paypoint is moved from one organization to another.

```json Response body
  {
    "Event":"PaypointMoved",
    "Text":"Paypoint was moved.",
    "LegalName":"paypoint legal name",
    "DbaName":"paypoint dba name",
    "Entry":"entryname",
    "EntryUrl":"entryurl",
    "ParentOrganization":"parent organization name"
  }
```

### Other Pay Ops events

#### UpdatedMerchant

Triggered when a paypoint (merchant) record is updated.

```json Response body
  {
    "Event": "UpdatedMerchant",
    "Text": "Addresses updated.", // this text lists the fields that were updated
    "LegalName": "Sunshine LLC",
    "DbaName": "Manga Books",
    "AppID": 3458, 
    "Entry": "7a31d839bc",
    "EntryUrl": "https://paypoint-qa.payabli.com/7a31d839bc/login",
    "createdAt": "11/15/2024 13:50:18",
    "Service": null, 
    "ProcessorId": null, 
    "AccountId": null, 
    "ExternalPaypointId": "<external_paypoint_ID>" 
  }

```

#### SystemAlert

Triggered when a system alert occurs.

```json Response body
{
  "Event": "SystemAlert",
  "Entity": "HOA Network of North America",
  "EntityType": "Paypoint",
  "Text": "A Payabli API token expired on Saturday, November 8, 2025. The API key was removed from the system.",
  "ReferenceID": "710",
  "TokenType": "o"
}
```

#### UserPasswordExpired

Triggered when a user password expires.

```json Response body
{
  "Event": "UserPasswordExpired",
  "Username": "apiplaywright@payabli.com",
  "Name": "API Automation",
  "Entity": "Payabli",
  "EntityType": "Organization",
  "ExpDate": "05/30/2030",
  "ResetUrl": "https://partner-qa.payabli.com/payabli/resetpassword/t.r...5RKI=",
  "Text": "Your password expired on: 05/30/2030 05:00:45 PM"
}
```

#### UserPasswordExpiring

Triggered when a user password is about to expire.

```json Response body
{
  "Event": "UserPasswordExpiring",
  "Username": "apiplaywright@payabli.com",
  "Name": "API Automation",
  "Entity": "Payabli",
  "EntityType": "Organization",
  "ExpDate": "05/30/2030",
  "ResetUrl": "https://partner-qa.payabli.com/payabli/resetpassword/t.X...utwAT34=",
  "Text": "Your password will expire on: 05/30/2030 05:00:45 PM"
}
```

### Dispute events

#### ReceivedChargeBack

Triggered when a chargeback is received.

```json Response body
{
  "Event": "ReceivedChargeBack",
  "Paypoint": "Athlete Factory LLC",
  "AccountType": "4XXXXXX0000",
  "Text": "Chargeback Received",
  "Method": "card",
  "WalletType": null, 
  "ReasonCode": "13",
  "Reason": "CONSUMER DISPUTES",
  "transId": "10-ae9...c25",
  "NetAmount": "230.00",
  "chargebackTime": "10/20/2022 12:00:00 AM",
  "CustomerId": "1323",
  "CustomerNumber": "customer-xchg_004",
  "chargebackID": 1495,
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### ChargebackUpdated

Triggered when a chargeback is updated.

```json Response body
{
  "Event": "ChargebackUpdated",
  "Paypoint": "Sweet corn",
  "AccountType": "mastercard",
  "WalletType": null,
  "Text": "Chargeback status updated notice",
  "Method": "card",
  "ReasonCode": "32",
  "Reason": "Cancelled Recurring Transaction",
  "transId": "165-f44...956",
  "NetAmount": "2.00",
  "chargebackTime": "2/6/2025 12:00:00\u202fAM",
  "CustomerId": "4994",
  "CustomerNumber": "",
  "chargebackID": 11835,
  "ExternalPaypointId": null
}
```

#### ReceivedRetrieval

Triggered when a retrieval request is received.

```json Response body
{
  "Event": "ReceivedRetrieval",
  "Paypoint": "Green Valley HOA",
  "AccountType": "mastercard",
  "Text": "Retrieval Request Received",
  "Method": "card",
  "WalletType": null,
  "ReasonCode": "4",
  "Reason": "Other fraud - Card Absent Environment",
  "transId": "391-eda...f0b",
  "NetAmount": "3.67",
  "chargebackTime": "4/7/2025 12:00:00\u202fAM",
  "CustomerId": "36746",
  "CustomerNumber": "720",
  "chargebackID": 2804,
  "ExternalPaypointId": "1234456"
}
```

#### RetrievalUpdated

Triggered when a retrieval request is updated.

```json Response body
{
  "Event": "RetrievalUpdated",
  "Paypoint": "Sweet corn",
  "AccountType": "mastercard",
  "WalletType": null,
  "Text": "Retrieval Request status updated notice",
  "Method": "card",
  "ReasonCode": "61",
  "Reason": "Duplicate Processing",
  "transId": "165-4c...403",
  "NetAmount": "2.00",
  "chargebackTime": "4/6/2025 12:00:00\u202fAM",
  "CustomerId": "4994",
  "CustomerNumber": "",
  "chargebackID": 11836,
  "ExternalPaypointId": null
}
```

#### ReceivedAchReturn

Triggered when a returned ACH is received.

```json Response body
{
  "Event": "ReceivedAchReturn",
  "Paypoint": "Athlete Factory LLC",
  "AccountType": "1XXXXXX3123",
  "Text": "ACH Return Received",
  "Method": "ach",
  "ReasonCode": "R08",
  "Reason": "Payment Stopped or Stop Payment on Item",
  "transId": "10-ae9cd3f14cac47b3b302fa60a55f3c25",
  "NetAmount": "230.00",
  "chargebackTime": "10/20/2022 12:00:00 AM",
  "CustomerId": "1323",
  "CustomerNumber": "customer-xchg_004",
  "chargebackID": 1495,
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

### Fraud and risk events

#### FraudAlert

Triggered when a fraud alert occurs.

<CodeBlocks>
  ```json Response body example 1
  {
    "Paypoint": "Athlete Factory LLC\r\n",
    "HeaderText": "Fraud Alert!",
    "Text": "Attempt of payment from blacklisted card",
    "Logo": "https://cdn.payabli.com/payabli-ss.png",
    "Ip": "47.205.142.38",
    "Time": "02/09/2022 01:06:43",
    "Notes": "",
    "Event": "FraudAlert",
    "CustomerId": "224",
    "CustomerNumber": "888",
    "LastFourDigitsOfAccountNumber": "0000", 
    "CardDeclineReason": null 
  }
  ```

  ```json Response body example 2
  {
    "Paypoint": "Athlete Factory LLC\r\n",
    "HeaderText": "Fraud Alert!",
    "Text": "Triggered Fraud Control: Fraud Attempt - Identified by Rule MaxDeclinedPerCardHourly",
    "Logo": "https://cdn.payabli.com/payabli-ss.png",
    "Ip": "47.205.142.38",
    "Time": "04/04/2022 14:16:15",
    "Notes": "",
    "Event": "FraudAlert",
    "CustomerId": "224",
    "CustomerNumber": "888",
    "LastFourDigitsOfAccountNumber": "0000", 
    "CardDeclineReason": null 
  }
  ```

  ```json Response body example 3
  {
    "Paypoint": "Athlete Factory LLC\r\n",
    "HeaderText": "Fraud Alert!",
    "Text": "Blocked payment by Fraud Control: Velocity Exception - Rejected by Rule MaxTxPerCardHourly",
    "Logo": "https://cdn.payabli.com/payabli-ss.png",
    "Ip": "47.XXX.XXX.38",
    "Time": "04/04/2022 17:05:28",
    "Notes": "",
    "Event": "FraudAlert",
    "CustomerId": "224",
    "CustomerNumber": "888",
    "LastFourDigitsOfAccountNumber": "0000", 
    "CardDeclineReason": null 
  }
  ```
</CodeBlocks>

#### HoldTransaction

Triggered when a transaction is held.

```json Response body
{
  "Event": "HoldTransaction",
  "Paypoint": "Gruzya Adventure Outfitters",
  "Text": "A transaction on hold for Gruzya Adventure Outfitters",
  "Logo": "https://api-dev.payabli.com/public-logos/pe243.png",
  "transId": "245-c5eb234fc6ab41b9b84e278080b69dfb",
  "NetAmount": "$8.00",
  "Fee": "$0.00",
  "TotalAmount": "$8.00",
  "transDate": "8/23/2023", 
  "transTime": "8/23/2023 14:34:42",
  "Notes": null,
  "Customer": "Greicy Gasca",
  "CustomerEmail": "greicy@example.com",
  "CustomerPhone": "+(786) 555-6341",
  "CustomerNumber": "901102",
  "ContactUs": "https://gruzyaadventures.com/",
  "Method": "card",
  "EntryPoint": "entry289", 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### HoldBatch

Triggered when a batch is held.

```json Response body
{
  "Event": "HoldBatch",
  "Paypoint": "Gruzya Adventure Outfitters",
  "Text": "A batch on hold for Gruzya Adventure Outfitters",
  "batchId": 1234,
  "batchAmount": "$123.00",
  "batchDate": "7/6/2023 12:00:00 AM",
  "ContactUs": "https://gruzyaadventures.com/",
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### ReleasedBatch

Triggered when a held batch is released.

```json Response body
{
  "Event": "ReleasedBatch",
  "Paypoint": "Gruzya Adventure Outfitters",
  "Text": "A batch released for Gruzya Adventure Outfitters",
  "batchId": 1234,
  "batchAmount": "$123.00",
  "batchDate": "7/6/2023 12:00:00 AM",
  "ContactUs": "www.gruyzaoutfitters.com",
  "Logo": "", 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### ReleasedTransaction

Triggered when a held transaction is released.

```json Response body
{
  "Event": "ReleasedTransaction",
  "Paypoint": "Gruzya Adventure Outfitters",
  "Text": "A transaction released for Gruzya Adventure Outfitters",
  "Logo": "https://api-dev.payabli.com/public-logos/pe243.png",
  "transId": "245-c5eb234fc6ab41b9b84e278080b69dfb",
  "NetAmount": "$8.00",
  "Fee": "$0.00",
  "TotalAmount": "$8.00",
  "transDate": "8/23/2023", 
  "transTime": "8/23/2023 19:34:42",
  "Notes": null,
  "Customer": "Greicy Gasca",
  "CustomerEmail": "greicy@example.com",
  "CustomerPhone": "+(786) 555-6341",
  "CustomerNumber": "901102",
  "ContactUs": "https://gruzyaadventures.com/",
  "Method": "card",
  "EntryPoint": "entry289", 
  "ExternalPaypointId": "<external_paypoint_ID>" 
}
```

#### TransactionNotFound

Triggered when a transaction can't be found.

```json Response body
{
  "Event": "TransactionNotFound",
  "Paypoint": "Dean's H.R.W. Services",
  "ApplicantEmail": "application5106.1807@payabli.com",
  "TransId": "288-4cf552f9f35d467a9c7c1db41fe6f6f1",
  "TransactionDate": "05/24/2024 09:53:18",
  "Method": "ach",
  "AccountType": "Checking",
  "Account": "1229..5733",
  "Amount": "$1.20",
  "ExternalPaypointId": "externalID288"
}
```

### File import and export events

#### exportFileError

Triggered when there was an error generating the file.

```json Response body
{
  "Event": "FileSendError", 
  "Entity": "paypointName",
  "EntityType": "Paypoint",
  "FileName": "the file",
  "DateReceived": "2023-09-19T21:26:04",
  "TotalRecord": "1",
  "TotalUpdate": "2",
  "TotalFailed": "3",
  "Error": "",
  "Text": "A file for Paypoint: paypointName could not be sent.",
  "Status": "Error Sending File",
  "Logo": ""
}
```

#### exportFileSent

Triggered when an exported file is sent.

```json Response body
{
  "Event": "FileSent", 
  "Entity": "paypointName",
  "EntityType": "Paypoint",
  "FileName": "the file",
  "DateReceived": "2023-09-19T21:26:04",
  "TotalRecord": "1",
  "TotalUpdate": "2",
  "TotalFailed": "3",
  "Error": "",
  "Text": "A file for Paypoint: paypointName was sent.",
  "Status": "Sent",
  "Logo": ""
}
```

#### importFileReceived

Triggered when a file is received for import data via Payabli eXchange.

```json Response body
{
  "Event": "FileReceived", 
  "Entity": "paypointName",
  "EntityType": "Paypoint",
  "FileName": "the file",
  "DateReceived": "2023-09-19T21:26:04",
  "TotalRecord": "1",
  "TotalUpdate": "2",
  "TotalFailed": "3",
  "Error": "",
  "Text": "A file for Paypoint: paypointName was received.",
  "Status": "Received",
  "Logo": ""
}
```

#### importFileProcessed

Triggered when an imported file is processed.

```json Response body
{
  "Event": "FileProcessed", 
  "Entity": "paypointName",
  "EntityType": "Paypoint",
  "FileName": "the file",
  "DateReceived": "2025-09-19T21:26:04",
  "TotalRecord": "1",
  "TotalUpdate": "2",
  "TotalFailed": "3",
  "Error": "",
  "Text": "A file for Paypoint: paypointName was processed.",
  "Status": "Processed",
  "Logo": ""
}
```

#### importFileError

Triggered when an imported file is rejected by errors. Because there are several potential errors, read the "Text" field in the response for more information about the error.

```json Response body
{
  "Event": "FileReceiveError", 
  "Entity": "paypointName",
  "EntityType": "Paypoint",
  "FileName": "the file",
  "DateReceived": "2023-09-19T21:26:04",
  "TotalRecord": "1",
  "TotalUpdate": "2",
  "TotalFailed": "3",
  "Error": "",
  "Text": "A file for Paypoint: paypointName is invalid or corrupt.",
  "Status": "Invalid or Corrupt File",
  "Logo": ""
}
```

## Report

Automated reports are triggered at the times and frequency specified when the notification is created.

```json Report body example
{
  "name": "Transaction",
  "records": [
    {
      "transId": "10-b49ff9d157e14bbf86a64a6d5970d8b9",
      "gatewayTransId": "",
      "customer": "Dmitri George",
      "method": "card",
      "netAmount": "45.22",
      "feeAmount": "1.89",
      "totalAmount": "47.11",
      "invoiceNumber": "",
      "transTime": "4/13/2023 6:21:11 AM",
      "transStatus": "2",
      "settlementStatus": "0",
      "notes": "",
      "customerNumber": "777",
      "customerEmail": "dmitri@example.com",
      "company": "ALM Testing Co.",
      "Paypoint": "Athlete Factory LLC",
      "PointId": "f743aed24a-10"
    },
    {
      "transId": "10-cabaf8f63b3240a593a5fbafd7ebca29",
      "gatewayTransId": "",
      "customer": "Lisandra Lucia Sosa",
      "method": "card",
      "netAmount": "322.33",
      "feeAmount": "11.00",
      "totalAmount": "333.33",
      "invoiceNumber": "",
      "transTime": "4/13/2023 6:35:48 AM",
      "transStatus": "2",
      "settlementStatus": "0",
      "notes": "",
      "customerNumber": "888",
      "customerEmail": "lisandra@example.com",
      "company": "Sunshine LLC",
      "Paypoint": "Athlete Factory LLC",
      "PointId": "f743aed24a-10"
    }
  ]
}
```

## Related resources

See these related resources to help you get the most out of Payabli.

<AccordionGroup>
  <Accordion title="Related topics">
    * **[Notifications and reports overview](/guides/pay-ops-notifications-webhooks-overview)** - Get automated reports and notifications for key events
  </Accordion>
</AccordionGroup>