APapaleo
FolioPayments

Get a list of refunds.

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'.

get/finance/v1/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/v1/folios/{folioId}/refunds
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: folios.read, folios.manage, admin

Path parameters

folioIdstring required

Query parameters

statusCodesstring[]

Filter refunds by one or more status

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Success.

countinteger required

Total count of items

Example response

{
  "refunds": [
    {
      "id": "MUC-12454",
      "method": "Cash",
      "amount": {
        "amount": 100,
        "currency": "EUR"
      },
      "refundDate": "2026-10-23T13:50:37.1321675+02:00",
      "sourcePaymentId": "MUC-KSJHDF",
      "status": "Failure",
      "failureReason": "Can't refund more than original payment.",
      "failureCode": "Failed",
      "businessDate": "2026-10-23",
      "reason": "Refund for the cancelled service"
    },
    {
      "id": "BER-12454",
      "method": "CreditCard",
      "amount": {
        "amount": 220,
        "currency": "EUR"
      },
      "refundDate": "2026-10-23T13:50:37.1321675+02:00",
      "sourcePaymentId": "BER-UWNWFD",
      "status": "Pending",
      "businessDate": "2026-10-23",
      "reason": "Refund for the cancelled service"
    }
  ],
  "count": 2
}

Changes

No recorded changes to this operation across all 3 revisions of this API.