Get Chargeback or ACH Return Record
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.
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
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
200
application/json
Success
The response is of type object
.
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"
}
}