APG PayAPG Paydocs

Transactions

Get dispute

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

Return one dispute.

Permissions

Required permission
disputes:query

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

Path parameters

disputeIdstring
required

Responses

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

Discriminated by type
type = "DisputeViewAttributes"
disputeIdDisputeIdrequired

Identifier of a dispute.

Example dispute_9f2Kd8QpLzXw

The transaction this dispute challenges, acquiring or issuing.

merchantIdMchtIdrequired

Identifier of a merchant.

Example mcht_9f2Kd8QpLzXw

Who was paid back.

statusDisputeStatusrequired

The scheme's decision, as the platform records it.

PendingWonLostUnknown
gatewayStatestring

The gateway's own word for where the case is. Free-form, because the gateways do not agree on a vocabulary.

What a dispute challenges. Both amounts are in the single currency given here.

What the platform charges the merchant for handling the dispute. Billed in the platform's own currency, which is why it carries one rather than joining the money set.

reasonstring

Example Requested by the customer.

descriptionstring
orderIdOrdrIdrequired

The order the disputed payment settled.

Example ordr_9f2Kd8QpLzXw

referenceOrderIdstring

Example your-own-reference

orderMetadatamap of any JSON value

Free-form data the platform stores and returns untouched. Values may be nested objects and arrays.

evidenceDueBystring (date)

When evidence must be submitted by.

Example 2026-08-19

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses