Skip to main content
GET
Returns a cursor-paginated list of every refund on the workspace that owns the secret key, newest first, including refunds created outside the API. This is the endpoint to reach for when a create call timed out and you’re not sure whether the refund landed: filter by the activity and look for your ref.

Query parameters

string
A pagination.next_cursor or prev_cursor from a previous page.
integer
default:"10"
Page size, between 1 and 100.
string
Only refunds against this ugwo, ugw.XXXX.YYYY.... Covers every activity on the payment.
string
Only refunds against this activity, act.XXXX.YYYY....
string[]
Repeat to match several. Accepts pending, successful, and failed.
processing is not an accepted filter value even though refunds spend most of their life in it. Passing it returns 422 with field: "filters[status]". To find in-flight refunds, fetch without a status filter and filter client-side.
Unknown keys inside filters are rejected rather than ignored, so a typo fails loudly with 422.

Response

Refund[]
The page of refunds, each in the Refund object shape.
object