For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • GETRetrieve Dispute
      • GETReceive Dispute
      • POSTRespond to Dispute
      • GETAccept Dispute
      • POSTUpload File
      • GETRetrieve file
LogoLogo
ReferenceDisputes

Retrieve Dispute

GET
/v2/disputes
GET
/v2/disputes
$curl -G https://global-api-sandbox.afterpay.com/v2/disputes \
>     -H "User-Agent: User-Agent" \
>     -u "<username>:<password>" \
>     -d offset=0 \
>     -d limit=10
200Retrieved
1{
2  "data": [
3    {
4      "id": "dp_N64jYg4RC4ZBUsXjLzE3W5",
5      "order": "123456789",
6      "amount": "48.46",
7      "reason": "product_not_received",
8      "status": "needs_response",
9      "open": true,
10      "responseDueBy": "1691884800",
11      "createdAt": "1691880800",
12      "openingNote": "Customer has no knowledge of the payment",
13      "closingReason": "merchant_accepted",
14      "merchantOrderId": "order54321",
15      "transactionDate": "1691882800",
16      "settlementAmount": "48.46",
17      "openingNoteAttachments": "[“fi_48vmw3sXdVqvtJGXbgKbAZ”]",
18      "updatedAt": "1691884000",
19      "closingNote": "Merchant accepted the dispute",
20      "meta": {
21        "transactionAmount": "48.46",
22        "orderType": "ONLINE",
23        "network": "Visa",
24        "networkReferenceId": "string"
25      }
26    }
27  ],
28  "offset": 0,
29  "limit": 1,
30  "total": 1
31}

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

Was this page helpful?
Previous

Receive Dispute

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(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
An array of dispute objects that match the filter criteria in the request.
offsetinteger
limitinteger
totalinteger