---
title: "GET /api/payments/refunds"
method: GET
path: "/api/payments/refunds"
tags: ["api", "refunds"]
---

# GET /api/payments/refunds

`GET /api/payments/refunds`

Get all refunds

## Query parameters

- `skip` integer, required — The number of objects to skip for the requested result
- `top` integer, required — A limit on the number of objects to be returned. Can range between 1 and 1000.
- `gateway` string — The payment gateway type to filter for
- `gatewayId` string — The payment gateway id to filter for
- `createdAt` object — Range of dates to filter by when the refund was created in ISO format.
  - `$gt` string, date-time — value is greater than
  - `$gte` string, date-time — value is greater than or equal
  - `$lt` string, date-time — value is less than
  - `$lte` string, date-time — value is less than or equal
  - `$eq` string, date-time — value is equal
  - `$ne` string, date-time — value is not equal
- `target` 'origin' | 'voucher' | 'customer_balance'
- `pspRef` string — The payment service provider reference to filter for
- `transactionId` string — The transaction id to filter for
- `paymentId` string — The payment id to filter for

## Response `200`

OK

- GETRefundsGetAllRefunds200Response
  - `docs` RefundResource[]
    - `_id` string, required — The ID of the refund
    - `transactionId` string — The ID of the transaction which the refund belongs to
    - `eventId` string — The ID of the event which the refund belongs to
    - `sellerId` string — The ID of the seller which the refund belongs to
    - `pspRef` string — The ID of the payment service provider reference object
    - `gateway` 'managed' | 'external' | 'local' — The gateway payment type of the refund
    - `amount` number, float — The amount of the refund
    - `currency` 'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' — An ISO 4217 3-character code of the currency
    - `createdAt` string, date-time, required — An ISO Timestamp indicating when the refund was created.
    - `updatedAt` string, date-time, required — An ISO Timestamp indicating when the refund was updated.
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)