APapaleo
FolioPayments

Fails a payment.

Fails a payment and therefore increases the allowed payment amount for the respective folio again. Can be called multiple times<br>You must have this scope: 'payments.admin'.<br>For fine-grained clients, you must have this permission: 'core.folio_payments.fail'.

put/finance/v0-nsfw/folios/{folioId}/payments/{paymentId}/fail

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}/payments/{paymentId}/fail
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: payments.admin, admin

Path parameters

folioIdstring required
paymentIdstring required

The id of the payment.

Request body

failureReasonstring nullable

Example request

{
  "failureReason": "Timeout during PIN entry"
}

Response

Success

Changes

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