ReferenceDisputes

Retrieve Dispute

List disputes within a date range based on certain criteria. This endpoint can be used for debugging or synchronizing the disputes from Cash App Afterpay if/when you are unable to use the webhook method.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Query parameters

orderintegerOptional
Payment or Order token using which you can filter the list.
merchantstringOptional
Merchant token using which you can filter the list.
statusstringOptional
Dispute status using which you can filter the list.
openedAfterstringOptionalformat: "date-time"

Filter disputes that were created on or after this timestamp (inclusive).

openedBeforestringOptionalformat: "date-time"

Filter disputes that were created on or before this timestamp (inclusive).

offsetintegerOptional
Offset for the search results.
limitintegerOptional
The maximum number of records that you want returned from this request.

Response

Success
datalist of objects or null
An array of dispute objects that match the filter criteria in the request.
offsetinteger or null
limitinteger or null
totalinteger or null