APapaleo
FolioPayments

Trigger a refund for a specific payment.

Trigger a refund for a specific payment on this folio. The refund will be processed asynchronously. Use the location header to poll for the status of the refund. As long as a refund is pending the allowed refund amount for this payment will be reduced by the amount. The refund times out after 10 minutes automatically<br>You must have this scope: 'folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_refunds.create'.

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

Path parameters

folioIdstring required
paymentIdstring required

The payment Id.

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

businessDatestring date nullable

The business date of the refund. Defaults to the current date. In some cases you might want to post the refunds to the previous business date, this is only possible until 6 AM of the current day.

reasonstring nullable

The reason for payment refund

Example request

{
  "amount": {
    "amount": 10,
    "currency": "EUR"
  },
  "businessDate": "2026-10-23",
  "reason": "Refund for the cancelled service"
}

Response

Refund was created and will be processed.

idstring required

Changes

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