From 9b51f81e09b5506290a3c12f23a0e7bdee691de6 Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 10:29:56 +0100 Subject: [PATCH 01/11] Mark Add credit card payment as deprecated --- connector-api/deprecations/README.md | 1 + connector-api/operations/README.md | 4 ++-- connector-api/operations/payments.md | 6 +++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/connector-api/deprecations/README.md b/connector-api/deprecations/README.md index f323e268..181c9af2 100644 --- a/connector-api/deprecations/README.md +++ b/connector-api/deprecations/README.md @@ -22,6 +22,7 @@ The table columns have the following meanings: | Feature | Comments | Deprecated | Discontinued | | :-- | :-- | :-- | :-- | +| [Add credit card payment](../operations/payments.md#add-credit-card-payment) | Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. | 11 Mar 2026 | 10 Jan 2028 | | [Get all routing rules](../operations/routingrules.md#get-all-routing-rules) | Replaced by [Get all billing automations](../operations/billingautomations.md#get-all-billing-automations) | 11 Nov 2025 | 10 Jan 2027 | | [Add routing rules](../operations/routingrules.md#add-routing-rules) | Replaced by [Add billing automations](../operations/billingautomations.md#add-billing-automations) | 11 Nov 2025 | 10 Jan 2027 | | [Update routing rules](../operations/routingrules.md#update-routing-rules) | Replaced by [Update billing automations](../operations/billingautomations.md#update-billing-automations) and [Update billing automation assignments](../operations/billingautomations.md#update-billing-automation-assignments) | 11 Nov 2025 | 10 Jan 2027 | diff --git a/connector-api/operations/README.md b/connector-api/operations/README.md index c0a6b078..eb7f731b 100644 --- a/connector-api/operations/README.md +++ b/connector-api/operations/README.md @@ -50,7 +50,7 @@ This section describes all operations supported by the API, organised here by th | [~~Get customers open items~~](customers.md#get-customers-open-items) | **Deprecated!** Use [Get all payments](payments.md#get-all-payments) and [Get all order items](orderitems.md#get-all-order-items) instead. | | [Add customer](customers.md#add-customer) | Adds a new customer to the system and returns details of the added customer | | [Update customer](customers.md#update-customer) | Updates personal information of a customer | -| [~~Merge customers~~](customers.md#merge-customers) | **Deprecated!** Please use [Merge accounts](accounts.md#merge-accounts) instead. | +| [~~Merge customers~~](customers.md#merge-customers) | **Deprecated!** Use [Merge accounts](accounts.md#merge-accounts) instead. | | [Add customer file](customers.md#add-customer-file) | Attaches the specified file to the customer profile | | [Get all identity documents](../operations/identitydocuments.md#get-all-identity-documents) | Returns all identity documents for the specified customers | | [Adds identity documents](../operations/identitydocuments.md#add-identity-documents) | Adds new identity documents | @@ -131,7 +131,7 @@ This section describes all operations supported by the API, organised here by th | [Add tokenized credit card](creditcards.md#add-tokenized-credit-card) | Adds a new tokenized credit card to the specified customer | | [Disable gateway credit card](creditcards.md#disable-gateway-credit-card) | **Restricted!** Disables a credit card from being used for payments | | [Get all preauthorizations
by customers](preauthorizations.md#get-all-preauthorizations-by-customers) | Returns all preauthorizations of specified customers | -| [Add credit card payment](payments.md#add-credit-card-payment) | Adds a new credit card payment to a bill of the specified customer | +| ~~[Add credit card payment](payments.md#add-credit-card-payment)~~ | **Deprecated!** Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. | | [Add external payment](payments.md#add-external-payment) | Adds a new external payment to a bill of the specified customer | | [Add alternative payment](payments.md#add-alternative-payment) | Adds a new alternative payment to a specified customer | | [Get all payments](payments.md#get-all-payments) | Returns all payments, filtered by various parameters | diff --git a/connector-api/operations/payments.md b/connector-api/operations/payments.md index 8c73896f..db21ac19 100644 --- a/connector-api/operations/payments.md +++ b/connector-api/operations/payments.md @@ -467,10 +467,10 @@ Adds a new external payment to a bill of the specified customer. An external pay | :-- | :-- | :-- | :-- | | `ExternalPaymentId` | string | required | Unique identifier of the [Payment item](accountingitems.md#payment-item). | -## Add credit card payment +## ~~Add credit card payment~~ -Adds a new credit card payment to a bill of the specified customer. Note that the payment is added to open bill of the customer, either to the specified one or the default one. This operation only serves to record a credit card payment that has already been taken outside of Mews or Mews' payment terminal, and does not actually charge the customer's credit card. -The bill can then be closed manually by a Mews user, or automatically via API with the [Close bill](bills.md#close-bill) operation. +> ### Deprecated! +> This operation is [deprecated](../deprecations/README.md). Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. ### Request From 55b92e6b44eb2797b4223d1584bc3efeefddabed Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 10:39:14 +0100 Subject: [PATCH 02/11] Add changelog entry --- connector-api/changelog/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/connector-api/changelog/README.md b/connector-api/changelog/README.md index d35aec0f..0e8d0da2 100644 --- a/connector-api/changelog/README.md +++ b/connector-api/changelog/README.md @@ -1,6 +1,17 @@ # Changelog {% updates format="full" %} + +{% update date="2026-03-11" %} + +## Deprecation of Add credit card payment operation + +- [Add credit card payment](../operations/payments.md#add-credit-card-payment): + - **Deprecated** operation. Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. + - This operation will be discontinued on **10 January 2028**. + - A detailed migration guide along with new front-end SDK for collecting payment data will be published in Q2 2026. + +{% endupdate %} {% update date="2026-02-27" %} ## New operation: Close tasks From 20b9fed703b74e06e316c49e996d0724ec40bf7d Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 10:42:54 +0100 Subject: [PATCH 03/11] Revise Payment automation use case - fix links to mews help - update link to PCI certificate - use proper hints and steppers --- connector-api/use-cases/payment-automation.md | 104 ++++++++++++------ 1 file changed, 72 insertions(+), 32 deletions(-) diff --git a/connector-api/use-cases/payment-automation.md b/connector-api/use-cases/payment-automation.md index 8247fef5..4722c094 100644 --- a/connector-api/use-cases/payment-automation.md +++ b/connector-api/use-cases/payment-automation.md @@ -2,39 +2,52 @@ This section describes how to use automated payments processing. We also provide links to information on Mews PCI compliance, including current certification. For connecting to Mews Payment Terminals to take payments from customers, please refer to [Mews Payment Terminals](../use-cases/mews-terminals.md). -> ### PCI Compliance -> * [Mews PCI compliance](https://help.mews.com/s/article/pci-compliance?language=en_US) -> * [Mews PCI certificate](https://www.mews.com/en/platform-documentation) +{% hint style="info" %} + +### PCI Compliance + +- [Mews PCI compliance](https://help.mews.com/s/article/pci-compliance?language=en_US) +- [Mews PCI certificate](https://trust.mews.com/?itemUid=53e1508c-665e-45a8-9ce0-03fdf9ae1efb) + +{% endhint %} ## Using tokenized credit cards -If the user interface of your solution involves the collection and storage of credit card details in a secure manner against the customer's profile in Mews, you can use [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card) and then [Charge credit card](../operations/creditcards.md#charge-credit-card) to securely take and post a payment into Mews. -The workflow mimics the result of a user manually [adding a new payment card](https://mews.force.com/s/article/add-a-new-payment-card?language=en_US) in Mews Operations and then [charging the card via the Mews payment gateway](https://help.mews.com/s/article/take-a-payment?language=en_US). +If the user interface of your solution involves the collection and storage of credit card details in a secure manner against the customer's profile in Mews, you can use [Add tokenized credit card] and then [Charge credit card] to securely take and post a payment into Mews. -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to add a credit card to the guest profile | [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card) | -| How to charge a guest credit card using Mews Payments | [Charge credit card](../operations/creditcards.md#charge-credit-card) | +The workflow mimics the result of a user manually [adding a new payment card](https://help.mews.com/s/article/add-a-new-payment-card?language=en_US) in Mews Operations and then [charging the card via the Mews payment gateway](https://help.mews.com/s/article/take-a-payment?language=en_US). + +| 'How to' use case | API Operations | +| :---------------------------------------------------- | :-------------------------- | +| How to add a credit card to the guest profile | [Add tokenized credit card] | +| How to charge a guest credit card using Mews Payments | [Charge credit card] | ## Retrieving tokenized credit cards -To check if a user's credit card is already attached to their customer profile, call [Get all credit cards](../operations/creditcards.md#get-all-credit-cards) to search for credit cards by the `CreditCardId` or `CustomerId`. The credit cards tokenized via the Mews Payment Gateway (PCI Proxy) can be identified by the [`Credit card kind`](../operations/creditcards.md#credit-card-kind) property, with the corresponding value being "Gateway". +To check if a user's credit card is already attached to their customer profile, call [Get all credit cards] to search for credit cards by the `CreditCardId` or `CustomerId`. The credit cards tokenized via the Mews Payment Gateway (PCI Proxy) can be identified by the [`Credit card kind`](../operations/creditcards.md#credit-card-kind) property, with the corresponding value being "Gateway". -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to check if a credit card is stored against a guest profile | [Get all credit cards](../operations/creditcards.md#get-all-credit-cards) | +| 'How to' use case | API Operations | +| :-------------------------------------------------------------- | :--------------------- | +| How to check if a credit card is stored against a guest profile | [Get all credit cards] | ## Adding a tokenized credit card -### 1. Retrieve PublicKey +{% stepper %} +{% step %} + +### Retrieve PublicKey -As an integration partner, you will not need to set up your own Payment Gateway account. Rather, when automating payments via the __Mews Connector API__, you should work with Mews' own account. To do so, call [Get configuration](../operations/configuration.md#get-configuration) to obtain the `PublicKey` value, found within the [payment card storage](../operations/configuration.md#payment-card-storage) object. This value will be used as the `merchantId` with the Mews Payment Gateway (PCI Proxy). +As an integration partner, you will not need to set up your own Payment Gateway account. Rather, when automating payments via the **Mews Connector API**, you should work with Mews' own account. To do so, call [Get configuration] to obtain the `PublicKey` value, found within the [payment card storage](../operations/configuration.md#payment-card-storage) object. This value will be used as the `merchantId` with the Mews Payment Gateway (PCI Proxy). -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to get the merchant ID for the Mews Payment Gateway | [Get configuration](../operations/configuration.md#get-configuration) | +| 'How to' use case | API Operations | +| :------------------------------------------------------ | :------------------ | +| How to get the merchant ID for the Mews Payment Gateway | [Get configuration] | -### 2. Set up the Secure Fields payment form to collect card data +{% endstep %} + +{% step %} + +### Set up the Secure Fields payment form to collect card data Refer to the [PCI Proxy documentation on Secure Fields](https://docs.pci-proxy.com/docs/secure-fields) for collecting card number, CVV and expiration date\* through the Secure Fields payment form. Implement Quick Start Step 1 [Set up your Payment Form](https://docs.pci-proxy.com/docs/secure-fields-quick-start) and follow the **Secure Fields Form** recipe. As part of this process, you will use the Mews `PublicKey` (obtained in the step above) as the `merchantId`. @@ -42,24 +55,51 @@ Take note of `data.transactionId` in the response, which looks like a series of For further assistance, see [Integration Examples](https://docs.pci-proxy.com/docs/secure-fields-examples). Note you do _not_ need to follow Step 2 [Obtain the tokens](https://docs.pci-proxy.com/docs/secure-fields-quick-start), this step is performed instead by the Mews back-end. -> **Expiration date:** -> Though not required by PCI Proxy, credit card expiration date is listed as a mandatory parameter on the [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card) endpoint so that it can be displayed within the customer profile in Mews. This can also be used as an additional validation method for the property to know if there is an expired card on file. -> To handle this, we recommend that the payment form includes a field for users to input their credit card expiration date, which need not be sent to PCI Proxy, but should be cached, so that the information can be included in the [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card) API request. +{% hint style="info" %} + +#### Expiration date + +Though not required by PCI Proxy, credit card expiration date is listed as a mandatory parameter on the [Add tokenized credit card] operation so that it can be displayed within the customer profile in Mews. This can also be used as an additional validation method to identify whether there is an expired card on file. + +To handle this, we recommend that the payment form includes a field for users to input their credit card expiration date. This value does not need to be sent to PCI Proxy, but should be cached so that it can be included in the [Add tokenized credit card] API request. +{% endhint %} -### 3. Add the tokenized credit card to a customer profile in Mews +{% endstep %} -Add the tokenized credit card to a customer profile in Mews by calling [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card). Enter the `transactionId` and obfuscated credit card details in the [credit card data](../operations/creditcards.md#credit-card-data) object. Take note of the `CreditCardId` in the API response. +{% step %} -> **Obfuscated number:** -> `ObfuscatedNumber` should only contain at most the first six digits and last four digits of a credit card. Alternatively replacing the entire string value with 16 asterisks `*` is also acceptable. +### Add the tokenized credit card to a customer profile in Mews -The credit card will now be visible in the customer profile in Mews, under the __Payments > Credit cards__ section. -Note that while customer profiles are shared across all properties in a chain, credit card details are not. +Add the tokenized credit card to a customer profile in Mews by calling [Add tokenized credit card]. Enter the `transactionId` and obfuscated credit card details in the [credit card data](../operations/creditcards.md#credit-card-data) object. Take note of the `CreditCardId` in the API response. + +{% hint style="warning" %} + +### Obfuscated number + +`ObfuscatedNumber` should only contain at most the first six digits and last four digits of a credit card. Alternatively, replacing the entire string value with 16 asterisks (`****************`) is also acceptable. +{% endhint %} + +{% endstep %} +{% endstepper %} + +The credit card will now be visible in the customer profile in Mews, under the **Payments > Credit cards** section. +Note that while customer profiles are shared across all properties in a chain, credit card details are not. ## Charging the tokenized credit card -Now that you have the `CreditCardid`, you can use the [Charge credit card](../operations/creditcards.md#charge-credit-card) endpoint to charge the customer. +Now that you have the `CreditCardId`, you can use the [Charge credit card] endpoint to charge the customer. + +{% hint style="warning" %} + +### Charge credit card + +The [Charge credit card] operation actually charges the customer's credit card, whereas the [Add credit card payment] operation does not. + +The latter simply records a credit card payment in Mews and does not trigger any additional action beyond Mews. Use it when the customer's credit card has already been charged from your solution. +{% endhint %} -> **Charge credit card:** -> Note the [Charge credit card](../operations/creditcards.md#charge-credit-card) operation actually charges the customer's credit card, whereas the [Add credit card payment](../operations/payments.md#add-credit-card-payment) operation does NOT. -> The latter simply records a credit card payment in Mews and does not trigger any additional action beyond Mews - suitable for when the customer's credit card has already been charged from your solution. +[Add tokenized credit card]: ../operations/creditcards.md#add-tokenized-credit-card +[Charge credit card]: ../operations/creditcards.md#charge-credit-card +[Get configuration]: ../operations/configuration.md#get-configuration +[Get all credit cards]: ../operations/creditcards.md#get-all-credit-cards +[Add credit card payment]: ../operations/payments.md#add-credit-card-payment From f0e5313bbc346d93b235542e98b300c25bd17b88 Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 11:00:32 +0100 Subject: [PATCH 04/11] Remove Add credit card payment from how-to --- connector-api/use-cases/how-to.md | 1 - 1 file changed, 1 deletion(-) diff --git a/connector-api/use-cases/how-to.md b/connector-api/use-cases/how-to.md index 73044a21..49fbd2ab 100644 --- a/connector-api/use-cases/how-to.md +++ b/connector-api/use-cases/how-to.md @@ -40,7 +40,6 @@ This page summarises all of our 'how to' use cases, together with the main use c | How to get details of stored credit cards | [Get all credit cards](../operations/creditcards.md#get-all-credit-cards) | [Kiosk](kiosk.md), [Payment automation](payment-automation.md) | | How to check if a credit card is stored against a guest profile | [Get all credit cards](../operations/creditcards.md#get-all-credit-cards) | [Kiosk](kiosk.md), [Payment automation](payment-automation.md) | | How to get the merchant ID for the Mews Payment Gateway | [Get configuration](../operations/configuration.md#get-configuration) | [Payment automation](payment-automation.md) | -| How to record an external card payment | [Add credit card payment](../operations/payments.md#add-credit-card-payment) | [Kiosk](kiosk.md) | | How to record a general external payment | [Add external payment](../operations/payments.md#add-external-payment) | [Kiosk](kiosk.md) | | How to record an alternative external payment | [Add alternative payment](../operations/payments.md#add-alternative-payment) | [Kiosk](kiosk.md) | | How to post end-of-day accounting items | [Add outlet bill](../operations/outletbills.md#add-outlet-bills) | [Point of sale](point-of-sale.md) | From 2cdb4c247e568be10042e4035b709159fdd18991 Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 11:00:59 +0100 Subject: [PATCH 05/11] Reformat kiosk use case --- connector-api/use-cases/kiosk.md | 126 ++++++++++++++++--------------- 1 file changed, 65 insertions(+), 61 deletions(-) diff --git a/connector-api/use-cases/kiosk.md b/connector-api/use-cases/kiosk.md index fcfde47c..bf0e657a 100644 --- a/connector-api/use-cases/kiosk.md +++ b/connector-api/use-cases/kiosk.md @@ -6,6 +6,7 @@ Functionality can include updating the guest profile, viewing the guest bill and Here we consider the most common use cases, although kiosks need not be limited to these. > ### Kiosk devices +> > Kiosks can be apps running on off-the-shelf devices such as tablets, or they can consist of custom hardware, incorporating devices such as key encoders, printers and passport scanners. > If such devices are integrated into the kiosk, then only one integration is made between the kiosk and Mews, the connections with the devices are handled internally by the kiosk. @@ -15,21 +16,21 @@ To help configure your kiosk for a specific property, perform an initial pull of To offer multiple languages, you can retrieve the list of languages supported by the API. You will want to fetch the list of supported guest services and associated products, as properties can configure additional services as well as the default Stay accommodation service. -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to get property configuration | [Get configuration](../operations/configuration.md#get-configuration) | -| How to get the list of supported languages | [Get all languages](../operations/languages.md#get-all-languages) | -| How to get the list of services and products | [Get all services](../operations/services.md#get-all-services), [Get all products](../operations/products.md#get-all-products) | +|
'How to' use case
| API Operations | +| :----------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------- | +| How to get property configuration | [Get configuration](../operations/configuration.md#get-configuration) | +| How to get the list of supported languages | [Get all languages](../operations/languages.md#get-all-languages) | +| How to get the list of services and products | [Get all services](../operations/services.md#get-all-services), [Get all products](../operations/products.md#get-all-products) | ## Guest check-in To look up a guest reservation, use the general-purpose operation [Get all reservations](../operations/reservations.md#get-all-reservations-ver-2023-06-06) and specify the required search filters. To check in a reservation, use [Start reservation](../operations/reservations.md#start-reservation). Note Mews uses the phrase "start reservation" rather than "check-in", and "process reservation" rather than "check-out". -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to look up a guest reservation | [Get all reservations](../operations/reservations.md#get-all-reservations-ver-2023-06-06) | -| How to check in a guest reservation | [Start reservation](../operations/reservations.md#start-reservation) | +|
'How to' use case
| API Operations | +| :----------------------------------------------- | :---------------------------------------------------------------------------------------- | +| How to look up a guest reservation | [Get all reservations](../operations/reservations.md#get-all-reservations-ver-2023-06-06) | +| How to check in a guest reservation | [Start reservation](../operations/reservations.md#start-reservation) | ## Working with guest profiles @@ -38,11 +39,11 @@ If the guest already has a profile, but the information in it needs updating (e. To relate a guest profile to a specific reservation, use [Add reservation companion](../operations/reservations.md#add-reservation-companion). Note that "guests" are always referred to as "customers" in the Mews API. -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to create a guest profile | [Add customer](../operations/customers.md#add-customer) | -| How to update a guest profile | [Update customer](../operations/customers.md#update-customer) | -| How to add a guest to a reservation | [Add reservation companion](../operations/reservations.md#add-reservation-companion) | +|
'How to' use case
| API Operations | +| :----------------------------------------------- | :----------------------------------------------------------------------------------- | +| How to create a guest profile | [Add customer](../operations/customers.md#add-customer) | +| How to update a guest profile | [Update customer](../operations/customers.md#update-customer) | +| How to add a guest to a reservation | [Add reservation companion](../operations/reservations.md#add-reservation-companion) | ## Guest bill @@ -51,25 +52,26 @@ To split a bill, use the operations to add a new bill and move accounting items Once a bill is balanced to zero, it can be closed against further change. A PDF version of the bill can be fetched for printing or display purposes. -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to get the guest bill | [Get all bills](../operations/bills.md#get-all-bills) | -| How to get a printable bill | [Get bill PDF](../operations/bills.md#get-bill-pdf) | -| How to get the list of open revenue items for a guest | [Get customer open items](../operations/customers.md#get-customers-open-items) | -| How to create a new bill | [Add bill](../operations/bills.md#add-bill) | -| How to move bill items to a new bill | [Update accounting items](../operations/accountingitems.md#update-accounting-items) | -| How to close a bill against change | [Close bill](../operations/bills.md#close-bill) | +|
'How to' use case
| API Operations | +| :---------------------------------------------------- | :---------------------------------------------------------------------------------- | +| How to get the guest bill | [Get all bills](../operations/bills.md#get-all-bills) | +| How to get a printable bill | [Get bill PDF](../operations/bills.md#get-bill-pdf) | +| How to get the list of open revenue items for a guest | [Get customer open items](../operations/customers.md#get-customers-open-items) | +| How to create a new bill | [Add bill](../operations/bills.md#add-bill) | +| How to move bill items to a new bill | [Update accounting items](../operations/accountingitems.md#update-accounting-items) | +| How to close a bill against change | [Close bill](../operations/bills.md#close-bill) | > ### Payment automation +> > At the end of the reservation, Mews payment automation may have been enacted, so before taking payment from a guest to settle a bill, confirm the outstanding balance as described above. ## Taking payments Once you have confirmed the outstanding balance, you have three options for handling customer payments to settle the bill: -* [Gateway payments](#gateway-payments) -* [Non-Mews terminal payments](#non-mews-terminal-payments) -* [Mews terminal payments](#mews-terminal-payments) +- [Gateway payments](#gateway-payments) +- [Non-Mews terminal payments](#non-mews-terminal-payments) +- [Mews terminal payments](#mews-terminal-payments) ### Gateway payments @@ -79,11 +81,11 @@ The payment will be taken by Mews and recorded on the guest bill. If the guest doesn't have a credit card on file, you can add one to their profile. You can also see what cards are registered against a guest profile. -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to charge a guest credit card using Mews Payments | [Charge credit card](../operations/creditcards.md#charge-credit-card) | -| How to add a credit card to the guest profile | [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card) | -| How to get details of stored credit cards | [Get all credit cards](../operations/creditcards.md#get-all-credit-cards) | +|
'How to' use case
| API Operations | +| :---------------------------------------------------- | :---------------------------------------------------------------------------------- | +| How to charge a guest credit card using Mews Payments | [Charge credit card](../operations/creditcards.md#charge-credit-card) | +| How to add a credit card to the guest profile | [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card) | +| How to get details of stored credit cards | [Get all credit cards](../operations/creditcards.md#get-all-credit-cards) | ### Non-Mews terminal payments @@ -91,16 +93,17 @@ You can take an external payment from a guest using a payment terminal, i.e. out In this case, the payment just needs to be recorded against the guest bill. To record the payment, use the appropriate external payment operation. -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to record an external card payment | [Add credit card payment](../operations/payments.md#add-credit-card-payment) | -| How to record a general external payment | [Add external payment](../operations/payments.md#add-external-payment) | -| How to record an alternative external payment | [Add alternative payment](../operations/payments.md#add-alternative-payment) | +|
'How to' use case
| API Operations | +| :----------------------------------------------- | :--------------------------------------------------------------------------- | +| How to record an external card payment | [Add credit card payment](../operations/payments.md#add-credit-card-payment) | +| How to record a general external payment | [Add external payment](../operations/payments.md#add-external-payment) | +| How to record an alternative external payment | [Add alternative payment](../operations/payments.md#add-alternative-payment) | > ### Adding external payments -> * Use [Add credit card payment](../operations/payments.md#add-credit-card-payment) for a card payment specifically — specify the amount, the credit card details (including obfuscated number) and the customer identifier. -> * Use [Add external payment](../operations/payments.md#add-external-payment) for a general payment of any type — specify the amount, the type of payment (e.g. cash) and the customer identifier. -> * Use [Add alternative payment](../operations/payments.md#add-alternative-payment) for supported alternative payment types, such as "Ideal" — specify the amount, the method of payment, the customer identifier, and any special requirements for that payment type. +> +> - Use [Add credit card payment](../operations/payments.md#add-credit-card-payment) for a card payment specifically — specify the amount, the credit card details (including obfuscated number) and the customer identifier. +> - Use [Add external payment](../operations/payments.md#add-external-payment) for a general payment of any type — specify the amount, the type of payment (e.g. cash) and the customer identifier. +> - Use [Add alternative payment](../operations/payments.md#add-alternative-payment) for supported alternative payment types, such as "Ideal" — specify the amount, the method of payment, the customer identifier, and any special requirements for that payment type. ### Mews terminal payments @@ -110,9 +113,9 @@ We also support the option to connect to Mews payment terminals, for which see o Once the bill is settled, the guest can be checked-out. Note Mews uses the phrase "process reservation" rather than "check-out", and "customer" rather than "guest". -|
'How to' use case
| API Operations | -| :-- | :-- | -| How to check out a guest reservation | [Process reservation](../operations/reservations.md#process-reservation) | +|
'How to' use case
| API Operations | +| :----------------------------------------------- | :----------------------------------------------------------------------- | +| How to check out a guest reservation | [Process reservation](../operations/reservations.md#process-reservation) | ## Modifying reservations @@ -127,18 +130,19 @@ If using [Item parameters](../operations/orders.md#item-parameters), it is highl The list of accounting categories configured at a property is obtained using [Get all accounting categories](../operations/accountingcategories.md#get-all-accounting-categories). > ### Linking orders to reservations +> > When using [Add order](../operations/orders.md#add-order), specify parameter `LinkedReservationId` in order to link the order to a guest reservation. This will greatly assist the property when using billing automation. -|
'How to' use case
|
API Operations
| -| :-- | :-- | -| How to update the details of a reservation | [Update reservations](../operations/reservations.md#update-reservations) | -| How to remove an additional guest from a reservation | [Delete reservation companion](../operations/reservations.md#delete-reservation-companion) | -| How to change the reservation owner | [Update reservation customer](../operations/reservations.md#update-reservation-customer) | -| How to add a product to a reservation | [Add reservation product](../operations/reservations.md#add-reservation-product) | -| How to modify the date or time of a reservation | [Update reservation interval](../operations/reservations.md#update-reservation-interval) | -| How to post an order for a guest | [Add order](../operations/orders.md#add-order) | -| How to link an order to a reservation | [Add order](../operations/orders.md#add-order) (use `LinkedReservationId`) | -| How to get the list of accounting categories | [Get all accounting categories](../operations/accountingcategories.md#get-all-accounting-categories) | +|
'How to' use case
|
API Operations
| +| :--------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | +| How to update the details of a reservation | [Update reservations](../operations/reservations.md#update-reservations) | +| How to remove an additional guest from a reservation | [Delete reservation companion](../operations/reservations.md#delete-reservation-companion) | +| How to change the reservation owner | [Update reservation customer](../operations/reservations.md#update-reservation-customer) | +| How to add a product to a reservation | [Add reservation product](../operations/reservations.md#add-reservation-product) | +| How to modify the date or time of a reservation | [Update reservation interval](../operations/reservations.md#update-reservation-interval) | +| How to post an order for a guest | [Add order](../operations/orders.md#add-order) | +| How to link an order to a reservation | [Add order](../operations/orders.md#add-order) (use `LinkedReservationId`) | +| How to get the list of accounting categories | [Get all accounting categories](../operations/accountingcategories.md#get-all-accounting-categories) | ## Walk-in bookings @@ -160,16 +164,16 @@ This can be used, for example, during check-in or check-out to get the new price Finally, to make a new booking for the guest, use [Add reservations](../operations/reservations.md#add-reservations). Note you will need to specify the unique customer identifier for the guest profile \(see [Working with guest profiles](#working-with-guest-profiles) above\). -|
'How to' use case
|
API Operations
| -| :-- | :-- | -| How to get resource categories (room types) | [Get all resources](../operations/resources.md#get-all-resources) | -| How to get availability | [Get service availability](../operations/services.md#get-service-availability) | -| How to get resource blocks (out of order, etc.) | [Get all resource blocks](../operations/resourceblocks.md#get-all-resource-blocks) | -| How to get configured rates | [Get all rates](../operations/rates.md#get-all-rates) | -| How to get rate pricing | [Get rate pricing](../operations/rates.md#get-rate-pricing) | -| How to price a specific reservation | [Price reservations](../operations/reservations.md#price-reservations) | -| How to get rate package rules | [Get all rules](../operations/rules.md#get-all-rules) | -| How to make a new booking | [Add reservations](../operations/reservations.md#add-reservations) | +|
'How to' use case
|
API Operations
| +| :----------------------------------------------- | :--------------------------------------------------------------------------------- | +| How to get resource categories (room types) | [Get all resources](../operations/resources.md#get-all-resources) | +| How to get availability | [Get service availability](../operations/services.md#get-service-availability) | +| How to get resource blocks (out of order, etc.) | [Get all resource blocks](../operations/resourceblocks.md#get-all-resource-blocks) | +| How to get configured rates | [Get all rates](../operations/rates.md#get-all-rates) | +| How to get rate pricing | [Get rate pricing](../operations/rates.md#get-rate-pricing) | +| How to price a specific reservation | [Price reservations](../operations/reservations.md#price-reservations) | +| How to get rate package rules | [Get all rules](../operations/rules.md#get-all-rules) | +| How to make a new booking | [Add reservations](../operations/reservations.md#add-reservations) | ## Testing your integration From d2e3fea5118ba5c49ed12eb67a6087efa19c15cf Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 11:11:52 +0100 Subject: [PATCH 06/11] Adjust kiosk use case --- connector-api/use-cases/kiosk.md | 239 +++++++++++++++++++------------ 1 file changed, 144 insertions(+), 95 deletions(-) diff --git a/connector-api/use-cases/kiosk.md b/connector-api/use-cases/kiosk.md index bf0e657a..dc21c845 100644 --- a/connector-api/use-cases/kiosk.md +++ b/connector-api/use-cases/kiosk.md @@ -5,10 +5,14 @@ Typically, this includes check-in and check-out, but it can extend to walk-in bo Functionality can include updating the guest profile, viewing the guest bill and making payments, thus the kiosk category of integration covers a number of use cases. Here we consider the most common use cases, although kiosks need not be limited to these. -> ### Kiosk devices -> -> Kiosks can be apps running on off-the-shelf devices such as tablets, or they can consist of custom hardware, incorporating devices such as key encoders, printers and passport scanners. -> If such devices are integrated into the kiosk, then only one integration is made between the kiosk and Mews, the connections with the devices are handled internally by the kiosk. +{% hint style="info" %} + +### Kiosk devices + +Kiosks can be apps running on off-the-shelf devices such as tablets, or they can consist of custom hardware, incorporating devices such as key encoders, printers and passport scanners. +If such devices are integrated into the kiosk, then only one integration is made between the kiosk and Mews, the connections with the devices are handled internally by the kiosk. + +{% endhint %} ## Initial configuration @@ -16,34 +20,34 @@ To help configure your kiosk for a specific property, perform an initial pull of To offer multiple languages, you can retrieve the list of languages supported by the API. You will want to fetch the list of supported guest services and associated products, as properties can configure additional services as well as the default Stay accommodation service. -|
'How to' use case
| API Operations | -| :----------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------- | -| How to get property configuration | [Get configuration](../operations/configuration.md#get-configuration) | -| How to get the list of supported languages | [Get all languages](../operations/languages.md#get-all-languages) | -| How to get the list of services and products | [Get all services](../operations/services.md#get-all-services), [Get all products](../operations/products.md#get-all-products) | +| 'How to' use case | API Operations | +| :------------------------------------------- | :------------------------------------- | +| How to get property configuration | [Get configuration] | +| How to get the list of supported languages | [Get all languages] | +| How to get the list of services and products | [Get all services], [Get all products] | ## Guest check-in -To look up a guest reservation, use the general-purpose operation [Get all reservations](../operations/reservations.md#get-all-reservations-ver-2023-06-06) and specify the required search filters. -To check in a reservation, use [Start reservation](../operations/reservations.md#start-reservation). Note Mews uses the phrase "start reservation" rather than "check-in", and "process reservation" rather than "check-out". +To look up a guest reservation, use the general-purpose operation [Get all reservations] and specify the required search filters. +To check in a reservation, use [Start reservation]. Note Mews uses the phrase "start reservation" rather than "check-in", and "process reservation" rather than "check-out". -|
'How to' use case
| API Operations | -| :----------------------------------------------- | :---------------------------------------------------------------------------------------- | -| How to look up a guest reservation | [Get all reservations](../operations/reservations.md#get-all-reservations-ver-2023-06-06) | -| How to check in a guest reservation | [Start reservation](../operations/reservations.md#start-reservation) | +| 'How to' use case | API Operations | +| :---------------------------------- | :--------------------- | +| How to look up a guest reservation | [Get all reservations] | +| How to check in a guest reservation | [Start reservation] | ## Working with guest profiles -If the guest doesn't have a Mews customer profile, you can add one with [Add customer](../operations/customers.md#add-customer). -If the guest already has a profile, but the information in it needs updating (e.g. address, passport or driver's licence), then use [Update customer](../operations/customers.md#update-customer). -To relate a guest profile to a specific reservation, use [Add reservation companion](../operations/reservations.md#add-reservation-companion). +If the guest doesn't have a Mews customer profile, you can add one with [Add customer]. +If the guest already has a profile, but the information in it needs updating (e.g. address, passport or driver's licence), then use [Update customer]. +To relate a guest profile to a specific reservation, use [Add reservation companion]. Note that "guests" are always referred to as "customers" in the Mews API. -|
'How to' use case
| API Operations | -| :----------------------------------------------- | :----------------------------------------------------------------------------------- | -| How to create a guest profile | [Add customer](../operations/customers.md#add-customer) | -| How to update a guest profile | [Update customer](../operations/customers.md#update-customer) | -| How to add a guest to a reservation | [Add reservation companion](../operations/reservations.md#add-reservation-companion) | +| 'How to' use case | API Operations | +| :---------------------------------- | :-------------------------- | +| How to create a guest profile | [Add customer] | +| How to update a guest profile | [Update customer] | +| How to add a guest to a reservation | [Add reservation companion] | ## Guest bill @@ -52,18 +56,21 @@ To split a bill, use the operations to add a new bill and move accounting items Once a bill is balanced to zero, it can be closed against further change. A PDF version of the bill can be fetched for printing or display purposes. -|
'How to' use case
| API Operations | -| :---------------------------------------------------- | :---------------------------------------------------------------------------------- | -| How to get the guest bill | [Get all bills](../operations/bills.md#get-all-bills) | -| How to get a printable bill | [Get bill PDF](../operations/bills.md#get-bill-pdf) | -| How to get the list of open revenue items for a guest | [Get customer open items](../operations/customers.md#get-customers-open-items) | -| How to create a new bill | [Add bill](../operations/bills.md#add-bill) | -| How to move bill items to a new bill | [Update accounting items](../operations/accountingitems.md#update-accounting-items) | -| How to close a bill against change | [Close bill](../operations/bills.md#close-bill) | +| 'How to' use case | API Operations | +| :---------------------------------------------------- | :------------------------ | +| How to get the guest bill | [Get all bills] | +| How to get a printable bill | [Get bill PDF] | +| How to get the list of open revenue items for a guest | [Get customer open items] | +| How to create a new bill | [Add bill] | +| How to move bill items to a new bill | [Update accounting items] | +| How to close a bill against change | [Close bill] | + +{% hint style="warning" %} -> ### Payment automation -> -> At the end of the reservation, Mews payment automation may have been enacted, so before taking payment from a guest to settle a bill, confirm the outstanding balance as described above. +### Payment automation + +At the end of the reservation, Mews payment automation may have been enacted, so before taking payment from a guest to settle a bill, confirm the outstanding balance as described above. +{% endhint %} ## Taking payments @@ -81,29 +88,30 @@ The payment will be taken by Mews and recorded on the guest bill. If the guest doesn't have a credit card on file, you can add one to their profile. You can also see what cards are registered against a guest profile. -|
'How to' use case
| API Operations | -| :---------------------------------------------------- | :---------------------------------------------------------------------------------- | -| How to charge a guest credit card using Mews Payments | [Charge credit card](../operations/creditcards.md#charge-credit-card) | -| How to add a credit card to the guest profile | [Add tokenized credit card](../operations/creditcards.md#add-tokenized-credit-card) | -| How to get details of stored credit cards | [Get all credit cards](../operations/creditcards.md#get-all-credit-cards) | +| 'How to' use case | API Operations | +| :---------------------------------------------------- | :-------------------------- | +| How to charge a guest credit card using Mews Payments | [Charge credit card] | +| How to add a credit card to the guest profile | [Add tokenized credit card] | +| How to get details of stored credit cards | [Get all credit cards] | ### Non-Mews terminal payments -You can take an external payment from a guest using a payment terminal, i.e. outside of Mews. -In this case, the payment just needs to be recorded against the guest bill. +You can take an external payment from a guest outside of Mews. +In this case, the payment needs to be recorded against the guest bill. To record the payment, use the appropriate external payment operation. -|
'How to' use case
| API Operations | -| :----------------------------------------------- | :--------------------------------------------------------------------------- | -| How to record an external card payment | [Add credit card payment](../operations/payments.md#add-credit-card-payment) | -| How to record a general external payment | [Add external payment](../operations/payments.md#add-external-payment) | -| How to record an alternative external payment | [Add alternative payment](../operations/payments.md#add-alternative-payment) | +| 'How to' use case | API Operations | +| :-------------------------------------------- | :------------------------ | +| How to record a general external payment | [Add external payment] | +| How to record an alternative external payment | [Add alternative payment] | + +{% hint style="info" %} + +### Adding external payments -> ### Adding external payments -> -> - Use [Add credit card payment](../operations/payments.md#add-credit-card-payment) for a card payment specifically — specify the amount, the credit card details (including obfuscated number) and the customer identifier. -> - Use [Add external payment](../operations/payments.md#add-external-payment) for a general payment of any type — specify the amount, the type of payment (e.g. cash) and the customer identifier. -> - Use [Add alternative payment](../operations/payments.md#add-alternative-payment) for supported alternative payment types, such as "Ideal" — specify the amount, the method of payment, the customer identifier, and any special requirements for that payment type. +- Use [Add external payment] for a general payment of any type - specify the amount, the type of payment (e.g. cash) and the customer identifier. +- Use [Add alternative payment] for supported alternative payment types, such as "Ideal" - specify the amount, the method of payment, the customer identifier, and any special requirements for that payment type. + {% endhint %} ### Mews terminal payments @@ -113,70 +121,111 @@ We also support the option to connect to Mews payment terminals, for which see o Once the bill is settled, the guest can be checked-out. Note Mews uses the phrase "process reservation" rather than "check-out", and "customer" rather than "guest". -|
'How to' use case
| API Operations | -| :----------------------------------------------- | :----------------------------------------------------------------------- | -| How to check out a guest reservation | [Process reservation](../operations/reservations.md#process-reservation) | +| 'How to' use case | API Operations | +| :----------------------------------- | :-------------------- | +| How to check out a guest reservation | [Process reservation] | ## Modifying reservations A number of API operations are available to support modifications to reservations. -[Update reservations](../operations/reservations.md#update-reservations) offers the widest range of fields to update simultaneously for a specified reservation, e.g. adult count, assigned resource, company, rate. -You can remove a companion (i.e. an additional guest) from a reservation using [Delete reservation companion](../operations/reservations.md#delete-reservation-companion), or change the primary guest or owner of the reservation with [Update reservation customer](../operations/reservations.md#update-reservation-customer). -To add additional products to a reservation, use [Add reservation product](../operations/reservations.md#add-reservation-product). -To modify only the start and/or end of the reservation, use [Update reservation interval](../operations/reservations.md#update-reservation-interval). - -Products from additional services that may not be configured in Mews can be posted to the guest profile using [Add order](../operations/orders.md#add-order). -If using [Item parameters](../operations/orders.md#item-parameters), it is highly recommended to specify the accounting category that the posting belongs to, for the sake of financial reporting. -The list of accounting categories configured at a property is obtained using [Get all accounting categories](../operations/accountingcategories.md#get-all-accounting-categories). - -> ### Linking orders to reservations -> -> When using [Add order](../operations/orders.md#add-order), specify parameter `LinkedReservationId` in order to link the order to a guest reservation. This will greatly assist the property when using billing automation. - -|
'How to' use case
|
API Operations
| -| :--------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | -| How to update the details of a reservation | [Update reservations](../operations/reservations.md#update-reservations) | -| How to remove an additional guest from a reservation | [Delete reservation companion](../operations/reservations.md#delete-reservation-companion) | -| How to change the reservation owner | [Update reservation customer](../operations/reservations.md#update-reservation-customer) | -| How to add a product to a reservation | [Add reservation product](../operations/reservations.md#add-reservation-product) | -| How to modify the date or time of a reservation | [Update reservation interval](../operations/reservations.md#update-reservation-interval) | -| How to post an order for a guest | [Add order](../operations/orders.md#add-order) | -| How to link an order to a reservation | [Add order](../operations/orders.md#add-order) (use `LinkedReservationId`) | -| How to get the list of accounting categories | [Get all accounting categories](../operations/accountingcategories.md#get-all-accounting-categories) | +[Update reservations] offers the widest range of fields to update simultaneously for a specified reservation, e.g. adult count, assigned resource, company, rate. +You can remove a companion (i.e. an additional guest) from a reservation using [Delete reservation companion], or change the primary guest or owner of the reservation with [Update reservation customer]. +To add additional products to a reservation, use [Add reservation product]. +To modify only the start and/or end of the reservation, use [Update reservation interval]. + +Products from additional services that may not be configured in Mews can be posted to the guest profile using [Add order]. +If using [Item parameters], it is highly recommended to specify the accounting category that the posting belongs to, for the sake of financial reporting. +The list of accounting categories configured at a property is obtained using [Get all accounting categories]. + +{% hint style="info" %} + +### Linking orders to reservations + +When using [Add order], specify parameter `LinkedReservationId` in order to link the order to a guest reservation. This will greatly assist the property when using billing automation. +{% endhint %} + +| 'How to' use case | API Operations | +| :--------------------------------------------------- | :-------------------------------------- | +| How to update the details of a reservation | [Update reservations] | +| How to remove an additional guest from a reservation | [Delete reservation companion] | +| How to change the reservation owner | [Update reservation customer] | +| How to add a product to a reservation | [Add reservation product] | +| How to modify the date or time of a reservation | [Update reservation interval] | +| How to post an order for a guest | [Add order] | +| How to link an order to a reservation | [Add order] (use `LinkedReservationId`) | +| How to get the list of accounting categories | [Get all accounting categories] | ## Walk-in bookings This section is relevant if your kiosk allows guests to create new reservations, rather than simply fetching existing reservations. The API supports operations to facilitate the process, but consider also looking at the [Mews Booking Engine API](https://mews-systems.gitbook.io/booking-engine-guide/booking-engine-api) which is optimized for this task. -Use [Get all resources](../operations/resources.md#get-all-resources) to map out the physical configuration of the property. This will give you the names and descriptions of different resource categories, including room types. +Use [Get all resources] to map out the physical configuration of the property. This will give you the names and descriptions of different resource categories, including room types. -Use [Get service availability](../operations/services.md#get-service-availability) to fetch availability. -This availability does not consider resource blocks temporarily taken out of service, so you will also want to use [Get all resource blocks](../operations/resourceblocks.md#get-all-resource-blocks) to get this information. +Use [Get service availability] to fetch availability. +This availability does not consider resource blocks temporarily taken out of service, so you will also want to use [Get all resource blocks] to get this information. -Use [Get all rates](../operations/rates.md#get-all-rates) to retrieve all the rates configured at the property, and [Get rate pricing](../operations/rates.md#get-rate-pricing) to request the related prices for specified dates and times. +Use [Get all rates] to retrieve all the rates configured at the property, and [Get rate pricing] to request the related prices for specified dates and times. Rate packages apply rules to automatically post specified products when certain rates are selected. -Use [Get all rules](../operations/rules.md#get-all-rules) to get the full list of rate rules. +Use [Get all rules] to get the full list of rate rules. -To calculate the price of a reservation with specific parameters, i.e. obtain a specific quotation, use [Price reservations](../operations/reservations.md#price-reservations). +To calculate the price of a reservation with specific parameters, i.e. obtain a specific quotation, use [Price reservations]. This can be used, for example, during check-in or check-out to get the new price of a reservation if you select a different resource category or room type, or to check if a selected or pre-booked product should have its price included or not. -Finally, to make a new booking for the guest, use [Add reservations](../operations/reservations.md#add-reservations). -Note you will need to specify the unique customer identifier for the guest profile \(see [Working with guest profiles](#working-with-guest-profiles) above\). +Finally, to make a new booking for the guest, use [Add reservations]. +Note you will need to specify the unique customer identifier for the guest profile (see [Working with guest profiles](#working-with-guest-profiles) above). -|
'How to' use case
|
API Operations
| -| :----------------------------------------------- | :--------------------------------------------------------------------------------- | -| How to get resource categories (room types) | [Get all resources](../operations/resources.md#get-all-resources) | -| How to get availability | [Get service availability](../operations/services.md#get-service-availability) | -| How to get resource blocks (out of order, etc.) | [Get all resource blocks](../operations/resourceblocks.md#get-all-resource-blocks) | -| How to get configured rates | [Get all rates](../operations/rates.md#get-all-rates) | -| How to get rate pricing | [Get rate pricing](../operations/rates.md#get-rate-pricing) | -| How to price a specific reservation | [Price reservations](../operations/reservations.md#price-reservations) | -| How to get rate package rules | [Get all rules](../operations/rules.md#get-all-rules) | -| How to make a new booking | [Add reservations](../operations/reservations.md#add-reservations) | +| 'How to' use case | API Operations | +| :---------------------------------------------- | :------------------------- | +| How to get resource categories (room types) | [Get all resources] | +| How to get availability | [Get service availability] | +| How to get resource blocks (out of order, etc.) | [Get all resource blocks] | +| How to get configured rates | [Get all rates] | +| How to get rate pricing | [Get rate pricing] | +| How to price a specific reservation | [Price reservations] | +| How to get rate package rules | [Get all rules] | +| How to make a new booking | [Add reservations] | ## Testing your integration Ensure you follow our general [Usage guidelines](../guidelines/README.md) for testing integrations. For additional help when working with the demo environment, there is a range of helpful articles in the [Mews Help Center](https://help.mews.com/s/?language=en_US), including [Understanding services](https://help.mews.com/s/article/understanding-services?language=en_US). These are available in a number of languages. + +[Add alternative payment]: ../operations/payments.md#add-alternative-payment +[Add bill]: ../operations/bills.md#add-bill +[Add customer]: ../operations/customers.md#add-customer +[Add external payment]: ../operations/payments.md#add-external-payment +[Add order]: ../operations/orders.md#add-order +[Add reservation companion]: ../operations/reservations.md#add-reservation-companion +[Add reservation product]: ../operations/reservations.md#add-reservation-product +[Add reservations]: ../operations/reservations.md#add-reservations +[Add tokenized credit card]: ../operations/creditcards.md#add-tokenized-credit-card +[Charge credit card]: ../operations/creditcards.md#charge-credit-card +[Close bill]: ../operations/bills.md#close-bill +[Delete reservation companion]: ../operations/reservations.md#delete-reservation-companion +[Get all accounting categories]: ../operations/accountingcategories.md#get-all-accounting-categories +[Get all bills]: ../operations/bills.md#get-all-bills +[Get all credit cards]: ../operations/creditcards.md#get-all-credit-cards +[Get all languages]: ../operations/languages.md#get-all-languages +[Get all products]: ../operations/products.md#get-all-products +[Get all rates]: ../operations/rates.md#get-all-rates +[Get all reservations]: ../operations/reservations.md#get-all-reservations-ver-2023-06-06 +[Get all resource blocks]: ../operations/resourceblocks.md#get-all-resource-blocks +[Get all resources]: ../operations/resources.md#get-all-resources +[Get all rules]: ../operations/rules.md#get-all-rules +[Get all services]: ../operations/services.md#get-all-services +[Get bill PDF]: ../operations/bills.md#get-bill-pdf +[Get configuration]: ../operations/configuration.md#get-configuration +[Get customer open items]: ../operations/customers.md#get-customers-open-items +[Get rate pricing]: ../operations/rates.md#get-rate-pricing +[Get service availability]: ../operations/services.md#get-service-availability +[Item parameters]: ../operations/orders.md#item-parameters +[Price reservations]: ../operations/reservations.md#price-reservations +[Process reservation]: ../operations/reservations.md#process-reservation +[Start reservation]: ../operations/reservations.md#start-reservation +[Update accounting items]: ../operations/accountingitems.md#update-accounting-items +[Update customer]: ../operations/customers.md#update-customer +[Update reservation customer]: ../operations/reservations.md#update-reservation-customer +[Update reservation interval]: ../operations/reservations.md#update-reservation-interval +[Update reservations]: ../operations/reservations.md#update-reservations From 03dfdb2aa19032794cee50913f6ee387437b3bd3 Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 11:15:23 +0100 Subject: [PATCH 07/11] Clean up --- connector-api/use-cases/payment-automation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/connector-api/use-cases/payment-automation.md b/connector-api/use-cases/payment-automation.md index 4722c094..a23f446c 100644 --- a/connector-api/use-cases/payment-automation.md +++ b/connector-api/use-cases/payment-automation.md @@ -102,4 +102,3 @@ The latter simply records a credit card payment in Mews and does not trigger any [Charge credit card]: ../operations/creditcards.md#charge-credit-card [Get configuration]: ../operations/configuration.md#get-configuration [Get all credit cards]: ../operations/creditcards.md#get-all-credit-cards -[Add credit card payment]: ../operations/payments.md#add-credit-card-payment From f16244a04781b3301343466d64a13136a59756bb Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 11:31:18 +0100 Subject: [PATCH 08/11] Fix typo in depr message --- connector-api/changelog/README.md | 2 +- connector-api/deprecations/README.md | 2 +- connector-api/operations/README.md | 2 +- connector-api/operations/payments.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/connector-api/changelog/README.md b/connector-api/changelog/README.md index 0e8d0da2..2a1b49d8 100644 --- a/connector-api/changelog/README.md +++ b/connector-api/changelog/README.md @@ -7,7 +7,7 @@ ## Deprecation of Add credit card payment operation - [Add credit card payment](../operations/payments.md#add-credit-card-payment): - - **Deprecated** operation. Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. + - **Deprecated** operation. Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit card payments. - This operation will be discontinued on **10 January 2028**. - A detailed migration guide along with new front-end SDK for collecting payment data will be published in Q2 2026. diff --git a/connector-api/deprecations/README.md b/connector-api/deprecations/README.md index 181c9af2..a5aaa725 100644 --- a/connector-api/deprecations/README.md +++ b/connector-api/deprecations/README.md @@ -22,7 +22,7 @@ The table columns have the following meanings: | Feature | Comments | Deprecated | Discontinued | | :-- | :-- | :-- | :-- | -| [Add credit card payment](../operations/payments.md#add-credit-card-payment) | Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. | 11 Mar 2026 | 10 Jan 2028 | +| [Add credit card payment](../operations/payments.md#add-credit-card-payment) | Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit card payments. | 11 Mar 2026 | 10 Jan 2028 | | [Get all routing rules](../operations/routingrules.md#get-all-routing-rules) | Replaced by [Get all billing automations](../operations/billingautomations.md#get-all-billing-automations) | 11 Nov 2025 | 10 Jan 2027 | | [Add routing rules](../operations/routingrules.md#add-routing-rules) | Replaced by [Add billing automations](../operations/billingautomations.md#add-billing-automations) | 11 Nov 2025 | 10 Jan 2027 | | [Update routing rules](../operations/routingrules.md#update-routing-rules) | Replaced by [Update billing automations](../operations/billingautomations.md#update-billing-automations) and [Update billing automation assignments](../operations/billingautomations.md#update-billing-automation-assignments) | 11 Nov 2025 | 10 Jan 2027 | diff --git a/connector-api/operations/README.md b/connector-api/operations/README.md index eb7f731b..df6221ae 100644 --- a/connector-api/operations/README.md +++ b/connector-api/operations/README.md @@ -131,7 +131,7 @@ This section describes all operations supported by the API, organised here by th | [Add tokenized credit card](creditcards.md#add-tokenized-credit-card) | Adds a new tokenized credit card to the specified customer | | [Disable gateway credit card](creditcards.md#disable-gateway-credit-card) | **Restricted!** Disables a credit card from being used for payments | | [Get all preauthorizations
by customers](preauthorizations.md#get-all-preauthorizations-by-customers) | Returns all preauthorizations of specified customers | -| ~~[Add credit card payment](payments.md#add-credit-card-payment)~~ | **Deprecated!** Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. | +| ~~[Add credit card payment](payments.md#add-credit-card-payment)~~ | **Deprecated!** Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit card payments. | | [Add external payment](payments.md#add-external-payment) | Adds a new external payment to a bill of the specified customer | | [Add alternative payment](payments.md#add-alternative-payment) | Adds a new alternative payment to a specified customer | | [Get all payments](payments.md#get-all-payments) | Returns all payments, filtered by various parameters | diff --git a/connector-api/operations/payments.md b/connector-api/operations/payments.md index db21ac19..deb745c8 100644 --- a/connector-api/operations/payments.md +++ b/connector-api/operations/payments.md @@ -470,7 +470,7 @@ Adds a new external payment to a bill of the specified customer. An external pay ## ~~Add credit card payment~~ > ### Deprecated! -> This operation is [deprecated](../deprecations/README.md). Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit cards payments. +> This operation is [deprecated](../deprecations/README.md). Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit card payments. ### Request @@ -637,7 +637,7 @@ Adds a new alternative payment to a specified customer. ## Refund payment Refunds a specified payment on a specified account. A reason must be provided. Optionally, specify an amount for a partial refund. This operation supports [Portfolio Access Tokens](../concepts/multi-property.md). - + * **Payment types**: Only `CreditCardPayment` and `AlternativePayment` can be refunded. Other payment types will fail. * **Refund information**: The refund is a payment itself. To get more information, use [Get all payments](payments.md#get-all-payments) with the `RefundId` as the `PaymentId`. * **Potential failures**: This operation initiates the refund process, but refunds can fail if the payment is in a `Pending` state and fails processing. To check the status of a pending payment, including refunds, use [Get all payments](payments.md#get-all-payments). From a1788393fb5b6dc9471c5b6a277a37f88ceaceba Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Wed, 11 Mar 2026 11:59:39 +0100 Subject: [PATCH 09/11] CR feedback --- connector-api/use-cases/kiosk.md | 3 ++- connector-api/use-cases/payment-automation.md | 9 --------- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/connector-api/use-cases/kiosk.md b/connector-api/use-cases/kiosk.md index dc21c845..12de73ee 100644 --- a/connector-api/use-cases/kiosk.md +++ b/connector-api/use-cases/kiosk.md @@ -111,7 +111,8 @@ To record the payment, use the appropriate external payment operation. - Use [Add external payment] for a general payment of any type - specify the amount, the type of payment (e.g. cash) and the customer identifier. - Use [Add alternative payment] for supported alternative payment types, such as "Ideal" - specify the amount, the method of payment, the customer identifier, and any special requirements for that payment type. - {% endhint %} + +{% endhint %} ### Mews terminal payments diff --git a/connector-api/use-cases/payment-automation.md b/connector-api/use-cases/payment-automation.md index a23f446c..0bb39beb 100644 --- a/connector-api/use-cases/payment-automation.md +++ b/connector-api/use-cases/payment-automation.md @@ -89,15 +89,6 @@ Note that while customer profiles are shared across all properties in a chain, c Now that you have the `CreditCardId`, you can use the [Charge credit card] endpoint to charge the customer. -{% hint style="warning" %} - -### Charge credit card - -The [Charge credit card] operation actually charges the customer's credit card, whereas the [Add credit card payment] operation does not. - -The latter simply records a credit card payment in Mews and does not trigger any additional action beyond Mews. Use it when the customer's credit card has already been charged from your solution. -{% endhint %} - [Add tokenized credit card]: ../operations/creditcards.md#add-tokenized-credit-card [Charge credit card]: ../operations/creditcards.md#charge-credit-card [Get configuration]: ../operations/configuration.md#get-configuration From e64aede5b71b0117022d55e72858cdb828e64aef Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Thu, 12 Mar 2026 14:50:57 +0100 Subject: [PATCH 10/11] Add notes about Mews Payments Checkout --- connector-api/changelog/README.md | 6 ++++-- connector-api/use-cases/payment-automation.md | 8 ++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/connector-api/changelog/README.md b/connector-api/changelog/README.md index 2a1b49d8..7d19d506 100644 --- a/connector-api/changelog/README.md +++ b/connector-api/changelog/README.md @@ -2,16 +2,18 @@ {% updates format="full" %} -{% update date="2026-03-11" %} +{% update date="2026-03-12" %} ## Deprecation of Add credit card payment operation - [Add credit card payment](../operations/payments.md#add-credit-card-payment): - **Deprecated** operation. Follow the [Payment automation use case](../use-cases/payment-automation.md) for processing credit card payments. - This operation will be discontinued on **10 January 2028**. - - A detailed migration guide along with new front-end SDK for collecting payment data will be published in Q2 2026. + - Existing integrations can keep using this operation until the discontinuation date. A detailed migration guide will be provided in Q2 2026. + - New integrations can join the pilot program for **Mews Payments Checkout** through an embedded form or external payment request page. [Contact partner support](../contact-support/) for more information on how to join the pilot program. {% endupdate %} + {% update date="2026-02-27" %} ## New operation: Close tasks diff --git a/connector-api/use-cases/payment-automation.md b/connector-api/use-cases/payment-automation.md index 0bb39beb..e24856b0 100644 --- a/connector-api/use-cases/payment-automation.md +++ b/connector-api/use-cases/payment-automation.md @@ -32,6 +32,14 @@ To check if a user's credit card is already attached to their customer profile, ## Adding a tokenized credit card +{% hint style="info" %} + +### Pilot program for Mews Payments Checkout + +If your integration involves the collection of credit card details, you may be eligible to participate in the pilot program for the **Mews Payments Checkout** through an embedded form or external payment request page. Please [contact partner support](../contact-support/) for more information on how to join the pilot program. + +{% endhint %} + {% stepper %} {% step %} From 2ef7a7ba0f472335b5ec7aa2db410df5fece1ada Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Thu, 12 Mar 2026 14:52:12 +0100 Subject: [PATCH 11/11] Use h3 for info hint --- connector-api/use-cases/payment-automation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/connector-api/use-cases/payment-automation.md b/connector-api/use-cases/payment-automation.md index e24856b0..acf18c8e 100644 --- a/connector-api/use-cases/payment-automation.md +++ b/connector-api/use-cases/payment-automation.md @@ -65,7 +65,7 @@ Note you do _not_ need to follow Step 2 [Obtain the tokens](https://docs.pci-pro {% hint style="info" %} -#### Expiration date +### Expiration date Though not required by PCI Proxy, credit card expiration date is listed as a mandatory parameter on the [Add tokenized credit card] operation so that it can be displayed within the customer profile in Mews. This can also be used as an additional validation method to identify whether there is an expired card on file.