Get dispute record

GET

/ChargeBacks/read/:Id

GET

/api/ChargeBacks/read/:Id

$ curl https://api-sandbox.payabli.com/api/ChargeBacks/read/1000000 \
>      -H "requestToken: <apiKey>"

1 {
2   "accountType": "visa",
3   "caseNumber": "TZ45678",
4   "chargebackDate": "2022-06-25T00:00:00Z",
5   "createdAt": "2022-07-01T15:00:01Z",
6   "customer": {
7     "AdditionalData": "AdditionalData",
8     "BillingAddress1": "1111 West 1st Street",
9     "BillingAddress2": "Suite 200",
10     "BillingCity": "Miami",
11     "BillingCountry": "US",
12     "BillingEmail": "example@email.com",
13     "BillingPhone": "5555555555",
14     "BillingState": "FL",
15     "BillingZip": "45567",
16     "CompanyName": "Sunshine LLC",
17     "CreatedAt": "2022-07-01T15:00:01Z",
18     "customerId": 4440,
19     "CustomerId": 4440,
20     "CustomerNumber": "3456-7645A",
21     "customerStatus": 1,
22     "FirstName": "John",
23     "Identifiers": [
24       "\\\"firstname\\\"",
25       "\\\"lastname\\\"",
26       "\\\"email\\\"",
27       "\\\"customId\\\""
28     ],
29     "LastName": "Doe",
30     "ShippingAddress1": "123 Walnut St",
31     "ShippingAddress2": "STE 900",
32     "ShippingCity": "Johnson City",
33     "ShippingCountry": "US",
34     "ShippingState": "TN",
35     "ShippingZip": "37619"
36   },
37   "id": 201,
38   "lastFour": "6789",
39   "method": "card",
40   "netAmount": 3762.87,
41   "orderId": "O-5140",
42   "parentOrgName": "PropertyManager Pro",
43   "paymentData": {
44     "AccountExp": "11/29",
45     "accountId": "accountId",
46     "AccountType": "visa",
47     "AccountZip": "90210",
48     "binData": {
49       "binCardBrand": "Visa",
50       "binCardCategory": "PLATINUM",
51       "binCardIssuer": "Bank of Example",
52       "binCardIssuerCountry": "United States",
53       "binCardIssuerCountryCodeA2": "US",
54       "binCardIssuerCountryNumber": 840,
55       "binCardType": "Credit",
56       "binMatchedLength": 6
57     },
58     "HolderName": "Chad Mercia",
59     "Initiator": "payor",
60     "MaskedAccount": "4XXXXXXXX1111",
61     "orderDescription": "Depost for materials for 123 Walnut St",
62     "paymentDetails": {
63       "totalAmount": 100,
64       "categories": [
65         {
66           "amount": 1000,
67           "label": "Deposit"
68         }
69       ],
70       "checkImage": {
71         "key": "value"
72       },
73       "checkNumber": "107",
74       "currency": "USD",
75       "serviceFee": 0,
76       "splitFunding": [
77         {}
78       ]
79     },
80     "Sequence": "subsequent",
81     "SignatureData": "SignatureData",
82     "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
83     "StoredMethodUsageType": "subscription"
84   },
85   "PaymentId": "34-ggghtt5678xxxxxxx-654",
86   "paypointDbaname": "Sunshine Gutters",
87   "paypointEntryname": "d193cf9a46",
88   "paypointLegalname": "Sunshine Services, LLC",
89   "reason": "Buyer dispute",
90   "reasonCode": "reasonCode",
91   "referenceNumber": "referenceNumber",
92   "responses": [
93     {
94       "contactEmail": "example@email.com",
95       "contactName": "John Doe",
96       "createdAt": "2022-07-01T15:00:01Z",
97       "id": 672,
98       "notes": "any note here"
99     }
100   ],
101   "status": 1,
102   "transaction": {
103     "AchHolderType": "personal",
104     "AchSecCode": "AchSecCode",
105     "BatchAmount": 30.22,
106     "BatchNumber": "batch_226_ach_12-30-2023",
107     "CfeeTransactions": [
108       {
109         "transactionTime": "2024-01-15T09:30:00Z"
110       }
111     ],
112     "ConnectorName": "gp",
113     "Customer": {
114       "AdditionalData": "AdditionalData",
115       "BillingAddress1": "1111 West 1st Street",
116       "BillingAddress2": "Suite 200",
117       "BillingCity": "Miami",
118       "BillingCountry": "US",
119       "BillingEmail": "example@email.com",
120       "BillingPhone": "5555555555",
121       "BillingState": "FL",
122       "BillingZip": "45567",
123       "CompanyName": "Sunshine LLC",
124       "CreatedAt": "2022-07-01T15:00:01Z",
125       "customerId": 4440,
126       "CustomerId": 4440,
127       "CustomerNumber": "3456-7645A",
128       "customerStatus": 1,
129       "FirstName": "John",
130       "Identifiers": [
131         "\\\"firstname\\\"",
132         "\\\"lastname\\\"",
133         "\\\"email\\\"",
134         "\\\"customId\\\""
135       ],
136       "LastName": "Doe",
137       "ShippingAddress1": "123 Walnut St",
138       "ShippingAddress2": "STE 900",
139       "ShippingCity": "Johnson City",
140       "ShippingCountry": "US",
141       "ShippingState": "TN",
142       "ShippingZip": "37619"
143     },
144     "DeviceId": "6c361c7d-674c-44cc-b790-382b75d1xxx",
145     "EntrypageId": 0,
146     "ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]",
147     "FeeAmount": 1,
148     "GatewayTransId": "TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0",
149     "InvoiceData": {
150       "AdditionalData": "AdditionalData",
151       "attachments": [
152         {}
153       ],
154       "company": "ACME, INC",
155       "discount": 10,
156       "dutyAmount": 0,
157       "firstName": "Chad",
158       "freightAmount": 10,
159       "frequency": "one-time",
160       "invoiceAmount": 105,
161       "invoiceDate": "2025-07-01",
162       "invoiceDueDate": "2025-07-01",
163       "invoiceEndDate": "2025-07-01",
164       "invoiceNumber": "INV-2345",
165       "invoiceStatus": 1,
166       "invoiceType": 0,
167       "items": [
168         {
169           "itemCost": 5,
170           "itemProductName": "Materials deposit",
171           "itemQty": 1
172         }
173       ],
174       "lastName": "Mercia",
175       "notes": "Example notes.",
176       "paymentTerms": "PIA",
177       "purchaseOrder": "PO-345",
178       "shippingAddress1": "123 Walnut St",
179       "shippingAddress2": "STE 900",
180       "shippingCity": "Johnson City",
181       "shippingCountry": "US",
182       "shippingEmail": "example@email.com",
183       "shippingFromZip": "30040",
184       "shippingPhone": "5555555555",
185       "shippingState": "TN",
186       "shippingZip": "37619",
187       "summaryCommodityCode": "501718",
188       "tax": 2.05,
189       "termsConditions": "Must be paid before work scheduled."
190     },
191     "Method": "ach",
192     "NetAmount": 3762.87,
193     "Operation": "Sale",
194     "OrderId": "O-5140",
195     "OrgId": 123,
196     "ParentOrgName": "PropertyManager Pro",
197     "PaymentData": {
198       "AccountExp": "11/29",
199       "accountId": "accountId",
200       "AccountType": "visa",
201       "AccountZip": "90210",
202       "binData": {
203         "binCardBrand": "Visa",
204         "binCardCategory": "PLATINUM",
205         "binCardIssuer": "Bank of Example",
206         "binCardIssuerCountry": "United States",
207         "binCardIssuerCountryCodeA2": "US",
208         "binCardIssuerCountryNumber": 840,
209         "binCardType": "Credit",
210         "binMatchedLength": 6
211       },
212       "HolderName": "Chad Mercia",
213       "Initiator": "payor",
214       "MaskedAccount": "4XXXXXXXX1111",
215       "orderDescription": "Depost for materials for 123 Walnut St",
216       "paymentDetails": {
217         "totalAmount": 100
218       },
219       "Sequence": "subsequent",
220       "SignatureData": "SignatureData",
221       "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
222       "StoredMethodUsageType": "subscription"
223     },
224     "PaymentTransId": "226-fe55ec0348e34702bd91b4be198ce7ec",
225     "PayorId": 1551,
226     "PaypointDbaname": "Sunshine Gutters",
227     "PaypointEntryname": "d193cf9a46",
228     "PaypointId": 226,
229     "PaypointLegalname": "Sunshine Services, LLC",
230     "PendingFeeAmount": 2,
231     "RefundId": 0,
232     "ResponseData": {
233       "authcode": "authcode",
234       "avsresponse": "avsresponse",
235       "avsresponse_text": "avsresponse_text",
236       "cvvresponse": "cvvresponse",
237       "cvvresponse_text": "cvvresponse_text",
238       "emv_auth_response_data": "emv_auth_response_data",
239       "orderid": "O-5140",
240       "response": "response",
241       "response_code": "XXX",
242       "response_code_text": "Transaction was approved.",
243       "responsetext": "CAPTURED",
244       "transactionid": "TRN_XXXXXGOa87juzW",
245       "type": "type"
246     },
247     "ReturnedId": 0,
248     "ScheduleReference": 0,
249     "SettlementStatus": 2,
250     "Source": "api",
251     "splitFundingInstructions": [
252       {}
253     ],
254     "TotalAmount": 30.22,
255     "TransactionEvents": [
256       {}
257     ],
258     "TransactionTime": "2025-10-19T00:00:00Z",
259     "TransAdditionalData": {
260       "key": "value"
261     },
262     "TransStatus": 1
263   },
264   "transactionTime": "2024-01-15T09:30:00Z"
265 }

Retrieves a chargeback record and its details.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

IdlongRequired

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

Response

Success

accountTypestringOptional

Bank account type or card brand.

caseNumberstringOptional

Number of case assigned to the chargeback.

chargebackDatedatetimeOptional

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

createdAtdatetimeOptional

Timestamp when the register was created, in UTC.

customerobjectOptional

idlongOptional

Identifier of chargeback or return.

lastFourstringOptional

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

methodstringOptional

Type of payment vehicle: ach or card.

netAmountdoubleOptional

Net amount in chargeback or ACH return.

orderIdstringOptional<=250 characters

Custom identifier for the transaction.

parentOrgNamestringOptional

The name of the parent organization.

paymentDataobjectOptional

PaymentIdstringOptional

ReferenceId of the transaction in Payabli.

paypointDbanamestringOptional

The paypoint's DBA name.

paypointEntrynamestringOptional<=50 characters

The paypoint's entryname.

paypointLegalnamestringOptional

The paypoint's legal name.

reasonstringOptional

Text describing the chargeback or ACH return reason.

reasonCodestringOptional

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

referenceNumberstringOptional

Processor reference number to the chargeback.

responseslist of objectsOptional

Chargeback response records.

statusintegerOptional

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)

transactionobjectOptional

transactionTimedatetimeOptional

Timestamp when transaction was submitted, in UTC.

Errors

400

Bad Request Error

400

Bad Request Error

401

Unauthorized Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error