Pay OpsNotifications

Webhook notification response reference

Learn more about the payload for each webhook notification response body
Applies to:DevelopersPartners

Response header

Each response payload has this header:

1Content-Length: <content length>
2Content-Type: application/json; charset=utf-8
3Accept: */*
4String: string
5Host: 52.3.204.115

Pay In events

ApprovedPayment

Triggered when a payment is approved.

Response body
1{
2  "Event": "ApprovedPayment",
3  "Paypoint": "Athlete Factory LLC\r\n",
4  "Text": "Payment Approved!",
5  "transId": "10-33eb676a-da48-401f-9494-e69a324b152d",
6  "NetAmount": "100.00",
7  "Fee": "0.00",
8  "TotalAmount": "100.00",
9  "transTime": "04/04/2022 13:56:17",
10  "CustomerId": "224",
11  "CustomerNumber": "888",
12  "Method": "card",
13  "WalletType": null,
14  "EntryPoint": "entry289",
15  "ExternalPaypointId": "<external_paypoint_ID>"
16}

AuthorizedPayment

Triggered when a payment is authorized.

Response body
1{
2  "Event": "AuthorizedPayment",
3  "Paypoint": "Athlete Factory LLC \r ",
4  "Text": "Payment Authorized!",
5  "AccountType": "4XXXXXX0000",
6  "transId": "10-4e986895-8085-41ac-87db-9f74ff640e19",
7  "NetAmount": "100.00",
8  "Fee": "2.00",
9  "TotalAmount": "102.00",
10  "transTime": "5/23/2022 1:50:50 PM",
11  "CustomerId": "224",
12  "CustomerNumber": "888",
13  "Method": "card",
14  "WalletType": null, 
15  "EntryPoint": "entry289",
16  "ExternalPaypointId": "<external_paypoint_ID>"
17}

DeclinedPayment

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

Response body
1{
2  "Event": "DeclinedPayment",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment Declined!",
5  "transId": "10-073d7d504e3c4357be3ff904f9653b4a",
6  "NetAmount": "0.05",
7  "Fee": "0.00",
8  "TotalAmount": "0.05",
9  "transTime": "9/18/2023 7:20:14 PM",
10  "CustomerId": "1323",
11  "CustomerNumber": "customer-xchg_004",
12  "Method": "card",
13  "WalletType": null, 
14  "EntryPoint": "entry289", 
15  "ExternalPaypointId": "<external_paypoint_ID>" 
16}

FundedPayment

Triggered when a payment is funded.

Response body
1{
2  "Event": "FundedPayment",
3  "Paypoint": "Gruzya Adventure Outfitters",
4  "AccountType": "4111 1XXXXXX1111",
5  "Text": "Payment Funded",
6  "BatchNumber": "BT-2023042102-XXX",
7  "Method": "card",
8  "SettlementDate": "2023-04-21T00:00:00",
9  "ExpectedDepositDate": "2023-04-22T00:00:00",
10  "transId": "179-67f4b500f7a840cfXXXXXXdd7a2447b",
11  "NetAmount": "1.99",
12  "CustomerId": "1000",
13  "CustomerNumber": "clgld5wa600XXXX8n8ijx",
14  "WalletType": null, 
15  "EntryPoint": "entry289", 
16  "ExternalPaypointId": "<external_paypoint_ID>" 
17}

InvoiceCreated

Triggered when an invoice is created.

Response body
1{
2  "Event": "InvoiceCreated",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Invoice Created!",
5  "InvoiceId": 3156,
6  "InvoiceNumber": "200622",
7  "TotalAmount": "0.00",
8  "CustomerId": "Lisandra L Sosa",
9  "CustomerNumber": "customer-xchg_004",
10  "ExternalPaypointId": "<external_paypoint_ID>" 
11}

InvoicePaid

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

Response body
1{
2  "Event": "InvoicePaid",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment received!",
5  "InvoiceId": 127,
6  "InvoiceNumber": "66547688",
7  "TotalAmount": "2.00",
8  "TotalPaidAmount": "2.00",
9  "CustomerId": "Peter Rose",
10  "CustomerNumber": "12345",
11  "ExternalPaypointId": "<external_paypoint_ID>"
12}

InvoiceSent

Triggered when an invoice is sent to a customer.

Response body
1{
2  "Event": "InvoiceSent",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Invoice Sent!",
5  "InvoiceId": 121,
6  "InvoiceNumber": "9011021",
7  "TotalAmount": "1.00",
8  "CustomerId": "Peter Rose",
9  "CustomerNumber": "901102",
10  "ExternalPaypointId": "<external_paypoint_ID>"
11}

OriginatedPayment

Triggered when a payment was originated.

Response body
1{
2  "Event": "OriginatedPayment",
3  "Paypoint": "Mount Athos Homeowners Association",
4  "AccountType": "",
5  "BatchNumber": "checkcommerce_134159_ach_03-10-2023",
6  "Text": "Payment Originated/Batched",
7  "Method": "ach",
8  "ExpectedDepositDate": "2023-03-10T00:00:00",
9  "transId": "31-ff7d46e7-d420-4135-b50b-cdbb3f48fe52",
10  "NetAmount": "2558.37",
11  "CustomerId": "",
12  "CustomerNumber": "",
13  "WalletType": null,
14  "EntryPoint": "entry289",
15  "ExternalPaypointId": "<external_paypoint_ID>"
16}

RefundedPayment

Triggered when a payment is refunded.

Response body
1{
2  "Event": "RefundedPayment",
3  "Paypoint": "Athlete Factory LLC\r\n",
4  "Text": "Payment Refunded!",
5  "transId": "10-7c9a106e-60fd-4638-a4e9-a2b86d16dcb0",
6  "NetAmount": "-50.00",
7  "Fee": "0.00",
8  "TotalAmount": "-50.00",
9  "transTime": "04/04/2022 13:56:23",
10  "Notes": "Refunding Transaction 10-33eb676a-da48-401f-9494-e69a324b152d",
11  "CustomerId": "224",
12  "CustomerNumber": "888",
13  "Method": "card",
14  "WalletType": null,
15  "EntryPoint": "entry289",
16  "ExternalPaypointId": "<external_paypoint_ID>"
17}

RecoveredTransaction

Triggered when a transaction times out and is recovered.

Response body
1{
2  "Event": "RecoveredTransaction",
3  "Paypoint": "Gruzya Adventure Outfitters",
4  "Text": "We automatically recovered a transaction for Gruzya Adventure Outfitters",
5  "Logo": "https://payabli.com/public-logos/pe243.png",
6  "transId": "245-c5eb234fc6ab41b9b84e278080b69dfb",
7  "NetAmount": "$8.00",
8  "Fee": "$0.00",
9  "TotalAmount": "$8.00",
10  "transDate": "8/23/2023", 
11  "transTime": "8/23/2023 9:34:42 PM",
12  "Notes": null,
13  "Customer": "Greicy Gasca",
14  "CustomerEmail": "greicy@example.com",
15  "CustomerPhone": "+(786) 555-6341",
16  "CustomerNumber": "901102",
17  "ContactUs": "https://gruzyaadventures.com/",
18  "Method": "card",
19  "EntryPoint": "entry289", 
20  "ExternalPaypointId": "<external_paypoint_ID>" 
21}

SettledPayment

Triggered when a payment is settled or sent to funding.

Response body
1{
2  "Event": "SettledPayment",
3  "Paypoint": "Mount Athos Homeowners Association",
4  "AccountType": "",
5  "Text": "Payment Settled",
6  "BatchNumber": "checkcommerce_134159_ach_03-10-2023",
7  "Method": "ach",
8  "SettlementDate": "2023-03-10T00:00:00",
9  "ExpectedDepositDate": "2023-03-10T00:00:00",
10  "transId": "31-ff7d46e7-d420-4135-b50b-cdbb3f48fe52",
11  "NetAmount": "2558.37",
12  "CustomerId": "224",
13  "CustomerNumber": "888",
14  "WalletType": null,
15  "EntryPoint": "entry289",
16  "ExternalPaypointId": "<external_paypoint_ID>"
17}

SubscriptionCreated

Triggered when a subscription is created.

Response body
1{
2  "Event": "SubscriptionCreated",
3  "Paypoint": "Example Company Name",
4  "Text": "A subscription was created for Example Company Name",
5  "SubscriptionId": 12345,
6  "Changes": "Created",
7  "Status": "Active", 
8  "Method": "Card",
9  "Last4": "6543",
10  "StoredMethodId": "card_123456789", 
11  "TotalAmount": "$99.99",
12  "NetAmount": "$95.99",
13  "FeeAmount": "$4.00",
14  "Currency": "USD",
15  "StartDate": "2023-06-01",
16  "EndDate": "2024-06-01",
17  "Frequency": "Monthly",
18  "CreatedAt": "2023-06-01 14:30:00",
19  "UpdatedAt": "2023-06-01 14:30:00",
20  "ContactUs": "support@example.com | (555) 123-4567",
21  "ExternalPaypointId": "<external_paypoint_ID>"
22}

SubscriptionUpdated

Triggered when a subscription is updated.

Response body
1{
2  "Event": "SubscriptionUpdated",
3  "Paypoint": "Example Company Name",
4  "Text": "A subscription was updated for Example Company Name",
5  "SubscriptionId": 12345,
6  "Changes": "EndDate, Frequency",
7  "Status": "Active",
8  "Method": "Card",
9  "Last4": "6543",
10  "StoredMethodId": "card_123456789",
11  "TotalAmount": "$99.99",
12  "NetAmount": "$95.99",
13  "FeeAmount": "$4.00",
14  "Currency": "USD",
15  "StartDate": "2023-06-01",
16  "EndDate": "2024-06-01",
17  "Frequency": "Monthly",
18  "CreatedAt": "2023-06-01 14:30:00",
19  "UpdatedAt": "2023-06-05 10:15:00",
20  "ContactUs": "support@example.com | (555) 123-4567",
21  "ExternalPaypointId": "<external_paypoint_ID>"
22}

SubscriptionCanceled

Triggered when a subscription is canceled.

Response body
1{
2  "Event": "SubscriptionCanceled",
3  "Paypoint": "Example Company Name",
4  "Text": "A subscription was canceled for Example Company Name",
5  "SubscriptionId": 12345,
6  "Changes": "Cancelled",
7  "Status": "Cancelled",
8  "Method": "Card",
9  "Last4": "6543",
10  "StoredMethodId": "card_123456789",
11  "TotalAmount": "$99.99",
12  "NetAmount": "$95.99",
13  "FeeAmount": "$4.00",
14  "Currency": "USD",
15  "StartDate": "2023-06-01",
16  "EndDate": "2024-06-01",
17  "Frequency": "Monthly",
18  "CreatedAt": "2023-06-01 14:30:00",
19  "UpdatedAt": "2023-06-10 16:45:00",
20  "ContactUs": "support@example.com | (555) 123-4567",
21  "ExternalPaypointId": "<external_paypoint_ID>"
22}

SubscriptionCompleted

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

Response body
1{
2  "Event": "SubscriptionCompleted",
3  "Paypoint": "Example Company Name",
4  "Text": "A subscription was completed for Example Company Name",
5  "SubscriptionId": 12345,
6  "Changes": "Completed",
7  "Status": "Completed",
8  "Method": "Card",
9  "Last4": "6543",
10  "StoredMethodId": "card_123456789",
11  "TotalAmount": "$99.99",
12  "NetAmount": "$95.99",
13  "FeeAmount": "$4.00",
14  "Currency": "USD",
15  "StartDate": "2023-06-01",
16  "EndDate": "2024-06-01",
17  "Frequency": "Monthly",
18  "CreatedAt": "2023-06-01 14:30:00",
19  "UpdatedAt": "2024-06-01 00:00:00",
20  "ContactUs": "support@example.com | (555) 123-4567",
21  "ExternalPaypointId": "<external_paypoint_ID>"
22}

BatchClosed

Triggered when a batch is closed.

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

BatchNotClosed

Triggered when a batch isn’t closed.

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

TransferAdjusted

Triggered when a transfer is adjusted.

Response body
1{
2  "Event": "TransferAdjusted",
3  "Paypoint": "Mount Athos Homeowners Association",
4  "Text": "A transfer was adjusted for Mount Athos Homeowners Association",
5  "transferId": 64260,
6  "NetAmount": "-1.0",
7  "TotalAmount": "0.0",
8  "CbAmount": "0.0",
9  "RtAmount": "0.0",
10  "AdjustedAmount": "10.0",
11  "transferTime": "5/24/2025 12:00:00\u202fAM",
12  "batchId": 94518,
13  "ContactUs": "https://mtathoshoa.com",
14  "batchNumber": "split_289_gp_05-23-2025",
15  "entryPoint": "entry289",
16  "ExternalPaypointId": "<external_paypoint_ID>" 
17}

TransferDisabledCreditFund

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

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

TransferDisabledDebitFund

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

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

TransferNotAvailableBalance

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

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

TransferReadyForRetry

Triggered when a transfer is ready to retry.

Response body
1{
2  "Event": "TransferReadyForRetry",
3  "Paypoint": "Mount Athos Homeoners Association",
4  "Text": "A transfer is ready to be retried for Mount Athos Homeowners Association",
5  "transferId": 64260,
6  "NetAmount": "-1.0",
7  "TotalAmount": "0.0",
8  "CbAmount": "0.0",
9  "RtAmount": "0.0",
10  "transferTime": "5/24/2025 12:00:00\u202fAM",
11  "batchId": 94518,
12  "ContactUs": "https://mtathoshoa.com",
13  "batchNumber": "split_289_gp_05-23-2025",
14  "entryPoint": "entry289",
15  "ExternalPaypointId": "<external_paypoint_ID>" 
16}

TransferReturn

Triggered when a transfer has a return event.

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

TransferResolved

Triggered when a transfer is resolved.

Response body
1{
2  "Event": "TransferResolved",
3  "Paypoint": "Mount Athos Homeowners Association",
4  "Text": "A transfer was resolved for Mount Athos Homeowners Association",
5  "transferId": 64260,
6  "NetAmount": "-1.0",
7  "TotalAmount": "0.0",
8  "CbAmount": "0.0",
9  "RtAmount": "0.0",
10  "transferTime": "5/24/2025 12:00:00\u202fAM",
11  "batchId": 94518,
12  "ContactUs": "https://mtathoshoa.com",
13  "batchNumber": "split_289_gp_05-23-2025",
14  "entryPoint": "entry289",
15  "ExternalPaypointId": "<external_paypoint_ID>" 
16}

TransferSuccess

Triggered when a transfer was successful.

Response body
1{
2  "Event": "TransferSuccess",
3  "Paypoint": "Global Factory LLC",
4  "Text": "A transfer was sucsessful for Global Factory LLC",
5  "transferId": 95,
6  "NetAmount": "2.86",
7  "TotalAmount": "5.97",
8  "CbAmount": "0.00",
9  "RtAmount": "1.00",
10  "transferTime": "6/27/2023 10:33:37 PM",
11  "batchId": 94,
12  "batchNumber": "BT-2025041919-187",
13  "ContactUs": "mysite.com | +(111) 111-1111",
14  "entryPoint": "91908bceab9",
15  "ExternalPaypointId": "<external_paypoint_ID>" 
16}

TransferSuspended

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

Response body
1{
2  "Event": "TransferSuspended",
3  "Paypoint": "Sandwich City LLC",
4  "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.",
5  "transferId": 79757,
6  "NetAmount": "-20.00",
7  "TotalAmount": "0.00",
8  "CbAmount": "0.00",
9  "RtAmount": "0.00",
10  "transferTime": "5/5/2025 12:00:00\u202fAM",
11  "batchId": 90217,
12  "batchNumber": "BT-2025041919-187",
13  "ContactUs": "https://sandwichcity.com",
14  "entryPoint": "91908bceab9",
15  "ExternalPaypointId": "<external_paypoint_ID>" 
16}

TransferError

Triggered when a transfer has an error.

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

VoidedPayment

Triggered when a payment is voided or canceled.

Response body
1{
2  "Event": "VoidedPayment",
3  "Paypoint": "Athlete Factory LLC\r\n",
4  "Text": "Payment Voided/Canceled!",
5  "transId": "10-5382b585-8a5c-47ff-a661-3a83eec90de1",
6  "NetAmount": "140.00",
7  "Fee": "0.00",
8  "TotalAmount": "140.00",
9  "transTime": "04/04/2022 13:50:31",
10  "CustomerId": "224",
11  "CustomerNumber": "888",
12  "Method": "card",
13  "WalletType": null, 
14  "EntryPoint": "entry289", 
15  "ExternalPaypointId": "<external_paypoint_ID>" 
16}

Pay Out events

BillApproved

Triggered when a bill is approved to be paid.

Response body
1{
2  "Event": "BillApproved",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment approved!",
5  "InvoiceId": 4137,
6  "InvoiceNumber": "75",
7  "TotalAmount": "45.00",
8  "Method": null,
9  "TransId": "10-12345678-1234-1234-1234-123456789012",
10  "Approvals": [],
11  "CustomerId": 123,
12  "CustomerName": "Artos Cleaning",
13  "CustomerNumber": "7127",
14  "ExternalPaypointId": "<external_paypoint_ID>"
15}

BillDisApproved

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

Response body
1{
2  "Event": "BillDisApproved",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment disapproved!",
5  "InvoiceId": 4137,
6  "InvoiceNumber": "75",
7  "TotalAmount": "45.00",
8  "TransId": "10-ae9cd3f14cac47b3b302fa60a55f3c25",
9  "Method": null,
10  "Approvals": [],
11  "CustomerId": 123, 
12  "CustomerName": "Artos Cleaning", 
13  "CustomerNumber": "7127",
14  "ExternalPaypointId": "<external_paypoint_ID>" 
15}

BillCanceled

Triggered when a bill is canceled.

Response body
1{
2  "Event": "BillCanceled",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Bill/Payment canceled!",
5  "InvoiceId": 4137,
6  "InvoiceNumber": "75",
7  "TotalAmount": "45.00",
8  "CustomerId": 123, 
9  "CustomerName": "Artos Cleaning", 
10  "CustomerNumber": "7127",
11  "ExternalPaypointId": "<external_paypoint_ID>" 
12}

BillProcessing

Triggered when a payout is being processed for a bill.

Response body
1{
2  "Event": "BillProcessing",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment sent!",
5  "InvoiceId": 4137,
6  "InvoiceNumber": "75",
7  "TotalAmount": "45.00",
8  "TransId": "10-ae9cd3f14cac47b3b302fa60a55f3c25",
9  "Method": null,
10  "CustomerId": 123, 
11  "CustomerName": "Artos Cleaning", 
12  "CustomerNumber": "7127",
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

BillPaid

Triggered when a bill is paid.

Response body
1{
2  "Event": "BillPaid",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment received!",
5  "InvoiceId": 4137,
6  "InvoiceNumber": "75",
7  "TotalAmount": "45.00",
8  "TransId": "10-12345678-1234-1234-1234-123456789012",
9  "Method": null,
10  "CustomerId": 123, 
11  "CustomerName": "Artos Cleaning", 
12  "CustomerNumber": "7127",
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

CardCreated

Triggered when a virtual card is created.

Response body
1{
2  "Event": "CardCreated", 
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "A vcard was created for Athlete Factory LLC",
5  "VCardToken": "1234567890ABCDEFGHIJ",
6  "TransactionId": "123",
7  "VCardAmount": "1.20",
8  "VendorId": "8723",
9  "VendorNumber": "MI-vendor-2024031926",
10  "PaypointDBA": "Athlete Factory LLC",
11  "VCardExpirationDate": "2025-12-31T00:00:00",
12  "ContactUs": "https://athletefactory.com",
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

CardActivated

Triggered when a virtual card is activated.

Response body
1{
2  "Event": "CardActivated",  
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "A vcard was activated for Athlete Factory LLC",
5  "VCardToken": "1234567890ABCDEFGHIJ",
6  "TransactionId": "123",
7  "VCardAmount": "1.20",
8  "VendorId": "8723",
9  "VendorNumber": "MI-vendor-2024031926",
10  "PaypointDBA": "Athlete Factory LLC",
11  "VCardExpirationDate": "2025-12-31T00:00:00",
12  "ContactUs": "https://athletefactory.com",
13  "ExternalPaypointId": "<external_paypoint_ID>"
14}

CardDeactivated

Triggered when a virtual card is deactivated.

Response body
1{
2  "Event": "CardDeactivated", 
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "A vcard has been deactivated for Athlete Factory LLC",
5  "VCardToken": "1234567890ABCDEFGHIJ",
6  "TransactionId": "123",
7  "VCardAmount": "1.20",
8  "VendorId": "8723",
9  "VendorNumber": "MI-vendor-2024031926",
10  "PaypointDBA": "Athlete Factory LLC",
11  "VCardExpirationDate": "2025-12-31T00:00:00",
12  "ContactUs": "https://athletefactory.com",
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

CardExpired

Triggered when a virtual card expires.

Response body
1{
2  "Event": "CardExpired", 
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "A vcard has expired for Athlete Factory LLC",
5  "VCardToken": "1234567890ABCDEFGHIJ",
6  "TransactionId": "123",
7  "VCardAmount": "1.20",
8  "VendorId": "8723",
9  "VendorNumber": "MI-vendor-2024031926",
10  "PaypointDBA": "Athlete Factory LLC",
11  "VCardExpirationDate": "2025-12-31T00:00:00",
12  "ContactUs": "https://athletefactory.com",
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

CardExpiring

Triggered when a virtual card is about to expire.

Response body
1{
2  "Event": "CardExpiring", 
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "A vcard is about to expire for Athlete Factory LLC",
5  "VCardToken": "1234567890ABCDEFGHIJ",
6  "TransactionId": "123",
7  "VCardAmount": "1.20",
8  "VendorId": "8723",
9  "VendorNumber": "MI-vendor-2024031926",
10  "PaypointDBA": "Athlete Factory LLC",
11  "VCardExpirationDate": "2025-12-31T00:00:00",
12  "ContactUs": "https://athletefactory.com",
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

CardLimitUpdated

Triggered when a virtual card’s limit is updated.

Response body
1{
2  "Event": "CardLimitUpdated", 
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "A vcard had its limit updated for Athlete Factory LLC",
5  "VCardToken": "1234567890ABCDEFGHIJ",
6  "TransactionId": "123",
7  "VCardAmount": "1.20",
8  "VendorId": "8723",
9  "VendorNumber": "MI-vendor-2024031926",
10  "PaypointDBA": "Athlete Factory LLC",
11  "VCardExpirationDate": "2025-12-31T00:00:00",
12  "ContactUs": "https://athletefactory.com",
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

PayOutFunded

Triggered when a payout is funded.

Response body
1{
2  "Event": "PayOutFunded",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment funded!",
5  "TransId": "10-2354",
6  "TotalAmount": "4.00",
7  "CustomerId": "Lakeland Electric",
8  "CustomerNumber": "QA-vendor-1678994410",
9  "Method": "card",
10  "ExternalPaypointId": "<external_paypoint_ID>" 
11}

PayOutPaid

Triggered when a payout is paid.

Response body
1{
2  "Event": "PayOutPaid",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment paid!",
5  "TransId": "10-2335",
6  "TotalAmount": "4.00",
7  "CustomerId": "Lakeland Electric",
8  "CustomerNumber": "QA-vendor-1678994410",
9  "Method": "card",
10  "ExternalPaypointId": "<external_paypoint_ID>" 
11}

PayOutProcessed

Triggered when a payout is processed.

Response body
1{
2  "Event": "PayOutProcessed",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment processed!",
5  "TransId": "10-2354",
6  "TotalAmount": "4.00",
7  "CustomerId": "Lakeland Electric",
8  "CustomerNumber": "QA-vendor-1678994410",
9  "Method": "card",
10  "ExternalPaypointId": "<external_paypoint_ID>" 
11}

PayOutCanceled

Triggered when a payout is canceled.

Response body
1{
2  "Event": "PayOutCanceled",
3  "Paypoint": "Athlete Factory LLC",
4  "Text": "Payment canceled!",
5  "TransId": "10-2354",
6  "TotalAmount": "4.00",
7  "CustomerId": "Lakeland Electric",
8  "CustomerNumber": "QA-vendor-1678994410",
9  "Method": "card", 
10  "ExternalPaypointId": "<external_paypoint_ID>" 
11}

PayoutSubscriptionCreated

Triggered when a payout subscription is created.

Response body
1{
2  "Event": "PayoutSubscriptionCreated",
3  "Paypoint": "Hakim Properties HOA Management",
4  "Text": "A subscription was created for Hakim Properties HOA Management",
5  "SubscriptionId": 3789,
6  "Changes": "",
7  "Status": 1,
8  "Method": "ach",
9  "Last4": "8922",
10  "StoredMethodId": 85553,
11  "TotalAmount": "$1.50",
12  "NetAmount": "$1.50",
13  "FeeAmount": "$0.00",
14  "Currency": "USD",
15  "StartDate": "2026-07-04T00:00:00",
16  "EndDate": "2080-07-04T00:00:00",
17  "Frequency": "monthly",
18  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
19  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
20  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
21  "ExternalPaypointId": null
22}

PayoutSubscriptionUpdated

Triggered when a payout subscription is updated.

Response body
1{
2  "Event": "PayoutSubscriptionUpdated",
3  "Paypoint": "Hakim Properties HOA Management",
4  "Text": "A subscription was updated for Hakim Properties HOA Management",
5  "SubscriptionId": 3789,
6  "Changes": "",
7  "Status": 1,
8  "Method": "ach",
9  "Last4": "8922",
10  "StoredMethodId": 85553,
11  "TotalAmount": "$1.50",
12  "NetAmount": "$1.50",
13  "FeeAmount": "$0.00",
14  "Currency": "USD",
15  "StartDate": "2026-07-04T00:00:00",
16  "EndDate": "2080-07-04T00:00:00",
17  "Frequency": "monthly",
18  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
19  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
20  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
21  "ExternalPaypointId": null
22}

PayoutSubscriptionCanceled

Triggered when a payout subscription is canceled.

Response body
1{
2  "Event": "PayoutSubscriptionCanceled",
3  "Paypoint": "Hakim Properties HOA Management",
4  "Text": "A subscription was canceled for Hakim Properties HOA Management",
5  "SubscriptionId": 3789,
6  "Changes": "",
7  "Status": 1,
8  "Method": "ach",
9  "Last4": "8922",
10  "StoredMethodId": 85553,
11  "TotalAmount": "$1.50",
12  "NetAmount": "$1.50",
13  "FeeAmount": "$0.00",
14  "Currency": "USD",
15  "StartDate": "2026-07-04T00:00:00",
16  "EndDate": "2080-07-04T00:00:00",
17  "Frequency": "monthly",
18  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
19  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
20  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
21  "ExternalPaypointId": null
22}

PayoutSubscriptionCompleted

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

Response body
1{
2  "Event": "PayoutSubscriptionCompleted",
3  "Paypoint": "Hakim Properties HOA Management",
4  "Text": "A subscription was completed for Hakim Properties HOA Management",
5  "SubscriptionId": 3789,
6  "Changes": "",
7  "Status": 1,
8  "Method": "ach",
9  "Last4": "8922",
10  "StoredMethodId": 85553,
11  "TotalAmount": "$1.50",
12  "NetAmount": "$1.50",
13  "FeeAmount": "$0.00",
14  "Currency": "USD",
15  "StartDate": "2026-07-04T00:00:00",
16  "EndDate": "2080-07-04T00:00:00",
17  "Frequency": "monthly",
18  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
19  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
20  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
21  "ExternalPaypointId": null
22}

PayoutSubscriptionReminder

Triggered when a payout subscription is about to be paid.

Response body
1{
2  "Event": "PayoutSubscriptionReminder",
3  "Paypoint": "Hakim Properties HOA Management",
4  "Text": "A subscription reminder for Hakim Properties HOA Management by 2025-07-07",
5  "SubscriptionId": 3789,
6  "Changes": "",
7  "Status": 1,
8  "Method": "ach",
9  "Last4": "8922",
10  "StoredMethodId": 85553,
11  "TotalAmount": "$1.50",
12  "NetAmount": "$1.50",
13  "FeeAmount": "$0.00",
14  "Currency": "USD",
15  "StartDate": "2026-07-04T00:00:00",
16  "EndDate": "2080-07-04T00:00:00",
17  "Frequency": "monthly",
18  "CreatedAt": "2025-07-07T22:24:54.732589+00:00",
19  "UpdatedAt": "2025-07-07T22:24:54.732612+00:00",
20  "ContactUs": "http://hakimproperties.com/ | (123) 456-7890",
21  "ExternalPaypointId": null
22}

Pay Ops events

Boarding events

CreatedApplication

Triggered when a boarding application is created.

Response body
1{
2  "Event": "CreatedApplication",
3  "SoftwarePartner": "Payabli",
4  "Text": "Boarding Application created!",
5  "LegalName": "Sunshine LLC",
6  "DbaName": "Sunshine LLC",
7  "AppID": 3241,
8  "createdAt": "3/22/2023 8:52:06 PM",
9  "PolicyId": 1234567890,
10  "ApplicationToken": null, 
11  "ExternalPaypointId": "<external_paypoint_ID>" 
12}

FailedBoardingApplication

Triggered when a boarding application fails to process.

Response body
1{
2  "Event": "FailedBoardingApplication",
3  "Text": "Boarding Application failed!",
4  "LegalName": "Capital Core 3",
5  "DbaName": "Capital Core 3",
6  "AppID": 5106,
7  "createdAt": "10/27/2023 6:06:53\u202fPM",
8  "SoftwarePartner": "Homeowners Association USA",
9  "PolicyId": null,
10  "ApplicationToken": null,
11  "ExternalPaypointId": null
12}

ApprovedApplication

Triggered when a boarding application is approved.

Response body
1{
2  "Event": "ApprovedApplication",
3  "Text": "Boarding Application Approved!",
4  "LegalName": "Capital Central 5",
5  "DbaName": "Capital Central 5",
6  "AppID": 5106,
7  "createdAt": "10/27/2023 6:06:53\u202fPM",
8  "SoftwarePartner": "Homeowners Association USA",
9  "PolicyId": null,
10  "ApplicationToken": null,
11  "ExternalPaypointId": null
12}

SubmittedApplication

Triggered when a boarding application is submitted to processing.

Response body
1{
2  "Event": "SubmittedApplication",
3  "SoftwarePartner": "Payabli",
4  "Text": "Boarding Application submitted!",
5  "LegalName": "Sunshine LLC",
6  "DbaName": "Sunshine LLC",
7  "AppID": 3241,
8  "createdAt": "3/22/2023 8:52:06 PM",
9  "PolicyId": 1234567890, 
10  "ApplicationToken": null, 
11  "ExternalPaypointId": "<external_paypoint_ID>" 
12}

DeclinedApplication

Triggered when a boarding application is declined.

Response body
1{
2  "Event": "DeclinedApplication",
3  "SoftwarePartner": "Payabli",
4  "Text": "Boarding Application was Declined!",
5  "LegalName": "Sunshine LLC",
6  "DbaName": "Sunshine LLC",
7  "AppID": 3241,
8  "createdAt": "3/22/2023 8:52:06 PM",
9  "PolicyId": 1234567890, 
10  "ApplicationToken": null, 
11  "ExternalPaypointId": "<external_paypoint_ID>" 
12}

HoldingApplication

Triggered when an application is put on hold.

Response body
1{
2  "Event": "HoldingApplication",
3  "SoftwarePartner": "Payabli",
4  "Text": "Boarding Application is in Hold!",
5  "LegalName": "Sunshine LLC",
6  "DbaName": "Sunshine LLC",
7  "AppID": 3241,
8  "createdAt": "3/22/2023 8:52:06 PM",
9  "PolicyId": 1234567890, 
10  "ApplicationToken": null, 
11  "ExternalPaypointId": "<external_paypoint_ID>" 
12}

UnderWritingApplication

Triggered when an application is sent to underwriting.

Response body
1{
2  "Event": "UnderWritingApplication",
3  "SoftwarePartner": "Payabli",
4  "Text": "Boarding Application in Underwriting process!",
5  "LegalName": "Sunshine LLC",
6  "DbaName": "Sunshine LLC",
7  "AppID": 3241,
8  "createdAt": "3/22/2023 8:52:06 PM"
9}

BoardingApplication

Triggered when an application is sent to boarding status.

Response body
1{
2  "Event": "BoardingApplication",
3  "SoftwarePartner": "Payabli",
4  "Text": "Boarding Application is in Boarding status!",
5  "LegalName": "Sunshine LLC",
6  "DbaName": "Sunshine LLC",
7  "AppID": 3241,
8  "createdAt": "3/22/2023 8:52:06 PM",
9  "PolicyId": 1234567890, 
10  "ApplicationToken": null, 
11  "ExternalPaypointId": "<external_paypoint_ID>" 
12}

ActivatedMerchant

Triggered when a new merchant account is activated.

Response body
1{
2  "Event": "ActivatedMerchant",
3  "Text": "Your merchant account is Active!",
4  "LegalName": "Vinco Foods",
5  "DbaName": "Vinco",
6  "AppID": 3049,
7  "Entry": "b60f39ad56f",
8  "EntryUrl": "https://paypoint-dev.payabli.com/b60f39ad56f/login",
9  "createdAt": "2/24/2023 6:35:32 PM",
10  "Service": null, 
11  "ProcessorId": null, 
12  "AccountId": null, 
13  "ExternalPaypointId": "<external_paypoint_ID>" 
14}

Other Pay Ops events

UpdatedMerchant

Triggered when a paypoint (merchant) record is updated.

Response body
1  {
2    "Event": "UpdatedMerchant",
3    "Text": "Addresses updated.", // this text lists the fields that were updated
4    "LegalName": "Sunshine LLC",
5    "DbaName": "Manga Books",
6    "AppID": 3458, 
7    "Entry": "7a31d839bc",
8    "EntryUrl": "https://paypoint-qa.payabli.com/7a31d839bc/login",
9    "createdAt": "11/15/2024 9:50:18 AM",
10    "Service": null, 
11    "ProcessorId": null, 
12    "AccountId": null, 
13    "ExternalPaypointId": "<external_paypoint_ID>" 
14  }

SystemAlert

Triggered when a system alert occurs.

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

UserPasswordExpired

Triggered when a user password expires.

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

UserPasswordExpiring

Triggered when a user password is about to expire.

Response body
1{
2  "Event": "UserPasswordExpiring",
3  "Username": "apiplaywright@payabli.com",
4  "Name": "API Automation",
5  "Entity": "Payabli",
6  "EntityType": "Organization",
7  "ExpDate": "05/30/2030",
8  "ResetUrl": "https://partner-qa.payabli.com/payabli/resetpassword/t.X...utwAT34=",
9  "Text": "Your password will expire on: 05/30/2030 05:00:45 PM"
10}

Dispute events

ReceivedChargeBack

Triggered when a chargeback is received.

Response body
1{
2  "Event": "ReceivedChargeBack",
3  "Paypoint": "Athlete Factory LLC",
4  "AccountType": "4XXXXXX0000",
5  "Text": "Chargeback Received",
6  "Method": "card",
7  "WalletType": null, 
8  "ReasonCode": "13",
9  "Reason": "CONSUMER DISPUTES",
10  "transId": "10-ae9...c25",
11  "NetAmount": "230.00",
12  "chargebackTime": "10/20/2022 12:00:00 AM",
13  "CustomerId": "1323",
14  "CustomerNumber": "customer-xchg_004",
15  "chargebackID": 1495,
16  "ExternalPaypointId": "<external_paypoint_ID>" 
17}

ChargebackUpdated

Triggered when a chargeback is updated.

Response body
1{
2  "Event": "ChargebackUpdated",
3  "Paypoint": "Sweet corn",
4  "AccountType": "mastercard",
5  "WalletType": null,
6  "Text": "Chargeback status updated notice",
7  "Method": "card",
8  "ReasonCode": "32",
9  "Reason": "Cancelled Recurring Transaction",
10  "transId": "165-f44...956",
11  "NetAmount": "2.00",
12  "chargebackTime": "2/6/2025 12:00:00\u202fAM",
13  "CustomerId": "4994",
14  "CustomerNumber": "",
15  "chargebackID": 11835,
16  "ExternalPaypointId": null
17}

ReceivedRetrieval

Triggered when a retrieval request is received.

Response body
1{
2  "Event": "ReceivedRetrieval",
3  "Paypoint": "Green Valley HOA",
4  "AccountType": "mastercard",
5  "Text": "Retrieval Request Received",
6  "Method": "card",
7  "WalletType": null,
8  "ReasonCode": "4",
9  "Reason": "Other fraud - Card Absent Environment",
10  "transId": "391-eda...f0b",
11  "NetAmount": "3.67",
12  "chargebackTime": "4/7/2025 12:00:00\u202fAM",
13  "CustomerId": "36746",
14  "CustomerNumber": "720",
15  "chargebackID": 2804,
16  "ExternalPaypointId": "1234456"
17}

RetrievalUpdated

Triggered when a retrieval request is updated.

Response body
1{
2  "Event": "RetrievalUpdated",
3  "Paypoint": "Sweet corn",
4  "AccountType": "mastercard",
5  "WalletType": null,
6  "Text": "Retrieval Request status updated notice",
7  "Method": "card",
8  "ReasonCode": "61",
9  "Reason": "Duplicate Processing",
10  "transId": "165-4c...403",
11  "NetAmount": "2.00",
12  "chargebackTime": "4/6/2025 12:00:00\u202fAM",
13  "CustomerId": "4994",
14  "CustomerNumber": "",
15  "chargebackID": 11836,
16  "ExternalPaypointId": null
17}

ReceivedAchReturn

Triggered when a returned ACH is received.

Response body
1{
2  "Event": "ReceivedAchReturn",
3  "Paypoint": "Athlete Factory LLC",
4  "AccountType": "1XXXXXX3123",
5  "Text": "ACH Return Received",
6  "Method": "ach",
7  "ReasonCode": "R08",
8  "Reason": "Payment Stopped or Stop Payment on Item",
9  "transId": "10-ae9cd3f14cac47b3b302fa60a55f3c25",
10  "NetAmount": "230.00",
11  "chargebackTime": "10/20/2022 12:00:00 AM",
12  "CustomerId": "1323",
13  "CustomerNumber": "customer-xchg_004",
14  "chargebackID": 1495,
15  "ExternalPaypointId": "<external_paypoint_ID>" 
16}

Fraud and risk events

FraudAlert

Triggered when a fraud alert occurs.

1{
2  "Paypoint": "Athlete Factory LLC\r\n",
3  "HeaderText": "Fraud Alert!",
4  "Text": "Attempt of payment from blacklisted card",
5  "Logo": "https://cdn.payabli.com/payabli-ss.png",
6  "Ip": "47.205.142.38",
7  "Time": "02/09/2022 01:06:43",
8  "Notes": "",
9  "Event": "FraudAlert",
10  "CustomerId": "224",
11  "CustomerNumber": "888",
12  "LastFourDigitsOfAccountNumber": "0000", 
13  "CardDeclineReason": null 
14}

HoldTransaction

Triggered when a transaction is held.

Response body
1{
2  "Event": "HoldTransaction",
3  "Paypoint": "Gruzya Adventure Outfitters",
4  "Text": "A transaction on hold for Gruzya Adventure Outfitters",
5  "Logo": "https://api-dev.payabli.com/public-logos/pe243.png",
6  "transId": "245-c5eb234fc6ab41b9b84e278080b69dfb",
7  "NetAmount": "$8.00",
8  "Fee": "$0.00",
9  "TotalAmount": "$8.00",
10  "transDate": "8/23/2023", 
11  "transTime": "8/23/2023 9:34:42 PM",
12  "Notes": null,
13  "Customer": "Greicy Gasca",
14  "CustomerEmail": "greicy@example.com",
15  "CustomerPhone": "+(786) 555-6341",
16  "CustomerNumber": "901102",
17  "ContactUs": "https://gruzyaadventures.com/",
18  "Method": "card",
19  "EntryPoint": "entry289", 
20  "ExternalPaypointId": "<external_paypoint_ID>" 
21}

HoldBatch

Triggered when a batch is held.

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

ReleasedBatch

Triggered when a held batch is released.

Response body
1{
2  "Event": "ReleasedBatch",
3  "Paypoint": "Gruzya Adventure Outfitters",
4  "Text": "A batch released for Gruzya Adventure Outfitters",
5  "batchId": 1234,
6  "batchAmount": "$123.00",
7  "batchDate": "7/6/2023 12:00:00 AM",
8  "ContactUs": "www.gruyzaoutfitters.com",
9  "Logo": "", 
10  "ExternalPaypointId": "<external_paypoint_ID>" 
11}

ReleasedTransaction

Triggered when a held transaction is released.

Response body
1{
2  "Event": "ReleasedTransaction",
3  "Paypoint": "Gruzya Adventure Outfitters",
4  "Text": "A transaction released for Gruzya Adventure Outfitters",
5  "Logo": "https://api-dev.payabli.com/public-logos/pe243.png",
6  "transId": "245-c5eb234fc6ab41b9b84e278080b69dfb",
7  "NetAmount": "$8.00",
8  "Fee": "$0.00",
9  "TotalAmount": "$8.00",
10  "transDate": "8/23/2023", 
11  "transTime": "8/23/2023 9:34:42 PM",
12  "Notes": null,
13  "Customer": "Greicy Gasca",
14  "CustomerEmail": "greicy@example.com",
15  "CustomerPhone": "+(786) 555-6341",
16  "CustomerNumber": "901102",
17  "ContactUs": "https://gruzyaadventures.com/",
18  "Method": "card",
19  "EntryPoint": "entry289", 
20  "ExternalPaypointId": "<external_paypoint_ID>" 
21}

TransactionNotFound

Triggered when a transaction can’t be found.

Response body
1{
2  "Event": "TransactionNotFound",
3  "Paypoint": "Dean's H.R.W. Services",
4  "ApplicantEmail": "application5106.1807@payabli.com",
5  "TransId": "288-4cf552f9f35d467a9c7c1db41fe6f6f1",
6  "TransactionDate": "05/24/2024 09:53:18",
7  "Method": "ach",
8  "AccountType": "Checking",
9  "Account": "1229..5733",
10  "Amount": "$1.20",
11  "ExternalPaypointId": "externalID288"
12}

File import and export events

exportFileError

Triggered when there was an error generating the file.

Response body
1{
2  "Event": "FileSendError", 
3  "Entity": "paypointName",
4  "EntityType": "Paypoint",
5  "FileName": "the file",
6  "DateReceived": "2023-09-19T21:26:04",
7  "TotalRecord": "1",
8  "TotalUpdate": "2",
9  "TotalFailed": "3",
10  "Error": "",
11  "Text": "A file for Paypoint: paypointName could not be sent.",
12  "Status": "Error Sending File",
13  "Logo": ""
14}

exportFileSent

Triggered when an exported file is sent.

Response body
1{
2  "Event": "FileSent", 
3  "Entity": "paypointName",
4  "EntityType": "Paypoint",
5  "FileName": "the file",
6  "DateReceived": "2023-09-19T21:26:04",
7  "TotalRecord": "1",
8  "TotalUpdate": "2",
9  "TotalFailed": "3",
10  "Error": "",
11  "Text": "A file for Paypoint: paypointName was sent.",
12  "Status": "Sent",
13  "Logo": ""
14}

importFileReceived

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

Response body
1{
2  "Event": "FileReceived", 
3  "Entity": "paypointName",
4  "EntityType": "Paypoint",
5  "FileName": "the file",
6  "DateReceived": "2023-09-19T21:26:04",
7  "TotalRecord": "1",
8  "TotalUpdate": "2",
9  "TotalFailed": "3",
10  "Error": "",
11  "Text": "A file for Paypoint: paypointName was received.",
12  "Status": "Received",
13  "Logo": ""
14}

importFileProcessed

Triggered when an imported file is processed.

Response body
1{
2  "Event": "FileProcessed", 
3  "Entity": "paypointName",
4  "EntityType": "Paypoint",
5  "FileName": "the file",
6  "DateReceived": "2025-09-19T21:26:04",
7  "TotalRecord": "1",
8  "TotalUpdate": "2",
9  "TotalFailed": "3",
10  "Error": "",
11  "Text": "A file for Paypoint: paypointName was processed.",
12  "Status": "Processed",
13  "Logo": ""
14}

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.

Response body
1{
2  "Event": "FileReceiveError", 
3  "Entity": "paypointName",
4  "EntityType": "Paypoint",
5  "FileName": "the file",
6  "DateReceived": "2023-09-19T21:26:04",
7  "TotalRecord": "1",
8  "TotalUpdate": "2",
9  "TotalFailed": "3",
10  "Error": "",
11  "Text": "A file for Paypoint: paypointName is invalid or corrupt.",
12  "Status": "Invalid or Corrupt File",
13  "Logo": ""
14}

Report

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

Report body example
1{
2  "name": "Transaction",
3  "records": [
4    {
5      "transId": "10-b49ff9d157e14bbf86a64a6d5970d8b9",
6      "gatewayTransId": "",
7      "customer": "Dmitri George",
8      "method": "card",
9      "netAmount": "45.22",
10      "feeAmount": "1.89",
11      "totalAmount": "47.11",
12      "invoiceNumber": "",
13      "transTime": "4/13/2023 6:21:11 AM",
14      "transStatus": "2",
15      "settlementStatus": "0",
16      "notes": "",
17      "customerNumber": "777",
18      "customerEmail": "dmitri@example.com",
19      "company": "ALM Testing Co.",
20      "Paypoint": "Athlete Factory LLC",
21      "PointId": "f743aed24a-10"
22    },
23    {
24      "transId": "10-cabaf8f63b3240a593a5fbafd7ebca29",
25      "gatewayTransId": "",
26      "customer": "Lisandra Lucia Sosa",
27      "method": "card",
28      "netAmount": "322.33",
29      "feeAmount": "11.00",
30      "totalAmount": "333.33",
31      "invoiceNumber": "",
32      "transTime": "4/13/2023 6:35:48 AM",
33      "transStatus": "2",
34      "settlementStatus": "0",
35      "notes": "",
36      "customerNumber": "888",
37      "customerEmail": "lisandra@example.com",
38      "company": "Sunshine LLC",
39      "Paypoint": "Athlete Factory LLC",
40      "PointId": "f743aed24a-10"
41    }
42  ]
43}