APG PayAPG Paydocs

Card issuer

Create issuer refunds

POST/issuer-refunds

Refund a captured 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 "IrfndCmdCreate". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "IrfndCmdCreate"

An amount in minor current units of a given currency.

referenceRefundIdstring

Your own identifier for this refund, so a retry is not a second refund.

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-refunds \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "IrfndCmdCreate",
  "selector": {
    "type": "ItxnSelectorCardReference",
    "cardReference": "your-own-reference",
    "referenceTransactionId": "your-own-reference",
    "merchantId": "mcht_9f2Kd8QpLzXw"
  },
  "amount": {
    "type": "IsoCurrencyAmount",
    "minorCurrencyUnits": 1250,
    "currency": "AUD"
  },
  "referenceRefundId": "your-own-reference",
  "metadata": {
    "yourKey": {}
  }
}'

Responses

The response is a typed union.

Discriminated by type
type = "IrfndOutcomeCreated"

A refund issued against a card authorisation.

Example
{
  "type": "IrfndOutcomeCreated",
  "refund": {
    "type": "ItxnRefundAttributes",
    "refundId": "rfnd_9f2Kd8QpLzXw",
    "referenceRefundId": "your-own-reference",
    "status": "Authorised",
    "amounts": {
      "type": "ItxnRefundAmountsAttributes",
      "currency": "AUD",
      "amount": 1250,
      "tax": 1250,
      "taxType": "string"
    },
    "taxRate": 0.9412,
    "originalAmount": {
      "type": "IsoCurrencyAmount",
      "minorCurrencyUnits": 1250,
      "currency": "AUD"
    },
    "metadata": {
      "yourKey": {}
    },
    "publishedMetadata": {
      "yourKey": {}
    },
    "customerStatementIssueDate": "2026-08-19",
    "processingDate": "2026-08-19",
    "publishedAt": "2026-08-19T04:21:07Z",
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses