Authorization hold for future charges

A specific amount may be temporarily held on a credit card to cover potential charges such as no-shows or minibar consumption. This hold, known as a pre-authorization or authorization hold, is released once it is no longer required. In Apaleo, it is called “authorization”.

Create authorization

Authorizations can be created via various forms such as payment links, terminals, existing pre-authorizations and payment accounts using the following endpoints:

The targetType should be either “Booking” or “Reservation”, depending on at what level an authorization is created. No limit exists on how many authorizations are created per reservation and booking.

An authorization expires 28 days after being created, however, it might differ depending on the card scheme.

Get authorization(s) details

To return a specific authorization, use GET /booking/v1/authorizations/{id}

To return all authorizations that meet particular criteria, such as belonging to a specific property or a reservation, use GET /booking/v1/authorizations

Authorization operations

No longer needed authorization should be canceled by using PUT /booking/v1/authorization-actions/{id}/cancel. If not canceled, it will expire once the authorization expiration date is reached.

No longer needed pending payment link authorization can be expired by using PUT /booking/v1/authorization-actions/{id}/expire-payment-link. If not expired, it will expire once the payment link expiration date is reached.

To change the authorized amount, use PUT /booking/v1/authorization-actions/{id}/refresh and specify the new amount in the body. If no amount is specified, this endpoint can be used to extend the authorization. When extending an authorization, the default expiry period is 28 days (meaning that the expiry date will be 28 after the date when the authorization is refreshed), however, it might differ depending on the card scheme.

You can only adjust a successful authorization that hasn’t expired yet.

Pay for charges

Authorization can be used to pay for charges at a booking folio or reservation folio levels. If it is at the reservation level, it can be used to pay charges in the folios belonging to that reservation; if at the booking level - for booking folios in that booking and folios in all reservations that belong to that booking.

The endpoint for paying by authorization is POST /finance/v1/folios/{folioId}/payments/by-authorization. Make sure that referenceType is set as AuthorizationId.

{
  "transactionReference": "IUSENHBB",
  "referenceType": "AuthorizationId",
  "amount": {
    "amount": 330,
    "currency": "EUR"
  }
}