list_refunds
Read-onlyIdempotent
Retrieve refund requests newest first, filtering by order reference or status to find a refund's Wayl ID.
Instructions
List refund requests, newest first, optionally filtered by order reference or status.
Use this to recover a refund's Wayl `id`: `create_refund` returns it once, and it is the
only handle `get_refund` and `cancel_refund` accept. Pass `reference_id` to see every
refund raised against one order. When you already hold the refund ID, call `get_refund`
instead of paging this.
Refund statuses are 'Requested' (awaiting Wayl's decision, still cancellable),
'Refunded', 'Rejected' and 'Cancelled'. Amounts come back as numbers in whole IQD,
unlike a link's `total`, which is a string.
Wayl returns no total count, so do not read the row count as the number of refunds.
Keep paging with `nextSkip` while `hasMore` is true.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | How many to skip, for paging. | |
| take | No | How many refunds to return. | |
| statuses | No | Filter by refund status. | |
| reference_id | No | Your order reference ID — the one passed to `create_payment_link`. Shows every refund raised against that one order; omit to list refunds across all orders. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||