Skip to main content

New payment and refund options

With this release we extend our existing payment APIs, and also add a brand new one: now you can also refund money, in case someone paid too much.

Pay by invoice

...or "Check out on AR (Accounts Receivables)", how the pros call it. We added a new endpoint on the FolioActions API, 'checkout-on-AR', and secured it with its very own scope, 'folio.checkout-ar', as allowing customers to leave the hotel without paying needs extra protection. The function is only available when it's clear that no additional charges or payments will occur, for example after a checkout or cancellation.
Calling this endpoint will post the payment as "invoice", close the folio, and do all the required accounting transactions. When you generate an invoice that has an invoice-payment, the payment terms you specified when creating or updating the property (in the inventory API) will be added to it.


Even though the apaeo APIs prevent overpaying a reservation, it can still happen that a guest ended up paying too much: the cancellation fee is lower than the total prepaid amount, the guest gets a discount on a room that wasn't as quiet as advertised, the no-show fee is waived, etc.
Now you can fix this by calling 'refund' on the FolioActions. Like checking out on AR, this has its own scope ('refunds.create'), as not everyone is allowed to give away money.
Note that posting a refund on apaleo does not (yet) automatically trigger a refund with the integrated payment provider.

More fine-grained payment types

We thought our accounting module is small, but great! That thought didn't survive for 5 seconds after we showed it to customers. "What kind of payment is 'CreditCard'? How should I be able to follow up with the credit card companies, and check that what they paid me is what I have in my books?" Valid point. We quick-fixed that, and when creating payments, customers can now select from the world's most common credit and debit cards. If you don't care about those details (and for backwards compatibility) we left the 'CreditCard' payment type.


Popular posts from this blog

Getting Started with apaleo APIs

Have a look You can find all of apaleo's API on We use Swagger to describe it, and to generate our documentation.

Sign up The first step is to sign up for an account. After you finish signup you will be able to login to our apaleo app and start configuring your properties. Also you can use the same credentials to access our API using Swagger. Get access for app We're still new and want to get in touch with you before we grant you access. Contact us at, to get your very own client credentials that lets you play with the API in our sandbox.
Use it apaleo APIs are protected using OAuth2 - the de-facto standard for API security. Here's a short guide to get you started:

Step 1: To get access to our APIs, you need to use your client id and secret to obtain an access token. Don't have one? Contact us at

Combine your client id and secret into a string, separated by colon yourClientId:YourClientSecret and encode with Base64. This wi…

Connect your app with OAuth 2.0

What is this all about? When you connect your app to apaleo, it can read or modify data, or even trigger entire business flows of a hotel. But before gaining access to any of the resources in the REST API, it must get permission from the hotel. This guide will walk you through the authorization process (described in greater detail by the OAuth 2.0 specification). Note: apaleo's OAuth 2.0 implementation supports the standard authorization code grant type. You should implement the application flow described below to obtain an authorization code and then exchange it for a token. (The implicit grant type is not supported.) Terminology Before learning more about the details of the authorization process, make sure that you are familiar with some of the key terms that are used in this guide: Client: Any application that would like access to a hotel's data. A user (usually the hotel's owner or admin) must grant permission before the client can access any data.API: apaleo REST API. T…

Channel Integration Guide

With the channel integration you can subscribe for availability, rates and inventory (ARI), create new bookings and modify existing bookings. 
The BasicsGet your sandbox account and check out this guide to learn how you can connect to the apaleo APIs.
API Client All apaleo APIs are described as swagger documents. That lets you generate API clients directly from the swagger.json files. There is a large community, providing client generators for almost every language. For example, swagger code generator is a good project, which allows generation of API clients for Java, PHP, C#, NodeJS and more. This gets you up to speed very fast and as a bonus you can access API documentation within the auto-generated methods and models. is our – and your – playground to do first steps with the API, up to your final integration. Use it to interactively explore the API or to learn the apaleo concepts by navigating the user interface.

These are the links you need to know