APapaleo
FolioPayments

Cancels a pending payment link.

Sets a pending payment with payment link to cancelled and triggers the cancellation.<br>You must have this scope: 'folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_payments.cancel'.

put/finance/v1/folios/{folioId}/payments/{paymentId}/cancel

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

Path parameters

folioIdstring required
paymentIdstring required

The id of the payment.

Response

Success

Changes

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