Terminal payments

In-person payments can be pre-authorized on a POS terminal. The terminal must first be setup and configured for the property.

To initiate a pre-authorization on a POS terminal you can call the following API endpoint:

POST https://payment.apaleo.com/payment/v1/payment-transactions/by-terminal?flow=AutoExpire

Example

{
  "propertyId": "MUC",
  "terminalId": "P400Plus-27545332",
  "amount": {
    "currency": "EUR",
    "value": 680
  },
  "merchantReference": "864c3b9e-4820-407b-a31e-6713f5effcb3"
}

AutoExpire - Limited validity

AutoExpire authorizations are only valid a limit period, minimum 2 hours, and will automatically expire and be cancelled.

Post payments by authorization

Captures a specific amount from a pre-authorization and posts it to the folio. It can be used to pre-authorize a POS purchase, or even a reservation done in a walk-in POS kiosk. It can also be used to post a booking payment when the reservation is created. It allows you to implement your own prepayment automation.

The payment will be processed asynchronously. Use the location header to poll for the status of the payment. As long as payment is pending, it reduces the number of allowed payments for the folio. The payment automatically times out after 60 minutes.

You can capture a specific amount from a pre-authorization and post it to a guest or external folio by using the following API endpoint:

POST /finance/v1/folios/{folioId}/payments/by-authorization

Example

{
  "transactionReference": "564578124534890J",
  "amount": {
    "amount": 330,
    "currency": "EUR"
  },
  "paidCharges": [
    {
      "chargeId": "BLIPKWXP-1-1-1",
      "amount": 230
    }
  ]
}

Multiple payments for the same authorization

It is possible to pre-authorize an amount that is then distributed into separate payments and posted via by-authorization on the same or different folios.