APG PayAPG Paydocs

Transactions

List refunds

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

Return a page of refunds, one entry per refund: limit and totalCount count refunds, not the transactions they refund. Supply page for offset pagination or startingAfter for cursor pagination. The filters combine with each other and with q by AND. GET /filter-catalogues/refunds lists those this caller can use. A cursor continues only the walk that issued it: sent with different filters, q or sort, it is refused with 400. One issued before the list named its walks resumes as it did.

Permissions

Required permission
refunds:query

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

Query parameters

qstring

Search. Matches a refund id, the id of the transaction or order it refunds, or the gateway's refund id. An id, an email address, a phone number and any value listed as matched exactly match 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; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

pageinteger (int32)

Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.

startingAfterstring

Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.

endingBeforestring

Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.

limitinteger (int32)

Maximum items per page.

columnsarray of RfndColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

merchantIdone of array of string, string

Only refunds whose merchant is one of these. Repeat the parameter to give several.

transactionIdone of array of string, string

Only refunds whose payment is one of these. Repeat the parameter to give several.

customerIdone of array of string, string

Only refunds whose customer is one of these. Repeat the parameter to give several.

orderIdone of array of string, string

Only refunds whose order is one of these. Repeat the parameter to give several.

referenceOrderIdstring

Filter by your own reference for the order.

amountinteger (int64)

Filter to refunds of exactly this amount, in minor units.

currencyone of IsoCurrency, array of IsoCurrency

Only refunds whose currency is one of these. Repeat the parameter to give several.

createdAfterstring (date-time)

Only refunds whose creation time is at or after this ISO-8601 timestamp.

createdBeforestring (date-time)

Only refunds whose creation time is at or before this ISO-8601 timestamp.

Responses

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

Discriminated by type
type = "RfndPageAttributes"
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": "RfndPageAttributes",
  "data": [
    {
      "type": "RfndViewAttributes",
      "refundId": "rfnd_9f2Kd8QpLzXw",
      "subject": {
        "type": "RfndSubjectTransaction",
        "transactionId": "tran_9f2Kd8QpLzXw"
      },
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "customer": {
        "type": "RfndCustomerAttributes",
        "customerId": "cust_9f2Kd8QpLzXw",
        "name": "Ada Lovelace",
        "emailAddress": "ada@example.com",
        "phoneNumber": "+61400000000"
      },
      "status": "Pending",
      "amounts": {
        "type": "RfndAmountsAttributes",
        "currency": "AUD",
        "amount": 1250,
        "transactionAmount": 1250
      },
      "orderId": "ordr_9f2Kd8QpLzXw",
      "referenceOrderId": "your-own-reference",
      "orderMetadata": {
        "yourKey": {}
      },
      "payoutId": "payout_9f2Kd8QpLzXw",
      "settlementDate": "2026-08-19",
      "attempts": 1250,
      "lastError": "string",
      "createdAt": "2026-08-19T04:21:07Z",
      "refundedAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses