APapaleo
FolioPayments

Trigger a payment using the payment account stored on the reservation or booking.

Trigger a payment for the folio using the payment account stored on the reservation or booking. The payment will be processed asynchronously. Use the location header to poll for the status of the payment. As long as a payment is pending it reduces the amount of allowed payments for the folio. The payment times out after 60 minutes automatically<br>You must have this scope: 'folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_payments.create'.

post/finance/v1/folios/{folioId}/payments/by-payment-account

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

Path parameters

folioIdstring required

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

accountOwner'Guest' | 'Booker' nullable

Account owner of the payment account, default is Guest. Will be ignored if PaymentAccountId is provided - <b>DEPRECATED: AccountOwner is deprecated, use PaymentAccountId instead. This field will be removed on May 15, 2026. From this date onwards, PaymentAccountId will be a required parameter.</b>

paymentAccountIdstring nullable

Optional payment account id. If passed, it is verified that the provided payment account is available for the folio. From Feb 15, 2026 onwards, PaymentAccountId will be a required parameter.

Example request

{
  "paymentAccountId": "UBMFXUFH",
  "amount": {
    "amount": 230,
    "currency": "EUR"
  },
  "paidCharges": [
    {
      "chargeId": "BLIPKWXP-1-1-1",
      "amount": 200
    }
  ]
}

Response

Payment was created and will be processed.

idstring required

Changes

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