APG PayAPG Paydocs

Card issuer

Get issuer refund

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

Return one refund of an issued-card transaction.

Permissions

Required permission
issuerTransactions:query

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

Path parameters

issuerRefundIdstring
required

Responses

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

Discriminated by type
type = "ItxnRefundAttributes"
refundIdRfndIdrequired

Identifier of a refund.

Example rfnd_9f2Kd8QpLzXw

referenceRefundIdstring

Your own reference for the refund.

Example your-own-reference

statusItxnRefundStatusrequired
AuthorisedPublishedUnknown

What came back, and the tax within it. In the single currency given here.

taxRatenumber

The rate the tax was charged at, as a decimal, 0.1 is 10%.

Example 0.9412

The amount before currency conversion, where the refund was converted. Genuinely in another currency, so it carries its own.

metadatamap of any JSON value

Free-form data on the refund.

publishedMetadatamap of any JSON value

The metadata as it was published to the borrower, where it has been changed since. The difference is what a dispute turns on.

customerStatementIssueDatestring (date)

The issue date of the customer statement this refund is expected to appear on.

Example 2026-08-19

processingDatestring (date)

When the scheme will process the refund.

Example 2026-08-19

publishedAtstring (date-time)

When the refund reached the borrower's statement.

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

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "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