Skip to main content
GET
Get Chargebacks

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Page number (1-indexed). Defaults to 1.

Required range: x >= 1
page_size
integer
default:50

Number of items per page. Defaults to 50, and must be between 1 and 100.

Required range: 1 <= x <= 100
retailer_id
string<uuid>

Filter by retailer. Must be a retailer your brand is or was associated with.

po_number
string

Filter by purchase order number. Matched exactly.

chargeback_id
string

Filter by the retailer's chargeback number. Retailers assign these, so more than one chargeback can share a number.

start_date
string<date>

Only chargebacks the retailer issued on or after this date (YYYY-MM-DD).

end_date
string<date>

Only chargebacks the retailer issued on or before this date (YYYY-MM-DD).

dispute_status
enum<string>

Filter by dispute status. Comma-separate to match several, e.g. Won,Lost.

Available options:
Won,
Lost,
Pending Review,
Not Disputed,
Ready to Dispute,
Generating Proposal,
Submitting,
Submission Failed,
Expired
closed
boolean

Filter to settled chargebacks (true) or ones still open (false).

Response

Chargebacks retrieved successfully

message
string
Example:

"Chargebacks retrieved successfully"

data
object