Organization API: Billing & Payouts: Disputes
The 2 Organization API operations for disputes.
Part of Billing & Payouts.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/disputes |
List org disputes |
| GET | /api/v1/orgs/{org_slug}/disputes/{dispute_id} |
Get org dispute |
List org disputes
Section titled List org disputesGET /api/v1/orgs/{org_slug}/disputes
Chargebacks raised against this org's customers, newest first, each naming its customer and the invoice the payment was on.
Resellers had no dispute surface at all. Under platform_mor that is
arguable, since Coritan is merchant of record and it is our fight. Under
own_gateway it is not: the org's own store takes the chargeback, the
money comes off them, and they could not see it happen.
status filters in the query, before the page is cut. Without
with_total the answer keeps its older shape, {disputes}; with it,
total is counted from the clause the page is cut from and counts
are per state whatever the status asked for (counts.open is what the
Overview badges).
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
status |
query | string or null | no | open (no outcome recorded yet, whatever the gateway's own status word), an outcome (won, lost, accepted when conceded, unknown when the gateway did not say), or all. Left out, every dispute. |
limit |
query | integer | no | Default: 50. |
offset |
query | integer | no | Default: 0. |
with_total |
query | boolean | no | Answers {items, total, limit, offset, counts} instead of {disputes}; counts has all and each state. Default: False. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Get org dispute
Section titled Get org disputeGET /api/v1/orgs/{org_slug}/disputes/{dispute_id}
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
dispute_id |
path | integer | yes |
org_slug |
path | string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |