API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Get Chargeback or ACH Return Record
Retrieves a chargeback record and its details.
curl --request GET \
--url https://api-sandbox.payabli.com/api/ChargeBacks/read/{Id} \
--header 'requestToken: <api-key>'
{
"id": 201,
"chargebackDate": "2022-06-25",
"caseNumber": "TZ45678",
"reasonCode": "<string>",
"reason": "Buyer dispute",
"status": 1,
"PaymentId": "34-ggghtt5678xxxxxxx-654",
"referenceNumber": "<string>",
"lastFour": "6789",
"accountType": "visa",
"method": "card",
"createdAt": "2022-07-01 15:00:01",
"orderId": "O-5140",
"netAmount": 3762.87,
"transactionTime": "\"2025-01-16T01:06:40.97\"",
"customer": {
"CustomerId": 4440,
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Sunshine LLC",
"CustomerNumber": "3456-7645A",
"BillingAddress1": "1111 West 1st Street",
"BillingAddress2": "Suite 200",
"BillingCity": "Miami",
"BillingState": "FL",
"BillingZip": "45567",
"BillingCountry": "US",
"BillingPhone": "5555555555",
"BillingEmail": "example@email.com",
"ShippingAddress1": "123 Walnut St",
"ShippingAddress2": "STE 900",
"ShippingCity": "Johnson City",
"ShippingState": "TN",
"ShippingZip": "37619",
"ShippingCountry": "US",
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"CreatedAt": "2022-07-01 15:00:01",
"customerId": 4440,
"customerStatus": 1,
"Identifiers": [
"\\\"firstname\\\"",
"\\\"lastname\\\"",
"\\\"email\\\"",
"\\\"customId\\\""
]
},
"paymentData": {
"MaskedAccount": "4XXXXXXXX1111",
"AccountType": "visa",
"AccountExp": "11/29",
"AccountZip": "90210",
"HolderName": "Chad Mercia",
"orderDescription": "Depost for materials for 123 Walnut St",
"StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
"Initiator": "payor",
"StoredMethodUsageType": "subscription",
"Sequence": "subsequent",
"accountId": "<string>",
"SignatureData": null,
"binData": {
"binMatchedLength": 6,
"binCardBrand": "Visa",
"binCardType": "Credit",
"binCardCategory": "PLATINUM",
"binCardIssuer": "Bank of Example",
"binCardIssuerCountry": "United States",
"binCardIssuerCountryCodeA2": "US",
"binCardIssuerCountryNumber": 840
},
"paymentDetails": {
"totalAmount": 100,
"serviceFee": 0,
"currency": "USD",
"checkNumber": "107",
"checkImage": {},
"categories": [
{
"label": "Deposit",
"description": "Deposit for materials",
"amount": 1000,
"qty": 1
}
],
"splitFunding": [
{
"recipientEntryPoint": "41035afaa7",
"accountId": "187-782",
"description": "Split for annual dues",
"amount": 456.23
}
]
}
},
"paypointLegalname": "Sunshine Services, LLC",
"paypointDbaname": "Sunshine Gutters",
"parentOrgName": "PropertyManager Pro",
"paypointEntryname": "d193cf9a46",
"responses": [
{
"id": 672,
"contactName": "John Doe",
"contactEmail": "example@email.com",
"notes": "any note here",
"attachments": {
"zipfile": "zx45.zip",
"filelist": [
{
"originalName": "<string>",
"zipName": "<string>"
}
]
},
"createdAt": "2022-07-01 15:00:01"
}
],
"transaction": {
"ParentOrgName": "PropertyManager Pro",
"PaypointDbaname": "Sunshine Gutters",
"PaypointLegalname": "Sunshine Services, LLC",
"PaypointEntryname": "d193cf9a46",
"PaymentTransId": "226-fe55ec0348e34702bd91b4be198ce7ec",
"ConnectorName": "gp",
"ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]",
"GatewayTransId": "TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0",
"OrderId": "O-5140",
"Method": "ach",
"BatchNumber": "batch_226_ach_12-30-2023",
"BatchAmount": 30.22,
"PayorId": 1551,
"PaymentData": {
"MaskedAccount": "4XXXXXXXX1111",
"AccountType": "visa",
"AccountExp": "11/29",
"AccountZip": "90210",
"HolderName": "Chad Mercia",
"orderDescription": "Depost for materials for 123 Walnut St",
"StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
"Initiator": "payor",
"StoredMethodUsageType": "subscription",
"Sequence": "subsequent",
"accountId": "<string>",
"SignatureData": null,
"binData": {
"binMatchedLength": 6,
"binCardBrand": "Visa",
"binCardType": "Credit",
"binCardCategory": "PLATINUM",
"binCardIssuer": "Bank of Example",
"binCardIssuerCountry": "United States",
"binCardIssuerCountryCodeA2": "US",
"binCardIssuerCountryNumber": 840
},
"paymentDetails": {
"totalAmount": 100,
"serviceFee": 0,
"currency": "USD",
"checkNumber": "107",
"checkImage": {},
"categories": [
{
"label": "Deposit",
"description": "Deposit for materials",
"amount": 1000,
"qty": 1
}
],
"splitFunding": [
{
"recipientEntryPoint": "41035afaa7",
"accountId": "187-782",
"description": "Split for annual dues",
"amount": 456.23
}
]
}
},
"TransStatus": 1,
"PaypointId": 226,
"TotalAmount": 30.22,
"NetAmount": 3762.87,
"FeeAmount": 1,
"SettlementStatus": 2,
"Operation": "Sale",
"ResponseData": {
"response": "<string>",
"responsetext": "CAPTURED",
"authcode": null,
"transactionid": "TRN_XXXXXGOa87juzW",
"avsresponse": "<string>",
"avsresponse_text": "<string>",
"cvvresponse": "<string>",
"cvvresponse_text": "<string>",
"orderid": "O-5140",
"type": "<string>",
"response_code": "XXX",
"response_code_text": "Transaction was approved.",
"emv_auth_response_data": "<string>"
},
"Source": "api",
"ScheduleReference": 0,
"OrgId": 123,
"RefundId": 0,
"ReturnedId": 0,
"TransAdditionalData": "<any>",
"InvoiceData": {
"invoiceNumber": "INV-2345",
"invoiceDate": "2024-07-01",
"invoiceDueDate": "2024-07-01",
"invoiceType": 0,
"invoiceEndDate": "2024-07-01",
"invoiceStatus": 1,
"frequency": "monthly",
"paymentTerms": "PIA",
"termsConditions": "Must be paid before work scheduled.",
"notes": "Example notes.",
"tax": 2.05,
"discount": 10,
"invoiceAmount": 105,
"freightAmount": 10,
"dutyAmount": 0,
"purchaseOrder": "PO-345",
"firstName": "Chad",
"lastName": "Mercia",
"company": "ACME, INC",
"shippingAddress1": "123 Walnut St",
"shippingAddress2": "STE 900",
"shippingCity": "Johnson City",
"shippingState": "TN",
"shippingZip": "37619",
"shippingCountry": "US",
"shippingEmail": "example@email.com",
"shippingPhone": "5555555555",
"shippingFromZip": "30040",
"summaryCommodityCode": "501718",
"items": [
{
"itemProductCode": "M-DEPOSIT",
"itemProductName": "Materials deposit",
"itemDescription": "Deposit for materials.",
"itemCommodityCode": "010",
"itemUnitOfMeasure": "SqFt",
"itemCost": 5,
"itemQty": 1,
"itemMode": 0,
"itemCategories": [
"<string>"
],
"itemTotalAmount": 123,
"itemTaxAmount": 7,
"itemTaxRate": 0.075
}
],
"attachments": {},
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"EntrypageId": 0,
"TransactionTime": "2025-10-19T00:00:00",
"Customer": {
"CustomerId": 4440,
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Sunshine LLC",
"CustomerNumber": "3456-7645A",
"BillingAddress1": "1111 West 1st Street",
"BillingAddress2": "Suite 200",
"BillingCity": "Miami",
"BillingState": "FL",
"BillingZip": "45567",
"BillingCountry": "US",
"BillingPhone": "5555555555",
"BillingEmail": "example@email.com",
"ShippingAddress1": "123 Walnut St",
"ShippingAddress2": "STE 900",
"ShippingCity": "Johnson City",
"ShippingState": "TN",
"ShippingZip": "37619",
"ShippingCountry": "US",
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"CreatedAt": "2022-07-01 15:00:01",
"customerId": 4440,
"customerStatus": 1,
"Identifiers": [
"\\\"firstname\\\"",
"\\\"lastname\\\"",
"\\\"email\\\"",
"\\\"customId\\\""
]
},
"CfeeTransactions": [
{
"cFeeTransid": "<string>",
"transStatus": 123,
"feeAmount": 123,
"settlementStatus": 123,
"operation": "<string>",
"responseData": {},
"refundId": 123,
"transactionTime": "\"2025-01-16T01:06:40.97\""
}
],
"splitFundingInstructions": [
{
"recipientEntryPoint": "41035afaa7",
"accountId": "187-782",
"description": "Split for annual dues",
"amount": 456.23
}
],
"TransactionEvents": [
{
"TransEvent": "Approved",
"EventData": {},
"EventTime": "2023-11-07T05:31:56Z"
}
],
"PendingFeeAmount": 2,
"DeviceId": "6c361c7d-674c-44cc-b790-382b75d1xxx",
"AchSecCode": "<string>",
"AchHolderType": "personal"
}
}
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
ID of the chargeback or return record. This is returned as chargebackId
in the RecievedChargeback and ReceivedAchReturn webhook notifications.
Response
Identifier of chargeback or return.
201
Date of chargeback in format YYYY-MM-DD or MM/DD/YYYY.
"2022-06-25"
Number of case assigned to the chargeback.
"TZ45678"
'R' code for returned ACH or custom code identifying the reason.
Text describing the chargeback or ACH return reason.
"Buyer dispute"
Status for chargeback or ACH return
- 0: Open (chargebacks only)
- 1: Pending (chargebacks only)
- 2: Closed-Won (chargebacks only)
- 3: Closed-Lost (chargebacks only)
- 4: ACH Return (ACH only)
- 5: ACH Dispute, Not Authorized (ACH only)
1
ReferenceId of the transaction in Payabli.
"34-ggghtt5678xxxxxxx-654"
Processor reference number to the chargeback.
Last 4 digits of card or bank account involved in chargeback or return.
"6789"
Bank account type or card brand.
"visa"
Type of payment vehicle: ach or card.
"card"
Timestamp when the register was created, in UTC.
"2022-07-01 15:00:01"
Custom identifier for the transaction.
250
"O-5140"
Net amount in chargeback or ACH return.
3762.87
Timestamp when transaction was submitted, in UTC.
"\"2025-01-16T01:06:40.97\""
The Payabli-generated unique ID for the customer.
4440
Customer/Payor first name.
"John"
Customer/Payor last name.
"Doe"
Customer's company name.
"Sunshine LLC"
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250
"3456-7645A"
Customer's billing address.
"1111 West 1st Street"
Additional line for Customer's billing address.
"Suite 200"
Customer's billing city.
"Miami"
Customer's billing state. Must be 2-letter state code for address in US.
"FL"
Customer's billing ZIP code.
"45567"
Customer's billing country.
"US"
Customer's phone number.
"5555555555"
Customer's email address.
320
"example@email.com"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
The Payabli-generated unique ID for the customer.
4440
Customer Status. Possible values:
-99
Deleted0
Inactive1
Active85
Locked (typically due to multiple failed login attempts)
1
Array of field names to be used as identifiers.
[
"\\\"firstname\\\"",
"\\\"lastname\\\"",
"\\\"email\\\"",
"\\\"customId\\\""
]
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
"4XXXXXXXX1111"
Bank account type or card brand.
"visa"
Expiration date of card used in transaction.
"11/29"
ZIP code for card used in transaction.
"90210"
Account holder name for the method.
"Chad Mercia"
Text description of the transaction.
250
"Depost for materials for 123 Walnut St"
Identifier of stored payment method used in transaction.
"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"
Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant
.
Available values:
payor
: For cardholder-initiated transactionsmerchant
: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
"payor"
Strongly recommended The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to unscheduled
.
Available values:
unscheduled
: This type is used for transactions that are one-time or otherwise not pre-scheduled.subscription
: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.recurring
: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.
See Understanding CIT and MIT Indicators for more information.
"subscription"
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.
Available values:
first
: The first use of the payment method. This is almost always a cardholder-initiated transaction.subsequent
: For merchant-initiated transactions after the first use of the payment method.
See Understanding CIT and MIT Indicators for more information.
"subsequent"
Custom identifier for payment connector.
250
null
Object containing information related to the card. This object is null
unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay.
The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
6
The card brand. For example, Visa, MasterCard, American Express, Discover.
"Visa"
The type of card: Credit or Debit.
"Credit"
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID
.
"PLATINUM"
The name of the financial institution that issued the card.
"Bank of Example"
The issuing financial institution's country name.
"United States"
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
"US"
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
840
Details about the payment.
Total amount to be charged. If a service fee is sent, then this amount should include the service fee."
100
Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.
0
Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.
"USD"
A check number to be used in the ach transaction. Required for payment method = 'check'.
"107"
Object containing image of paper check.
Array of payment categories/line items describing the amount to be paid Note: These categories are for information only and are not validated against the total amount provided.
Name of item or category.
"Deposit"
Price/cost per unit of item or category.
1000
Description of item or category
"Deposit for materials"
Quatity of item or category
Split funding instructions for the transaction. See Split a Transaction for more.
The entrypoint the split should be sent to.
"41035afaa7"
The accountId for the account the split should be sent to.
"187-782"
A description for the split.
"Split for annual dues"
Amount from the transaction to sent to this recipient.
456.23
The paypoint's legal name.
"Sunshine Services, LLC"
The paypoint's DBA name.
"Sunshine Gutters"
The name of the parent organization.
"PropertyManager Pro"
The paypoint's entryname.
50
"d193cf9a46"
Chargeback response records.
Chargeback response identifier
672
Name of response submitter
"John Doe"
Email of response submitter.
320
"example@email.com"
Response notes
"any note here"
Object with attached files to response
Zip file containing attachments.
"zx45.zip"
Array of objects describing files contained in zip file.
Timestamp when response was submitted, in UTC.
"2022-07-01 15:00:01"
The name of the parent organization.
"PropertyManager Pro"
Paypoint's DBA name.
"Sunshine Gutters"
Paypoint's legal name.
"Sunshine Services, LLC"
Paypoint's entryname.
50
"d193cf9a46"
Unique Transaction ID.
"226-fe55ec0348e34702bd91b4be198ce7ec"
Connector used for transaction.
"gp"
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
"[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]"
Internal identifier used for processing.
"TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0"
Custom identifier for the transaction.
250
"O-5140"
Payment method used: card, ach, or wallet.
"ach"
Batch number.
"batch_226_ach_12-30-2023"
Batch amount.
30.22
Unique ID for customer linked to the transaction.
1551
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
"4XXXXXXXX1111"
Bank account type or card brand.
"visa"
Expiration date of card used in transaction.
"11/29"
ZIP code for card used in transaction.
"90210"
Account holder name for the method.
"Chad Mercia"
Text description of the transaction.
250
"Depost for materials for 123 Walnut St"
Identifier of stored payment method used in transaction.
"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"
Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant
.
Available values:
payor
: For cardholder-initiated transactionsmerchant
: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
"payor"
Strongly recommended The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to unscheduled
.
Available values:
unscheduled
: This type is used for transactions that are one-time or otherwise not pre-scheduled.subscription
: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.recurring
: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.
See Understanding CIT and MIT Indicators for more information.
"subscription"
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.
Available values:
first
: The first use of the payment method. This is almost always a cardholder-initiated transaction.subsequent
: For merchant-initiated transactions after the first use of the payment method.
See Understanding CIT and MIT Indicators for more information.
"subsequent"
Custom identifier for payment connector.
250
null
Object containing information related to the card. This object is null
unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay.
The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
6
The card brand. For example, Visa, MasterCard, American Express, Discover.
"Visa"
The type of card: Credit or Debit.
"Credit"
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID
.
"PLATINUM"
The name of the financial institution that issued the card.
"Bank of Example"
The issuing financial institution's country name.
"United States"
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
"US"
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
840
Details about the payment.
Total amount to be charged. If a service fee is sent, then this amount should include the service fee."
100
Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.
0
Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.
"USD"
A check number to be used in the ach transaction. Required for payment method = 'check'.
"107"
Object containing image of paper check.
Array of payment categories/line items describing the amount to be paid Note: These categories are for information only and are not validated against the total amount provided.
Name of item or category.
"Deposit"
Price/cost per unit of item or category.
1000
Description of item or category
"Deposit for materials"
Quatity of item or category
Split funding instructions for the transaction. See Split a Transaction for more.
The entrypoint the split should be sent to.
"41035afaa7"
The accountId for the account the split should be sent to.
"187-782"
A description for the split.
"Split for annual dues"
Amount from the transaction to sent to this recipient.
456.23
InternalId for paypoint.
226
Transaction total amount (including service fee or sub-charge)
30.22
Net amount paid.
3762.87
Service fee or sub-charge applied.
1
Settlement status for transaction. See the docs for a full reference.
2
The transaction's operation.
"Sale"
The transaction's response data.
Response text for operation: 'Success' or 'Declined'.
Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline.
"CAPTURED"
Authorization code for the transaction.
null
The transaction identifier in Payabli.
"TRN_XXXXXGOa87juzW"
Text code describing the result for address validation (applies only for card transactions).
Text code describing the result for address validation (applies only for card transactions).
Text code describing the result for CVV validation (applies only for card transactions).
Text code describing the result for CVV validation (applies only for card transactions).
Custom identifier for the transaction.
250
"O-5140"
Type of transaction or operation.
Internal result code processing the transaction. Value 1 indicates successful operation, values 2 and 3 indicate errors.
"XXX"
Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline.
"Transaction was approved."
EMV authorization response data, applicable for card transactions.
Custom identifier to indicate the transaction or request source.
100
"api"
Reference to the subscription that originated the transaction.
0
ID of immediate parent organization.
123
Identifier of refund transaction linked to this payment.
0
Identifier of return/chargeback transaction linked to this payment.
0
Not currently in use.
Invoice number. Identifies the invoice under a paypoint.
250
"INV-2345"
Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Type of invoice. Only 0
for one-time invoices is currently supported.
0
Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0
, 1
, 2
, 4
, 99
1
Frequency of scheduled invoice.
one-time
, weekly
, every2weeks
, every6months
, monthly
, every3months
, annually
"monthly"
Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30
.
PIA
, CIA
, UR
, NET10
, NET20
, NET30
, NET45
, NET60
, NET90
, EOM
, MFI
, 5MFI
, 10MFI
, 15MFI
, 20MFI
, 2/10NET30
, UF
, 10UF
, 20UF
, 25UF
, 50UF
"PIA"
Custom terms and conditions included in the invoice.
"Must be paid before work scheduled."
Notes included in the invoice.
"Example notes."
Tax rate in percent applied to the invoice.
2.05
Discount applied to the invoice.
10
Invoice total amount.
105
Freight/shipping amount.
10
Duty amount.
0
Purchase order number.
"PO-345"
First name of the recipient of the invoice.
"Chad"
Last name of the recipient of the invoice.
"Mercia"
Company name of the recipient of the invoice.
"ACME, INC"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
Shipping recipient's contact email address.
320
"example@email.com"
Recipient phone number.
"5555555555"
Sender shipping ZIP code.
"30040"
Commodity code.
"501718"
Array of line items included in the invoice.
Item or product name. Max length of 250 characters.
250
"Materials deposit"
Item or product price per unit.
5
Quantity of item or product.
1
Item or product code. Max length of 250 characters.
250
"M-DEPOSIT"
Item or product description. Max length of 250 characters.
250
"Deposit for materials."
Item or product commodity code. Max length of 250 characters.
250
"010"
Unit of measurement. Max length of 100 characters.
100
"SqFt"
Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both.
0
, 1
, 2
0
Array of tags classifying item or product.
Total amount in item or product.
Tax amount applied to item or product.
7
Tax rate applied to item or product.
0.075
Array of fileContent
objects with attached documents. Max upload size is 30 MB.
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
If applicable, the internal reference ID to the payment page capturing the payment.
0
Transaction date and time, in UTC.
"2025-10-19T00:00:00"
The Payabli-generated unique ID for the customer.
4440
Customer/Payor first name.
"John"
Customer/Payor last name.
"Doe"
Customer's company name.
"Sunshine LLC"
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250
"3456-7645A"
Customer's billing address.
"1111 West 1st Street"
Additional line for Customer's billing address.
"Suite 200"
Customer's billing city.
"Miami"
Customer's billing state. Must be 2-letter state code for address in US.
"FL"
Customer's billing ZIP code.
"45567"
Customer's billing country.
"US"
Customer's phone number.
"5555555555"
Customer's email address.
320
"example@email.com"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
The Payabli-generated unique ID for the customer.
4440
Customer Status. Possible values:
-99
Deleted0
Inactive1
Active85
Locked (typically due to multiple failed login attempts)
1
Array of field names to be used as identifiers.
[
"\\\"firstname\\\"",
"\\\"lastname\\\"",
"\\\"email\\\"",
"\\\"customId\\\""
]
Service Fee or sub-charge transaction associated to the main transaction.
Timestamp when transaction was submitted, in UTC.
"\"2025-01-16T01:06:40.97\""
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
The entrypoint the split should be sent to.
"41035afaa7"
The accountId for the account the split should be sent to.
"187-782"
A description for the split.
"Split for annual dues"
Amount from the transaction to sent to this recipient.
456.23
Events associated with this transaction.
Event descriptor. See TransEvent Reference for more details.
"Approved"
Any data associated to the event received from processor. Contents vary by event type.
Date and time of event.
The difference between the configured pass-through fee and the fee amount sent in the request. When transfering funds, Payabli uses this field to deduct the fee difference and transfer the correct amount to the merchant.
When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See Fee Configuration to learn more about pass-through fee settings.
2
Identifier of registered cloud device used in the transaction.
"6c361c7d-674c-44cc-b790-382b75d1xxx"
Standard Entry Class (SEC) code is a a three letter code that describes how an ACH payment was authorized. Supported values are:
- PPD (Prearranged Payment and Deposit) - Used for credits or debits where an accountholder authorizes a company to initiate either a single or recurring transaction to their personal bank account. Common examples include direct deposit of payroll, mortgage payments, or utility bills. This is the default value for subscription payments.
- WEB (Internet-Initiated/Mobile Entry) - Used for debit entries when authorization is obtained from an accountholder via the internet or a wireless network. Common examples are online bill payments, ecommerce purchases, and mobile app payments where the consumer enters their banking information online.
- TEL (Telephone-Initiated Entry) - Used for one-time debit entries where authorization is obtained from a consumer via telephone. Common examples are phone-based purchases or bill payments where the consumer provides their banking information over the phone.
- CCD (Corporate Credit or Debit) - Used for fund transfers between business accounts. This code is specifically for business-to-business transactions. Common examples include vendor payments and other business-to-business payments.
The bank's accountholder type: personal or business.
personal
, business
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/ChargeBacks/read/{Id} \
--header 'requestToken: <api-key>'
{
"id": 201,
"chargebackDate": "2022-06-25",
"caseNumber": "TZ45678",
"reasonCode": "<string>",
"reason": "Buyer dispute",
"status": 1,
"PaymentId": "34-ggghtt5678xxxxxxx-654",
"referenceNumber": "<string>",
"lastFour": "6789",
"accountType": "visa",
"method": "card",
"createdAt": "2022-07-01 15:00:01",
"orderId": "O-5140",
"netAmount": 3762.87,
"transactionTime": "\"2025-01-16T01:06:40.97\"",
"customer": {
"CustomerId": 4440,
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Sunshine LLC",
"CustomerNumber": "3456-7645A",
"BillingAddress1": "1111 West 1st Street",
"BillingAddress2": "Suite 200",
"BillingCity": "Miami",
"BillingState": "FL",
"BillingZip": "45567",
"BillingCountry": "US",
"BillingPhone": "5555555555",
"BillingEmail": "example@email.com",
"ShippingAddress1": "123 Walnut St",
"ShippingAddress2": "STE 900",
"ShippingCity": "Johnson City",
"ShippingState": "TN",
"ShippingZip": "37619",
"ShippingCountry": "US",
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"CreatedAt": "2022-07-01 15:00:01",
"customerId": 4440,
"customerStatus": 1,
"Identifiers": [
"\\\"firstname\\\"",
"\\\"lastname\\\"",
"\\\"email\\\"",
"\\\"customId\\\""
]
},
"paymentData": {
"MaskedAccount": "4XXXXXXXX1111",
"AccountType": "visa",
"AccountExp": "11/29",
"AccountZip": "90210",
"HolderName": "Chad Mercia",
"orderDescription": "Depost for materials for 123 Walnut St",
"StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
"Initiator": "payor",
"StoredMethodUsageType": "subscription",
"Sequence": "subsequent",
"accountId": "<string>",
"SignatureData": null,
"binData": {
"binMatchedLength": 6,
"binCardBrand": "Visa",
"binCardType": "Credit",
"binCardCategory": "PLATINUM",
"binCardIssuer": "Bank of Example",
"binCardIssuerCountry": "United States",
"binCardIssuerCountryCodeA2": "US",
"binCardIssuerCountryNumber": 840
},
"paymentDetails": {
"totalAmount": 100,
"serviceFee": 0,
"currency": "USD",
"checkNumber": "107",
"checkImage": {},
"categories": [
{
"label": "Deposit",
"description": "Deposit for materials",
"amount": 1000,
"qty": 1
}
],
"splitFunding": [
{
"recipientEntryPoint": "41035afaa7",
"accountId": "187-782",
"description": "Split for annual dues",
"amount": 456.23
}
]
}
},
"paypointLegalname": "Sunshine Services, LLC",
"paypointDbaname": "Sunshine Gutters",
"parentOrgName": "PropertyManager Pro",
"paypointEntryname": "d193cf9a46",
"responses": [
{
"id": 672,
"contactName": "John Doe",
"contactEmail": "example@email.com",
"notes": "any note here",
"attachments": {
"zipfile": "zx45.zip",
"filelist": [
{
"originalName": "<string>",
"zipName": "<string>"
}
]
},
"createdAt": "2022-07-01 15:00:01"
}
],
"transaction": {
"ParentOrgName": "PropertyManager Pro",
"PaypointDbaname": "Sunshine Gutters",
"PaypointLegalname": "Sunshine Services, LLC",
"PaypointEntryname": "d193cf9a46",
"PaymentTransId": "226-fe55ec0348e34702bd91b4be198ce7ec",
"ConnectorName": "gp",
"ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]",
"GatewayTransId": "TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0",
"OrderId": "O-5140",
"Method": "ach",
"BatchNumber": "batch_226_ach_12-30-2023",
"BatchAmount": 30.22,
"PayorId": 1551,
"PaymentData": {
"MaskedAccount": "4XXXXXXXX1111",
"AccountType": "visa",
"AccountExp": "11/29",
"AccountZip": "90210",
"HolderName": "Chad Mercia",
"orderDescription": "Depost for materials for 123 Walnut St",
"StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
"Initiator": "payor",
"StoredMethodUsageType": "subscription",
"Sequence": "subsequent",
"accountId": "<string>",
"SignatureData": null,
"binData": {
"binMatchedLength": 6,
"binCardBrand": "Visa",
"binCardType": "Credit",
"binCardCategory": "PLATINUM",
"binCardIssuer": "Bank of Example",
"binCardIssuerCountry": "United States",
"binCardIssuerCountryCodeA2": "US",
"binCardIssuerCountryNumber": 840
},
"paymentDetails": {
"totalAmount": 100,
"serviceFee": 0,
"currency": "USD",
"checkNumber": "107",
"checkImage": {},
"categories": [
{
"label": "Deposit",
"description": "Deposit for materials",
"amount": 1000,
"qty": 1
}
],
"splitFunding": [
{
"recipientEntryPoint": "41035afaa7",
"accountId": "187-782",
"description": "Split for annual dues",
"amount": 456.23
}
]
}
},
"TransStatus": 1,
"PaypointId": 226,
"TotalAmount": 30.22,
"NetAmount": 3762.87,
"FeeAmount": 1,
"SettlementStatus": 2,
"Operation": "Sale",
"ResponseData": {
"response": "<string>",
"responsetext": "CAPTURED",
"authcode": null,
"transactionid": "TRN_XXXXXGOa87juzW",
"avsresponse": "<string>",
"avsresponse_text": "<string>",
"cvvresponse": "<string>",
"cvvresponse_text": "<string>",
"orderid": "O-5140",
"type": "<string>",
"response_code": "XXX",
"response_code_text": "Transaction was approved.",
"emv_auth_response_data": "<string>"
},
"Source": "api",
"ScheduleReference": 0,
"OrgId": 123,
"RefundId": 0,
"ReturnedId": 0,
"TransAdditionalData": "<any>",
"InvoiceData": {
"invoiceNumber": "INV-2345",
"invoiceDate": "2024-07-01",
"invoiceDueDate": "2024-07-01",
"invoiceType": 0,
"invoiceEndDate": "2024-07-01",
"invoiceStatus": 1,
"frequency": "monthly",
"paymentTerms": "PIA",
"termsConditions": "Must be paid before work scheduled.",
"notes": "Example notes.",
"tax": 2.05,
"discount": 10,
"invoiceAmount": 105,
"freightAmount": 10,
"dutyAmount": 0,
"purchaseOrder": "PO-345",
"firstName": "Chad",
"lastName": "Mercia",
"company": "ACME, INC",
"shippingAddress1": "123 Walnut St",
"shippingAddress2": "STE 900",
"shippingCity": "Johnson City",
"shippingState": "TN",
"shippingZip": "37619",
"shippingCountry": "US",
"shippingEmail": "example@email.com",
"shippingPhone": "5555555555",
"shippingFromZip": "30040",
"summaryCommodityCode": "501718",
"items": [
{
"itemProductCode": "M-DEPOSIT",
"itemProductName": "Materials deposit",
"itemDescription": "Deposit for materials.",
"itemCommodityCode": "010",
"itemUnitOfMeasure": "SqFt",
"itemCost": 5,
"itemQty": 1,
"itemMode": 0,
"itemCategories": [
"<string>"
],
"itemTotalAmount": 123,
"itemTaxAmount": 7,
"itemTaxRate": 0.075
}
],
"attachments": {},
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"EntrypageId": 0,
"TransactionTime": "2025-10-19T00:00:00",
"Customer": {
"CustomerId": 4440,
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Sunshine LLC",
"CustomerNumber": "3456-7645A",
"BillingAddress1": "1111 West 1st Street",
"BillingAddress2": "Suite 200",
"BillingCity": "Miami",
"BillingState": "FL",
"BillingZip": "45567",
"BillingCountry": "US",
"BillingPhone": "5555555555",
"BillingEmail": "example@email.com",
"ShippingAddress1": "123 Walnut St",
"ShippingAddress2": "STE 900",
"ShippingCity": "Johnson City",
"ShippingState": "TN",
"ShippingZip": "37619",
"ShippingCountry": "US",
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"CreatedAt": "2022-07-01 15:00:01",
"customerId": 4440,
"customerStatus": 1,
"Identifiers": [
"\\\"firstname\\\"",
"\\\"lastname\\\"",
"\\\"email\\\"",
"\\\"customId\\\""
]
},
"CfeeTransactions": [
{
"cFeeTransid": "<string>",
"transStatus": 123,
"feeAmount": 123,
"settlementStatus": 123,
"operation": "<string>",
"responseData": {},
"refundId": 123,
"transactionTime": "\"2025-01-16T01:06:40.97\""
}
],
"splitFundingInstructions": [
{
"recipientEntryPoint": "41035afaa7",
"accountId": "187-782",
"description": "Split for annual dues",
"amount": 456.23
}
],
"TransactionEvents": [
{
"TransEvent": "Approved",
"EventData": {},
"EventTime": "2023-11-07T05:31:56Z"
}
],
"PendingFeeAmount": 2,
"DeviceId": "6c361c7d-674c-44cc-b790-382b75d1xxx",
"AchSecCode": "<string>",
"AchHolderType": "personal"
}
}