API reference / Disputes
Get the settings of disputes
Whether Troopy reads the disputes of the workspace's payment providers, which of them are connected, what it says the business sells, and the grant to submit to Stripe without a person.
/api/v1/dispute-settingsOther ways to call it
troopy disputes settingstroopy_get_dispute_settingsResponse
200 · application/jsondata*object13 properties
on*booleanWhether Troopy reads the disputes of the workspace's payment providers and prepares their evidence
connected*booleanWhether one of those providers is connected in this workspace
providers*array<object>The payment providers that Troopy reads disputes from, and whether this workspace connected each one
3 properties
id*enum<string>stripedodopaymentspaddle
name*stringconnected*booleandescription*string | nullWhat the business sells, as the bank reads it
kind*enum<string>servicesmerchandise
usageFromBackend*booleanWhether the backend of the business sends the usage of the customer for each dispute
refundPolicy*string | nullThe refund policy of the business, in its own words
cancellationPolicy*string | nullThe cancellation policy of the business, in its own words
disclosure*string | nullHow a customer sees the policies before a payment
autoSubmit*object | nullThe grant to submit without a person, while it is in force
6 properties
until*stringISO 8601 date and time
maxAmount*numberThe largest disputed amount that goes without a person, in the units of the currency
currency*stringdailyCap*integergrantedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringgrantedAt*stringISO 8601 date and time
ended*object | nullWhen the last grant ended, and why
2 properties
at*stringISO 8601 date and time
why*stringsyncedAt*string | nullWhen Troopy last read the disputes from the providers
error*string | nullWhat the last read of a provider said, when it failed