APG PayAPG Paydocs

Card issuer

Create issuer disputes

POST/issuer-disputes

Raise a dispute against an issuer transaction, naming it by selector rather than by identifier.

Permissions

Required permission
issuerTransactions:orchestrate

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

Request body

This body is a tagged shape: type is always "IdspCmdCreate". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "IdspCmdCreate"

An amount in minor current units of a given currency.

reasonstring

Example Requested by the customer.

referenceDisputeIdstring

Your own identifier for this dispute.

Example your-own-reference

metadatamap of any JSON value

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

curl -X POST https://api.tst.au.apgpay.dev/issuer-disputes \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "IdspCmdCreate",
  "selector": {
    "type": "ItxnSelectorCardReference",
    "cardReference": "your-own-reference",
    "referenceTransactionId": "your-own-reference",
    "merchantId": "mcht_9f2Kd8QpLzXw"
  },
  "amount": {
    "type": "IsoCurrencyAmount",
    "minorCurrencyUnits": 1250,
    "currency": "AUD"
  },
  "reason": "Requested by the customer.",
  "referenceDisputeId": "your-own-reference",
  "metadata": {
    "yourKey": {}
  }
}'

Responses

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

Discriminated by type
type = "IdspOutcomeCreated"

A dispute raised against a card authorisation.

Example
{
  "type": "IdspOutcomeCreated",
  "dispute": {
    "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