Get Dispute by ID
Retrieve a dispute by ID, using include parameters to add its payment, instrument, evidence files, representment plan, and sections in one response.
Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Query Parameters
Response
Dispute found, and all details are included.
Channel the customer used to raise the dispute.
Not every provider reports a channel, and the field is only populated on
disputes received after it was introduced. It is therefore absent on many
disputes, and absence says nothing about how the dispute was raised — do not
read a missing channel as the absence of an issuer chargeback.
Provider: the customer raised the dispute with the payment provider directly, without involving their bank.Issuer: the customer went to their card issuer or bank, so the dispute is a card chargeback.Alert: the dispute arrived as a pre-chargeback alert, and no chargeback has been raised yet.Unknown: the Provider reported a channel that Payrails does not recognize.
Provider, Issuer, Alert, Unknown The evidences the latest successful defense sent to the payment service provider, for both AI and manual defenses. Returned only when the request sets includeEvidences=true. Omitted when no defense has recorded what it sent, including defenses made before this field existed.