APG PayAPG Paydocs

Card issuer

Get issuer transaction dispute

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

Return one dispute of this transaction. A dispute that does not belong to this issuerTransaction is a 404, not a redirect.

Permissions

Required permission
issuerTransactions:query

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

Path parameters

issuerTransactionIdstring
required
disputeIdstring
required

Responses

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

Discriminated by type
type = "ItxnDisputeAttributes"
disputeIdDisputeIdrequired

Identifier of a dispute.

Example dispute_9f2Kd8QpLzXw

referenceDisputeIdstring

Your own reference for the dispute.

Example your-own-reference

outcomeItxnDisputeOutcomerequired
PendingCustomerWonCustomerLostUnknown

The amount in dispute.

reasonstring

Example Requested by the customer.

metadatamap of any JSON value

Free-form data on the dispute.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "ItxnDisputeAttributes",
  "disputeId": "dispute_9f2Kd8QpLzXw",
  "referenceDisputeId": "your-own-reference",
  "outcome": "Pending",
  "amount": {
    "type": "IsoCurrencyAmount",
    "minorCurrencyUnits": 1250,
    "currency": "AUD"
  },
  "reason": "Requested by the customer.",
  "metadata": {
    "yourKey": {}
  },
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses