---
title: "Get a list of refunds."
method: GET
path: "/finance/v0-nsfw/folios/{folioId}/refunds"
tags: ["FolioPayments"]
---

# Get a list of refunds.

`GET /finance/v0-nsfw/folios/{folioId}/refunds`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/finance/v0-nsfw/folios/{folioId}/refunds`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `folios.read`, `folios.manage`, `admin`

Returns a list of all refunds for this folio ordered by creation date, newest first<br>You must have at least one of these scopes: 'folios.read, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_refunds.read'.

## Path parameters

- `folioId` string, required

## Query parameters

- `statusCodes` string[]
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Success.

- RefundListModel
  - `refunds` RefundModel[], required: List of refunds
    - `id` string, required: Id of the refund
    - `method` 'Cash' | 'BankTransfer' | 'CreditCard' | 'Invoice' | 'Amex' | 'VisaCredit' | 'VisaDebit' | 'MasterCard' | 'MasterCardDebit' | 'Maestro' | 'GiroCard' | 'DiscoverCard' | 'Diners' | 'Jcb' | 'BookingCom' | 'VPay' | 'PayPal' | 'Postcard' | 'Reka' | 'Twint' | 'Lunchcheck' | 'Voucher' | 'ChinaUnionPay' | 'Other' | 'Cheque' | 'Airbnb' | 'HolidayCheck' | 'PspCash' | 'PspDebit' | 'PspBanking' | 'PspOpenInvoice' | 'PspWallet' | 'Representation' | 'IDeal', required: The payment method
    - `amount` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `externalReference` ExternalReference
      - `merchantReference` string, required: The merchant reference ('order number')
      - `pspReference` string, required: The globally unique identifier of this payment in the reports of the payment service
    - `receipt` string, nullable: Receipt for the payment. For payments run through the apaleo payment services it is set to the pspReference
    - `refundDate` string, date-time, required: The date when the refund was done<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `sourcePaymentId` string, nullable: A link to the payment that the refund was done for
    - `status` 'Pending' | 'Success' | 'Failure' | 'Canceled', required: Status of the refund
    - `failureReason` string, nullable
    - `failureCode` 'Failed' | 'TimedOut', nullable
    - `movedFrom` EmbeddedFolioModel
      - `id` string, required: Folio ID
      - `debitor` string, nullable: Name of the debitor - the one who will pay the bill
    - `movedTo` EmbeddedFolioModel
      - `id` string, required: Folio ID
      - `debitor` string, nullable: Name of the debitor - the one who will pay the bill
    - `movedReason` string, nullable: A reason why the move operation was performed
    - `businessDate` string, date, required: The business date of the refund
    - `reason` string, nullable: The reason for payment refund
  - `count` integer, required: Total count of items

## Other responses

- `204`: No refunds could be found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/revisions/72cbd31f02f4?raw)