Webhook Notification Response Reference

Response header

Each response payload has this header:

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

Pay In events

ApprovedPayment

Triggered when a payment is approved.

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"
}

AuthorizedPayment

Triggered when a payment is authorized.

Response body

{
  "Event": "AuthorizedPayment",
  "Paypoint": "Athlete Factory LLC \r ",
  "Text": "Payment Authorized!",
  "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"
}

DeclinedPayment

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

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"
}

FundedPayment

Triggered when a payment is funded.

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"
}

InvoiceCreated

Triggered when an invoice is created.

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"
}

InvoicePaid

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

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"
}

InvoiceSent

Triggered when an invoice is sent to a customer.

Response body

{
  "Event": "InvoiceSent",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Invoice Sent!",
  "InvoiceId": 121,
  "InvoiceNumber": "9011021",
  "TotalAmount": "1.00",
  "CustomerId": "Peter Rose",
  "CustomerNumber": "901102"
}

OriginatedPayment

Triggered when a payment was originated.

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": ""
}

RefundedPayment

Triggered when a payment is refunded.

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"
}

RecoveredTransaction

Triggered when a transaction times out and is recovered.

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",
  "transTime": "8/23/2023 9:34:42 PM",
  "Notes": null,
  "Customer": "Greicy Gasca",
  "CustomerEmail": "[greicy@example.com](mailto:greicy@example.com)",
  "CustomerPhone": "+(786) 555-6341",
  "CustomerNumber": "901102",
  "ContactUs": "https://gruzyaadventures.com/"
}

SettledPayment

Triggered when a payment is settled or sent to funding.

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"
}

TransferAdjusted

Triggered when a transfer is adjusted.

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",
  "transferTime": "5/24/2025 12:00:00\u202fAM",
  "batchId": 94518,
  "ContactUs": "https://mtathoshoa.com",
  "batchNumber": "split_289_gp_05-23-2025",
  "entryPoint": "entry289"
}

TransferDisabledCreditFund

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

Response body

{
  "Event": "TransferDisabledCreditFund",
  "entryPoint": "91908bceab9",
  "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"
}

TransferDisabledDebitFund

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

Response body

{
  "Event": "TransferDisabledDebitFund",
  "entryPoint": "91908bceab9",
  "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"
}

TransferNotAvailableBalance

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

Response body

{
  "Event": "TransferNotAvailableBalance",
  "entryPoint": "91908bceab9",
  "Paypoint": "Gruzya Adventure Outfitters",
  "Text": "A transfer was not made due to insufficient available balance for Gruzya Adventure Outfitters",
  "transferId": 7,
  "NetAmount": "2902.18",
  "TotalAmount": "0.00",
  "CbAmount": "0.00",
  "RtAmount": "0.00",
  "transferTime": "5/2/2023 8:10:03 PM",
  "batchId": 26,
  "batchNumber": "BT-2025041919-187",
  "ContactUs": ""
}

TransferReadyForRetry

Triggered when a transfer is ready to retry.

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"
}

TransferReturn

Triggered when a transfer has a return event.

Response body

{
  "Event": "TransferReturn",
  "entryPoint": "91908bceab9",
  "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"
}

TransferResolved

Triggered when a transfer is resolved.

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"
}

TransferSuccess

Triggered when a transfer was successful.

Response body

{
  "Event": "TransferSuccess",
  "entryPoint": "91908bceab9",
  "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"
}

TransferSuspended

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

Response body

{
  "Event": "TransferSuspended",
  "entryPoint": "91908bceab9",
  "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"
}

TransferError

Triggered when a transfer has an error.

Response body

{
  "Event": "TransferError",
  "entryPoint": "91908bceab9",
  "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"
}

VoidedPayment

Triggered when a payment is voided or canceled.

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"
}

Pay Out events

BillApproved

Triggered when a bill is approved to be paid.

Response body

{
  "Event": "BillApproved",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment approved!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "Method": null,
  "Approvals": [],
  "CustomerId": "Artos Cleaning",
  "CustomerNumber": "7127"
}

BillDisApproved

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

Response body

{
  "Event": "BillDisApproved",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment disapproved!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "Method": null,
  "Approvals": [],
  "CustomerId": "Artos Cleaning",
  "CustomerNumber": "7127"
}

BillCanceled

Triggered when a bill is canceled.

Response body

{
  "Event": "BillCanceled",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Bill/Payment canceled!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "CustomerId": "Artos Cleaning",
  "CustomerNumber": "7127"
}

BillProcessing

Triggered when a payout is being processed for a bill.

Response body

{
  "Event": "BillProcessing",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment sent!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "Method": null,
  "CustomerId": "Artos Cleaning",
  "CustomerNumber": "7127"
}

BillPaid

Triggered when a bill is paid.

Response body

{
  "Event": "BillPaid",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment received!",
  "InvoiceId": 4137,
  "InvoiceNumber": "75",
  "TotalAmount": "45.00",
  "Method": null,
  "CustomerId": "Artos Cleaning",
  "CustomerNumber": "7127"
}

PayOutFunded

Triggered when a payout is funded.

Response body

{
  "Event": "PayOutFunded",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment funded!",
  "TransId": "10-2354",
  "TotalAmount": "4.00",
  "CustomerId": "Lakeland Electric",
  "CustomerNumber": "QA-vendor-1678994410"
}

PayOutPaid

Triggered when a payout is paid.

Response body

{
  "Event": "PayOutPaid",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment paid!",
  "TransId": "10-2335",
  "TotalAmount": "4.00",
  "CustomerId": "N/A",
  "CustomerNumber": "N/A"
}

PayOutProcessed

Triggered when a payout is processed.

Response body

{
  "Event": "PayOutProcessed",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment processed!",
  "TransId": "10-2354",
  "TotalAmount": "4.00",
  "CustomerId": "Lakeland Electric",
  "CustomerNumber": "QA-vendor-1678994410"
}

PayOutCanceled

Triggered when a payout is canceled.

Response body

{
  "Event": "PayOutCanceled",
  "Paypoint": "Athlete Factory LLC",
  "Text": "Payment canceled!",
  "TransId": "10-2354",
  "TotalAmount": "4.00",
  "CustomerId": "Lakeland Electric",
  "CustomerNumber": "QA-vendor-1678994410"
}

Pay Ops events

Boarding events

CreatedApplication

Triggered when a boarding application is created.

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"
}

SubmittedApplication

Triggered when a boarding application is submitted to processing.

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"
}

DeclinedApplication

Triggered when a boarding application is declined.

Response body

{
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application was Declined!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "Event": "DeclinedApplication",
  "createdAt": "3/22/2023 8:52:06 PM"
}

HoldingApplication

Triggered when an application is put on hold.

Response body

{
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application is in Hold!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "Event": "HoldingApplication",
  "createdAt": "3/22/2023 8:52:06 PM"
}

UnderWritingApplication

Triggered when an application is sent to underwriting.

Response body

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

BoardingApplication

Triggered when an application is sent to boarding status.

Response body

{
  "SoftwarePartner": "Payabli",
  "Text": "Boarding Application is in Boarding status!",
  "LegalName": "Sunshine LLC",
  "DbaName": "Sunshine LLC",
  "AppID": 3241,
  "Event": "BoardingApplication",
  "createdAt": "3/22/2023 8:52:06 PM"
}

ActivatedMerchant

Triggered when a new merchant account is activated.

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 6:35:32 PM"
}

Other Pay Ops events

UpdatedMerchant

Triggered when a paypoint (merchant) record is updated.

Response body

  {
    "Event": "UpdatedMerchant",
    "Text": "Addresses updated.", // this text lists the fields that were updated
    "LegalName": "Sunshine LLC",
    "DbaName": "Manga Books",
    "Entry": "7a31d839bc",
    "EntryUrl": "https://paypoint-qa.payabli.com/7a31d839bc/login",
    "createdAt": "11/15/2024 9:50:18 AM"
  }

Dispute events

ReceivedChargeBack

Triggered when a chargeback is received.

Response body

{
  "Event": "ReceivedChargeBack",
  "Paypoint": "Athlete Factory LLC",
  "AccountType": "4XXXXXX0000",
  "Text": "Chargeback Received",
  "Method": "card",
  "ReasonCode": "13",
  "Reason": "CONSUMER DISPUTES",
  "transId": "10-ae9cd3f14cac47b3b302fa60a55f3c25",
  "NetAmount": "230.00",
  "chargebackID": 1495,
  "chargebackTime": "10/20/2022 12:00:00 AM",
  "CustomerId": "1323",
  "CustomerNumber": "customer-xchg_004"
}

ReceivedAchReturn

Triggered when a returned ACH is received.

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",
  "chargebackID": 1495,
  "chargebackTime": "10/20/2022 12:00:00 AM",
  "CustomerId": "1323",
  "CustomerNumber": "customer-xchg_004"
}

Fraud and risk events

FraudAlert

Triggered when a fraud alert occurs.

{
  "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"
}

HoldTransaction

Triggered when a transaction is held.

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",
  "transTime": "8/23/2023 9:34:42 PM",
  "Notes": null,
  "Customer": "Greicy Gasca",
  "CustomerEmail": "greicy@example.com",
  "CustomerPhone": "+(786) 555-6341",
  "CustomerNumber": "901102",
  "ContactUs": "https://gruzyaadventures.com/"
}

HoldBatch

Triggered when a batch is held.

{
  "Event": "HoldBatch",
  "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": "https://gruzyaadventures.com/",
  "Logo" = ""
}

ReleasedBatch

Triggered when a held batch is released.

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" = ""
}

ReleasedTransaction

Triggered when a held transaction is released.

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",
  "transTime": "8/23/2023 9:34:42 PM",
  "Notes": null,
  "Customer": "Greicy Gasca",
  "CustomerEmail": "greicy@example.com",
  "CustomerPhone": "+(786) 555-6341",
  "CustomerNumber": "901102",
  "ContactUs": "https://gruzyaadventures.com/"
}

File import and export events

exportFileError

Triggered when there was an error generating the file.

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.

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.

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.

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.

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

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"
    }
}

Developer Overview

Pay In

Pay Out

Pay Ops

​Response header

​Pay In events

​ApprovedPayment

​AuthorizedPayment

​DeclinedPayment

​FundedPayment

​InvoiceCreated

​InvoicePaid

​InvoiceSent

​OriginatedPayment

​RefundedPayment

​RecoveredTransaction

​SettledPayment

​TransferAdjusted

​TransferDisabledCreditFund

​TransferDisabledDebitFund

​TransferNotAvailableBalance

​TransferReadyForRetry

​TransferReturn

​TransferResolved

​TransferSuccess

​TransferSuspended

​TransferError

​VoidedPayment

​Pay Out events

​BillApproved

​BillDisApproved

​BillCanceled

​BillProcessing

​BillPaid

​PayOutFunded

​PayOutPaid

​PayOutProcessed

​PayOutCanceled

​Pay Ops events

​Boarding events

​CreatedApplication

​SubmittedApplication

​DeclinedApplication

​HoldingApplication

​UnderWritingApplication

​BoardingApplication

​ActivatedMerchant

​Other Pay Ops events

​UpdatedMerchant

​Dispute events

​ReceivedChargeBack

​ReceivedAchReturn

​Fraud and risk events

​FraudAlert

​HoldTransaction

​HoldBatch

​ReleasedBatch

​ReleasedTransaction

​File import and export events

​exportFileError

​exportFileSent

​importFileReceived

​importFileProcessed

​importFileError

​Report

Response header

Pay In events

ApprovedPayment

AuthorizedPayment

DeclinedPayment

FundedPayment

InvoiceCreated

InvoicePaid

InvoiceSent

OriginatedPayment

RefundedPayment

RecoveredTransaction

SettledPayment

TransferAdjusted

TransferDisabledCreditFund

TransferDisabledDebitFund

TransferNotAvailableBalance

TransferReadyForRetry

TransferReturn

TransferResolved

TransferSuccess

TransferSuspended

TransferError

VoidedPayment

Pay Out events

BillApproved

BillDisApproved

BillCanceled

BillProcessing

BillPaid

PayOutFunded

PayOutPaid

PayOutProcessed

PayOutCanceled

Pay Ops events

Boarding events

CreatedApplication

SubmittedApplication

DeclinedApplication

HoldingApplication

UnderWritingApplication

BoardingApplication

ActivatedMerchant

Other Pay Ops events

UpdatedMerchant

Dispute events

ReceivedChargeBack

ReceivedAchReturn

Fraud and risk events

FraudAlert

HoldTransaction

HoldBatch

ReleasedBatch

ReleasedTransaction

File import and export events

exportFileError

exportFileSent

importFileReceived

importFileProcessed

importFileError

Report