APG PayAPG Paydocs

Card issuer

Update issuer refund

PATCH/issuer-refunds/{issuerRefundId}

Append free-form data to a refund. Merged with what is there, the refund's own record is the platform's, not yours.

Permissions

Required permission
issuerTransactions:update

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

Path parameters

issuerRefundIdstring
required

Request body

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

Discriminated by type
type = "IrfndUpdateAppendMetadata"
merchantIdMchtId

Whose metadata this is. Must match the identifier used on the transaction's own metadata, or the two sets will not read back together.

Example mcht_9f2Kd8QpLzXw

metadatamap of any JSON valuerequired

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

curl -X PATCH https://api.tst.au.apgpay.dev/issuer-refunds/{issuerRefundId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "IrfndUpdateAppendMetadata",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "metadata": {
    "yourKey": {}
  }
}'

Responses

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

Discriminated by type
type = "IrfndUpdateRspAttributes"

The resource as it stands after the change.

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