Get Chargeback or ACH Return Record

GET

ChargeBacks

read

{Id}

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

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

integer

required

ID of the chargeback or return record. This is returned as chargebackId in the RecievedChargeback and ReceivedAchReturn webhook notifications.

Response

200

application/json

Success

integer

Identifier of chargeback or return.

Example:

201

chargebackDate

string

Date of chargeback in format YYYY-MM-DD or MM/DD/YYYY.

Example:

"2022-06-25"

caseNumber

string

Number of case assigned to the chargeback.

Example:

"TZ45678"

reasonCode

string | null

'R' code for returned ACH or custom code identifying the reason.

reason

string | null

Text describing the chargeback or ACH return reason.

Example:

"Buyer dispute"

status

integer

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)

Example:

1

PaymentId

string | null

ReferenceId of the transaction in Payabli.

Example:

"34-ggghtt5678xxxxxxx-654"

referenceNumber

string | null

Processor reference number to the chargeback.

lastFour

string | null

Last 4 digits of card or bank account involved in chargeback or return.

Example:

"6789"

accountType

string | null

Bank account type or card brand.

Example:

"visa"

method

string | null

Type of payment vehicle: ach or card.

Example:

"card"

createdAt

string

Timestamp when the register was created, in UTC.

Example:

"2022-07-01 15:00:01"

orderId

string | null

Custom identifier for the transaction.

Maximum length: 250

Example:

"O-5140"

netAmount

number | null

Net amount in chargeback or ACH return.

Example:

3762.87

transactionTime

string

Timestamp when transaction was submitted, in UTC.

Example:

"\"2025-01-16T01:06:40.97\""

customer

object

customer.CustomerId

integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

customer.FirstName

string | null

Customer/Payor first name.

Example:

"John"

customer.LastName

string | null

Customer/Payor last name.

Example:

"Doe"

customer.CompanyName

string | null

Customer's company name.

Example:

"Sunshine LLC"

customer.CustomerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

Example:

"3456-7645A"

customer.BillingAddress1

string | null

Customer's billing address.

Example:

"1111 West 1st Street"

customer.BillingAddress2

string | null

Additional line for Customer's billing address.

Example:

"Suite 200"

customer.BillingCity

string | null

Customer's billing city.

Example:

"Miami"

customer.BillingState

string | null

Customer's billing state. Must be 2-letter state code for address in US.

Example:

"FL"

customer.BillingZip

string | null

Customer's billing ZIP code.

Example:

"45567"

customer.BillingCountry

string | null

Customer's billing country.

Example:

"US"

customer.BillingPhone

string | null

Customer's phone number.

Example:

"5555555555"

customer.BillingEmail

string | null

Customer's email address.

Maximum length: 320

Example:

"example@email.com"

customer.ShippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

customer.ShippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

customer.ShippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

customer.ShippingState

string | null

Shipping state or province.

Example:

"TN"

customer.ShippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

customer.ShippingCountry

string | null

Shipping address country.

Example:

"US"

customer.AdditionalData

string | null

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

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

customer.CreatedAt

string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

customer.customerId

integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

customer.customerStatus

integer | null

Customer Status. Possible values:

-99 Deleted
0 Inactive
1 Active
85 Locked (typically due to multiple failed login attempts)

Example:

1

customer.Identifiers

any[] | null

Array of field names to be used as identifiers.

Example:

[
  "\\\"firstname\\\"",
  "\\\"lastname\\\"",
  "\\\"email\\\"",
  "\\\"customId\\\""
]

paymentData

object

paymentData.MaskedAccount

string | null

Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).

Example:

"4XXXXXXXX1111"

paymentData.AccountType

string | null

Bank account type or card brand.

Example:

"visa"

paymentData.AccountExp

string | null

Expiration date of card used in transaction.

Example:

"11/29"

paymentData.AccountZip

string | null

ZIP code for card used in transaction.

Example:

"90210"

paymentData.HolderName

string | null

Account holder name for the method.

Example:

"Chad Mercia"

paymentData.orderDescription

string | null

Text description of the transaction.

Maximum length: 250

Example:

"Depost for materials for 123 Walnut St"

paymentData.StoredId

string | null

Identifier of stored payment method used in transaction.

Example:

"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"

paymentData.Initiator

string | null

default:merchant

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 transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

Example:

"payor"

paymentData.StoredMethodUsageType

string | null

default:unscheduled

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.

Example:

"subscription"

paymentData.Sequence

string | null

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.

Example:

"subsequent"

paymentData.accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

paymentData.SignatureData

string | null

Example:

null

paymentData.binData

object

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.

paymentData.paymentDetails

object

Details about the payment.

paymentData.paymentDetails.totalAmount

number

required

Total amount to be charged. If a service fee is sent, then this amount should include the service fee."

Example:

100

paymentData.paymentDetails.serviceFee

number | null

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.

Example:

0

paymentData.paymentDetails.currency

string | null

Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.

Example:

"USD"

paymentData.paymentDetails.checkNumber

string | null

A check number to be used in the ach transaction. Required for payment method = 'check'.

Example:

"107"

paymentData.paymentDetails.checkImage

object | null

Object containing image of paper check.

paymentData.paymentDetails.categories

object[] | null

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.

paymentData.paymentDetails.splitFunding

object[] | null

Split funding instructions for the transaction. See Split a Transaction for more.

paypointLegalname

string | null

The paypoint's legal name.

Example:

"Sunshine Services, LLC"

paypointDbaname

string | null

The paypoint's DBA name.

Example:

"Sunshine Gutters"

parentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

paypointEntryname

string | null

The paypoint's entryname.

Maximum length: 50

Example:

"d193cf9a46"

responses

object[] | null

Chargeback response records.

transaction

object

transaction.ParentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

transaction.PaypointDbaname

string | null

Paypoint's DBA name.

Example:

"Sunshine Gutters"

transaction.PaypointLegalname

string | null

Paypoint's legal name.

Example:

"Sunshine Services, LLC"

transaction.PaypointEntryname

string | null

Paypoint's entryname.

Maximum length: 50

Example:

"d193cf9a46"

transaction.PaymentTransId

string | null

Unique Transaction ID.

Example:

"226-fe55ec0348e34702bd91b4be198ce7ec"

transaction.ConnectorName

string | null

Connector used for transaction.

Example:

"gp"

transaction.ExternalProcessorInformation

string | null

Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.

Example:

"[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]"

transaction.GatewayTransId

string | null

Internal identifier used for processing.

Example:

"TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0"

transaction.OrderId

string | null

Custom identifier for the transaction.

Maximum length: 250

Example:

"O-5140"

transaction.Method

string | null

Payment method used: card, ach, or wallet.

Example:

"ach"

transaction.BatchNumber

string | null

Batch number.

Example:

"batch_226_ach_12-30-2023"

transaction.BatchAmount

number | null

Batch amount.

Example:

30.22

transaction.PayorId

integer

Unique ID for customer linked to the transaction.

Example:

1551

transaction.PaymentData

object

transaction.PaymentData.MaskedAccount

string | null

Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).

Example:

"4XXXXXXXX1111"

transaction.PaymentData.AccountType

string | null

Bank account type or card brand.

Example:

"visa"

transaction.PaymentData.AccountExp

string | null

Expiration date of card used in transaction.

Example:

"11/29"

transaction.PaymentData.AccountZip

string | null

ZIP code for card used in transaction.

Example:

"90210"

transaction.PaymentData.HolderName

string | null

Account holder name for the method.

Example:

"Chad Mercia"

transaction.PaymentData.orderDescription

string | null

Text description of the transaction.

Maximum length: 250

Example:

"Depost for materials for 123 Walnut St"

transaction.PaymentData.StoredId

string | null

Identifier of stored payment method used in transaction.

Example:

"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"

transaction.PaymentData.Initiator

string | null

default:merchant

Available values:

payor: For cardholder-initiated transactions
merchant: For merchant-initiated transactions

See Understanding CIT and MIT Indicators for more information.

Example:

"payor"

transaction.PaymentData.StoredMethodUsageType

string | null

default:unscheduled

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.

Example:

"subscription"

transaction.PaymentData.Sequence

string | null

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.

Example:

"subsequent"

transaction.PaymentData.accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

transaction.PaymentData.SignatureData

string | null

Example:

null

transaction.PaymentData.binData

object

transaction.PaymentData.paymentDetails

object

Details about the payment.

transaction.PaymentData.paymentDetails.totalAmount

number

required

Total amount to be charged. If a service fee is sent, then this amount should include the service fee."

Example:

100

transaction.PaymentData.paymentDetails.serviceFee

number | null

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.

Example:

0

transaction.PaymentData.paymentDetails.currency

string | null

Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.

Example:

"USD"

transaction.PaymentData.paymentDetails.checkNumber

string | null

A check number to be used in the ach transaction. Required for payment method = 'check'.

Example:

"107"

transaction.PaymentData.paymentDetails.checkImage

object | null

Object containing image of paper check.

transaction.PaymentData.paymentDetails.categories

object[] | null

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.

transaction.PaymentData.paymentDetails.splitFunding

object[] | null

Split funding instructions for the transaction. See Split a Transaction for more.

transaction.TransStatus

integer

Status of transaction. See the docs for a full reference.

Example:

1

transaction.PaypointId

integer

InternalId for paypoint.

Example:

226

transaction.TotalAmount

number

Transaction total amount (including service fee or sub-charge)

Example:

30.22

transaction.NetAmount

number | null

Net amount paid.

Example:

3762.87

transaction.FeeAmount

number

Service fee or sub-charge applied.

Example:

1

transaction.SettlementStatus

integer

Settlement status for transaction. See the docs for a full reference.

Example:

2

transaction.Operation

string | null

The transaction's operation.

Example:

"Sale"

transaction.ResponseData

object

The transaction's response data.

transaction.Source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Example:

"api"

transaction.ScheduleReference

integer | null

Reference to the subscription that originated the transaction.

Example:

0

transaction.OrgId

integer | null

ID of immediate parent organization.

Example:

123

transaction.RefundId

integer | null

Identifier of refund transaction linked to this payment.

Example:

0

transaction.ReturnedId

integer | null

Identifier of return/chargeback transaction linked to this payment.

Example:

0

transaction.TransAdditionalData

any

Not currently in use.

transaction.InvoiceData

object

transaction.InvoiceData.invoiceNumber

string | null

Invoice number. Identifies the invoice under a paypoint.

Maximum length: 250

Example:

"INV-2345"

transaction.InvoiceData.invoiceDate

string | null

Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

transaction.InvoiceData.invoiceDueDate

string | null

Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

transaction.InvoiceData.invoiceType

integer | null

Type of invoice. Only 0 for one-time invoices is currently supported.

Example:

0

transaction.InvoiceData.invoiceEndDate

string | null

Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

transaction.InvoiceData.invoiceStatus

enum<integer> | null

Status for invoice.

The accepted status values are:

0 draft
1 active
2 partially paid
4 paid/complete
99 cancelled

Available options:

0,

1,

2,

4,

99

Example:

1

transaction.InvoiceData.frequency

enum<string> | null

Frequency of scheduled invoice.

Available options:

one-time,

weekly,

every2weeks,

every6months,

monthly,

every3months,

annually

Example:

"monthly"

transaction.InvoiceData.paymentTerms

enum<string> | null

Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.

Available options:

PIA,

CIA,

UR,

NET10,

NET20,

NET30,

NET45,

NET60,

NET90,

EOM,

MFI,

5MFI,

10MFI,

15MFI,

20MFI,

2/10NET30,

UF,

10UF,

20UF,

25UF,

50UF

Example:

"PIA"

transaction.InvoiceData.termsConditions

string | null

Custom terms and conditions included in the invoice.

Example:

"Must be paid before work scheduled."

transaction.InvoiceData.notes

string | null

Notes included in the invoice.

Example:

"Example notes."

transaction.InvoiceData.tax

number | null

Tax rate in percent applied to the invoice.

Example:

2.05

transaction.InvoiceData.discount

number | null

Discount applied to the invoice.

Example:

10

transaction.InvoiceData.invoiceAmount

number | null

Invoice total amount.

Example:

105

transaction.InvoiceData.freightAmount

number | null

Freight/shipping amount.

Example:

10

transaction.InvoiceData.dutyAmount

number | null

Duty amount.

Example:

0

transaction.InvoiceData.purchaseOrder

string | null

Purchase order number.

Example:

"PO-345"

transaction.InvoiceData.firstName

string | null

First name of the recipient of the invoice.

Example:

"Chad"

transaction.InvoiceData.lastName

string | null

Last name of the recipient of the invoice.

Example:

"Mercia"

transaction.InvoiceData.company

string | null

Company name of the recipient of the invoice.

Example:

"ACME, INC"

transaction.InvoiceData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

transaction.InvoiceData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

transaction.InvoiceData.shippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

transaction.InvoiceData.shippingState

string | null

Shipping state or province.

Example:

"TN"

transaction.InvoiceData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

transaction.InvoiceData.shippingCountry

string | null

Shipping address country.

Example:

"US"

transaction.InvoiceData.shippingEmail

string | null

Shipping recipient's contact email address.

Maximum length: 320

Example:

"example@email.com"

transaction.InvoiceData.shippingPhone

string | null

Recipient phone number.

Example:

"5555555555"

transaction.InvoiceData.shippingFromZip

string | null

Sender shipping ZIP code.

Example:

"30040"

transaction.InvoiceData.summaryCommodityCode

string | null

Commodity code.

Example:

"501718"

transaction.InvoiceData.items

object[] | null

Array of line items included in the invoice.

transaction.InvoiceData.attachments

object | null

Array of fileContent objects with attached documents. Max upload size is 30 MB.

transaction.InvoiceData.AdditionalData

string | null

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

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

transaction.EntrypageId

integer

If applicable, the internal reference ID to the payment page capturing the payment.

Example:

0

transaction.TransactionTime

string | null

Transaction date and time, in UTC.

Example:

"2025-10-19T00:00:00"

transaction.Customer

object

transaction.Customer.CustomerId

integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

transaction.Customer.FirstName

string | null

Customer/Payor first name.

Example:

"John"

transaction.Customer.LastName

string | null

Customer/Payor last name.

Example:

"Doe"

transaction.Customer.CompanyName

string | null

Customer's company name.

Example:

"Sunshine LLC"

transaction.Customer.CustomerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

Example:

"3456-7645A"

transaction.Customer.BillingAddress1

string | null

Customer's billing address.

Example:

"1111 West 1st Street"

transaction.Customer.BillingAddress2

string | null

Additional line for Customer's billing address.

Example:

"Suite 200"

transaction.Customer.BillingCity

string | null

Customer's billing city.

Example:

"Miami"

transaction.Customer.BillingState

string | null

Customer's billing state. Must be 2-letter state code for address in US.

Example:

"FL"

transaction.Customer.BillingZip

string | null

Customer's billing ZIP code.

Example:

"45567"

transaction.Customer.BillingCountry

string | null

Customer's billing country.

Example:

"US"

transaction.Customer.BillingPhone

string | null

Customer's phone number.

Example:

"5555555555"

transaction.Customer.BillingEmail

string | null

Customer's email address.

Maximum length: 320

Example:

"example@email.com"

transaction.Customer.ShippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

transaction.Customer.ShippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

transaction.Customer.ShippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

transaction.Customer.ShippingState

string | null

Shipping state or province.

Example:

"TN"

transaction.Customer.ShippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

transaction.Customer.ShippingCountry

string | null

Shipping address country.

Example:

"US"

transaction.Customer.AdditionalData

string | null

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

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

transaction.Customer.CreatedAt

string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

transaction.Customer.customerId

integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

transaction.Customer.customerStatus

integer | null

Customer Status. Possible values:

-99 Deleted
0 Inactive
1 Active
85 Locked (typically due to multiple failed login attempts)

Example:

1

transaction.Customer.Identifiers

any[] | null

Array of field names to be used as identifiers.

Example:

[
  "\\\"firstname\\\"",
  "\\\"lastname\\\"",
  "\\\"email\\\"",
  "\\\"customId\\\""
]

transaction.CfeeTransactions

object[] | null

Service Fee or sub-charge transaction associated to the main transaction.

transaction.splitFundingInstructions

object[] | null

Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.

transaction.TransactionEvents

object[] | null

Events associated with this transaction.

transaction.PendingFeeAmount

number | null

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.

Example:

2

transaction.DeviceId

string | null

Identifier of registered cloud device used in the transaction.

Example:

"6c361c7d-674c-44cc-b790-382b75d1xxx"

transaction.AchSecCode

string

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.

transaction.AchHolderType

enum<string> | null

default:personal

The bank's accountholder type: personal or business.

Available options:

personal,

business

Was this page helpful?

Get Links for Org Add Response

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

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Get Chargeback or ACH Return Record

Authorizations

Path Parameters

Response