API reference / Disputes
Prepare the evidence of a dispute again
Has Troopy read the records again and prepare the evidence again, within a minute. Use it after the records changed: a refund, new usage, or a new description of the business. It works only while the provider takes an answer and nothing went yet. Owners and admins.
/api/v1/disputes/{id}/prepareOther ways to call it
troopy disputes prepareIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
id*stringThe id of the dispute in Troopy, or its id at its payment provider, like du_1MtJUT2eZvKYlo2C in Stripe
At least 1 characters · At most 80 characters
Response
202 · application/jsondata*object18 properties
id*stringA 24-character id
provider*enum<string>The payment provider of the disputed payment. stripe: Troopy sends the evidence. dodopayments: a person uploads the evidence in the dashboard of Dodo Payments. paddle: Paddle answers by itself, and takes no evidence
stripedodopaymentspaddle
providerId*stringThe id of the dispute at its provider. For Paddle, the id of the disputed transaction
live*booleanfalse: a dispute of the test mode of the provider
amount*numberThe disputed amount, in the units of its currency
currency*stringreason*stringThe reason, in the words of Stripe: fraudulent, subscription_canceled or general, for example
status*stringThe status, in the words of Stripe for each provider: needs_response, under_review, won, lost, prevented, or one of the warning_ statuses of an inquiry
customer*object3 properties
id*string | nullemail*string | nullname*string | nullfiledAt*stringISO 8601 date and time
dueBy*string | nullWhen the provider stops taking an answer
stage*enum<string>Where Troopy is with it. preparing: it collects the evidence. waiting: the evidence waits for a person. submitting: it goes now. unknown: nobody knows if it went, and Troopy reads the dispute again. submitted: it went. let_go: a person decided not to answer. none: the provider takes no answer
preparingwaitingsubmittingunknownsubmittedlet_gonone
why*string | nullWhy it waits for a person, or what went wrong
usage*enum<string>The usage that the backend of the business sends. wanted: Troopy waits for it
nonewantedreceived
submittedAt*string | nullsubmittedBy*object | nullWho submitted the evidence, or said that it went. Under a grant: the person who granted it
3 properties
type*enum<string>personagentapi
id*stringname*stringauto*booleanWhether the evidence went under a grant, without a person
url*stringThe dispute, or its payment, in the dashboard of its provider