APG PayAPG Paydocs

Card issuer

List issuer transaction refunds

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

Return a page of the refunds issued against this transaction. This is the only address an issuing refund has.

Permissions

Required permission
issuerTransactions:query

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

Path parameters

issuerTransactionIdstring
required

Query parameters

qstring

Search. Matches a refund id or the reference refund id. An id matches exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere. Typos are not tolerated, and matches keep the list's order.

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

statusone of ItxnRefundStatus, array of ItxnRefundStatus

Filter by refund status. Repeat the parameter to supply several.

Responses

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

Discriminated by type
type = "ItxnRefundPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "ItxnRefundPageAttributes",
  "data": [
    {
      "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"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses