APapaleo
FolioPayments

Set a refund to success.

Sets a refund to success and triggers the accounting. This API can also be called on failed or timed out refunds<br>You must have this scope: 'payments.admin'.<br>For fine-grained clients, you must have this permission: 'core.folio_refunds.commit'.

put/finance/v0-nsfw/folios/{folioId}/refunds/{refundId}/commit

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

Path parameters

folioIdstring required
refundIdstring required

The id of the refund.

Request body

pspReferencestring required

The id of the refund transaction from the payment service provider

Example request

{
  "pspReference": "4325816867241937"
}

Response

Success

Changes

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