Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions connector-api/changelog/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# Changelog

{% updates format="full" %}

{% 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**.
- 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
Expand Down
1 change: 1 addition & 0 deletions connector-api/deprecations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 card payments. | 11 Mar 2026 | 10 Jan 2028 |
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The replacement guidance in the deprecation table points to the Payment automation use case for "processing credit card payments", but this deprecated operation’s purpose is to record an already-taken external card payment. Consider updating this comment to point to the appropriate replacement for recording external payments (e.g., Add external payment with guidance on Type), and optionally mention payment automation only for the "charge via Mews" scenario.

Suggested change
| [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 |
| [Add credit card payment](../operations/payments.md#add-credit-card-payment) | Use [Add external payment](../operations/payments.md#add-external-payment) to record external card payments (set the appropriate `Type`). To charge cards via Mews, follow the [Payment automation use case](../use-cases/payment-automation.md). | 11 Mar 2026 | 10 Jan 2028 |

Copilot uses AI. Check for mistakes.
| [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 |
Expand Down
4 changes: 2 additions & 2 deletions connector-api/operations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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<br/>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 card payments. |
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This row uses ~~[Add credit card payment](...)~~ for strikethrough, but the rest of this table consistently uses [~~Operation name~~](...) (e.g., "Get customers open items", "Merge customers"). Aligning to the existing pattern keeps rendering consistent and avoids markdown edge-cases around striking through links.

Suggested change
| ~~[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 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. |

Copilot uses AI. Check for mistakes.
| [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 |
Expand Down
8 changes: 4 additions & 4 deletions connector-api/operations/payments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 card payments.

### Request

Expand Down Expand Up @@ -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).
Expand Down
1 change: 0 additions & 1 deletion connector-api/use-cases/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
Loading
Loading