APapaleo
FolioPayments

Set a payment to success.

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

put/finance/v0-nsfw/folios/{folioId}/payments/{paymentId}/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}/payments/{paymentId}/commit
  • 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

pspReferencestring required

The id of the payment from the payment service provider

paymentMethod'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

Payment method this payment was processed with

refundActionAllowed'None' | 'Online' | 'Manual' | 'OnlyFull' nullable

Example request

{
  "pspReference": "4325816867241937",
  "paymentMethod": "VisaCredit",
  "refundActionAllowed": "Online",
  "capturedAmount": {
    "amount": 210,
    "currency": "EUR"
  }
}

Response

Success

Changes

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