APapaleo
FolioPayments

Get a refund by ID.

Get a refund by its ID<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/v0-nsfw/folios/{folioId}/refunds/{refundId}

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

Path parameters

folioIdstring required
refundIdstring required

The refund ID.

Response

Success.

idstring 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

receiptstring nullable

Receipt for the payment. For payments run through the apaleo payment services it is set to the pspReference

refundDatestring 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>

sourcePaymentIdstring nullable

A link to the payment that the refund was done for

status'Pending' | 'Success' | 'Failure' | 'Canceled' required

Status of the refund

failureReasonstring nullable
failureCode'Failed' | 'TimedOut' nullable
movedReasonstring nullable

A reason why the move operation was performed

businessDatestring date required

The business date of the refund

reasonstring nullable

The reason for payment refund

Example response

{
  "id": "KDSF86SF",
  "method": "CreditCard",
  "amount": {
    "amount": 150,
    "currency": "EUR"
  },
  "externalReference": {
    "merchantReference": "JDKLKDS-1",
    "pspReference": "091283918312"
  },
  "refundDate": "2026-10-16T13:14:35.0609237+02:00",
  "status": "Pending",
  "businessDate": "2026-10-16",
  "reason": "Refund for the cancelled service"
}

Changes

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