APG PayAPG Paydocs

Transactions

List transaction disputes

GET/transactions/{transactionId}/disputes
Request
GEThttps://api.tst.au.apgpay.dev/transactions/{transactionId}/disputes
curl -X GET https://api.tst.au.apgpay.dev/transactions/{transactionId}/disputes \
  -H "Authorization: Bearer $API_KEY"

Return a page of the disputes raised against this transaction. A transaction's disputes are few and read as one list, so they page by page only: startingAfter and endingBefore are refused with 400, with or without q.

Permissions

Required permission
transactions:query

Requires the `query` action on `transactions` for the supplied runtime context

Path parameters

transactionIdstring
required

Query parameters

qstring

Search. Matches a dispute id, the id of the transaction or order it disputes, or the gateway's dispute id, the reason or the state. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

statusone of DisputeStatus, array of DisputeStatus

Filter by dispute status. Repeat the parameter to supply several.

Responses

The response is a tagged shape: type is always "DisputePageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "DisputePageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "DisputePageAttributes",
  "data": [
    {
      "type": "DisputeViewAttributes",
      "disputeId": "dispute_9f2Kd8QpLzXw",
      "subject": {
        "type": "RfndSubjectTransaction",
        "transactionId": "tran_9f2Kd8QpLzXw"
      },
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "customer": {
        "type": "RfndCustomerAttributes",
        "customerId": "cust_9f2Kd8QpLzXw",
        "name": "Ada Lovelace",
        "emailAddress": "ada@example.com",
        "phoneNumber": "+61400000000"
      },
      "status": "Pending",
      "gatewayState": "string",
      "amounts": {
        "type": "DisputeAmountsAttributes",
        "currency": "AUD",
        "amount": 1250,
        "transactionAmount": 1250
      },
      "feeAmount": {
        "type": "IsoCurrencyAmount",
        "minorCurrencyUnits": 1250,
        "currency": "AUD"
      },
      "reason": "Requested by the customer.",
      "description": "string",
      "orderId": "ordr_9f2Kd8QpLzXw",
      "referenceOrderId": "your-own-reference",
      "orderMetadata": {
        "yourKey": {}
      },
      "evidenceDueBy": "2026-08-19",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses