APG PayAPG Paydocs

Transactions

Update dispute

PATCH/disputes/{disputeId}

Record an outcome the scheme decided out of band, submit evidence, or move the case on.

2 actionsDisputeUpdateLostDisputeUpdateWon

Permissions

Required permission
disputes:update

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

Path parameters

disputeIdstring
required

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "DisputeUpdateLost"
gatewayStatestring
reverseFeesboolean

Example true

curl -X PATCH https://api.tst.au.apgpay.dev/disputes/{disputeId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "DisputeUpdateLost",
  "gatewayState": "string",
  "reverseFees": true
}'

Responses

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

Discriminated by type
type = "DisputeUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "DisputeUpdateRspAttributes",
  "updated": {
    "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