Eligibility Check
Required step between transaction selection and the reasons screen. Checks that each selected transaction is eligible - including the org's own disputability rules - and that the selection uses a single payment rail and a single card. On failure, returns one structured error per failed rule with a machine-readable code and a member-facing message, so the member can adjust their selection without leaving the flow. See the "Errors" concept page for the full list and recommended UI handling.
Query Parameters
- Type: stringcustomer
Uuid customer_uuid is the member identifier returned by ListAccounts. The encrypted tax-id form is not accepted here.
- Type: stringaccount
Uuid - Type: array of stringtransaction
Ids - Type: array of stringFormat: date-timetransaction
Dates Optional lookup hint: transaction_dates[i] is the approximate date of transaction_ids[i], matched +/-1 day; only the date portion is used. Providing it speeds the lookup; omitting it or getting it wrong never changes the result. May be shorter than transaction_ids; missing entries fall back to an unscoped lookup.
Responses
- application/json
- application/json
curl /v1/disputes/eligibility \
--header 'Authorization: YOUR_SECRET_TOKEN'
{
"eligible": false,
"errors": [
{
"code": "RAIL_MISMATCH",
"message": "Please select transactions of the same type. You cannot mix ACH and Debit transactions in a single dispute.",
"transactionIds": [
"tx-001",
"tx-002"
]
},
{
"code": "TRANSACTION_ALREADY_DISPUTED",
"message": "This transaction is already part of an open dispute.",
"transactionIds": [
"tx-003"
]
}
]
}