APapaleo
FolioPayments

Trigger a custom payment for the folio.

A custom payment will not involve any automatic processing. This is best to be used for cash, cheque or voucher payments or payments that have been processed by an external system and it should just be recorded in apaleo for accounting purposes.<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

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
  • 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

method'Cash' | 'BankTransfer' | 'CreditCard' | 'Amex' | 'VisaCredit' | 'VisaDebit' | 'MasterCard' | 'MasterCardDebit' | 'Maestro' | 'GiroCard' | 'DiscoverCard' | 'Diners' | 'Jcb' | 'BookingCom' | 'VPay' | 'PayPal' | 'Postcard' | 'Reka' | 'Twint' | 'Lunchcheck' | 'Voucher' | 'ChinaUnionPay' | 'Other' | 'Cheque' | 'Airbnb' | 'HolidayCheck' | 'Representation' | 'IDeal' required

The payment method. Use 'CreditCard', if none of the specific credit cards types matches. 'Booking.com' only makes sense, if the property (hotel) configured Booking.com > Finance to be 'Payments by Booking.com'

receiptstring nullable

The optional receipt you want to store for the payment. It defaults to the reservation or external folio id. This field is required if you are adding payment to the house account

businessDatestring date nullable

The business date of the payment. Defaults to the current date. In some cases you might want to post the payments to the previous business date, this is only possible until 6 AM of the current day.

Example request

{
  "method": "Cash",
  "receipt": "BLIPKWXP-1",
  "amount": {
    "amount": 230,
    "currency": "EUR"
  },
  "paidCharges": [
    {
      "chargeId": "BLIPKWXP-1-1-1",
      "amount": 230
    }
  ]
}

Response

Payment was created and accounting was performed.

idstring required

Changes

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