Conversation
- fix links to mews help - update link to PCI certificate - use proper hints and steppers
There was a problem hiding this comment.
Pull request overview
Updates the Connector API documentation to deprecate the payments/addCreditCard (“Add credit card payment”) operation and to adjust related use cases and reference pages accordingly.
Changes:
- Deprecates “Add credit card payment” in the operation docs and operations index, and adds it to the Deprecations table.
- Updates the Payment Automation and Kiosk use cases to remove/reduce reliance on the deprecated operation and to modernize formatting (hints/stepper/reference links).
- Adds a changelog entry announcing the deprecation and discontinuation date.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| connector-api/use-cases/payment-automation.md | Reformats content (hint/stepper) and updates guidance around tokenized card flows. |
| connector-api/use-cases/kiosk.md | Removes deprecated operation from kiosk payment guidance and refactors to reference-style links/hints. |
| connector-api/use-cases/how-to.md | Removes the “record an external card payment” row pointing to the deprecated operation. |
| connector-api/operations/payments.md | Marks “Add credit card payment” as deprecated in the operation page. |
| connector-api/operations/README.md | Marks “Add credit card payment” as deprecated in the operations list. |
| connector-api/deprecations/README.md | Adds “Add credit card payment” to the deprecations table with dates. |
| connector-api/changelog/README.md | Adds a 2026-03-11 changelog entry for this deprecation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| {% 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 %} |
There was a problem hiding this comment.
This section still references the deprecated Add credit card payment operation, but the PR description says the Payment Automation use case should remove mentions of that operation. Either update the PR description to reflect the intent, or reword this hint to avoid mentioning/linking the deprecated operation.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| | [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. | |
There was a problem hiding this comment.
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.
| | ~~[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. | |
| 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. | ||
|
|
||
| | <div style="width:350px">'How to' use case</div> | 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. |
There was a problem hiding this comment.
After removing the deprecated Add credit card payment operation, this section no longer explicitly explains how to record an external card payment taken outside of Mews. Since the surrounding text still describes taking payments outside Mews, consider adding a short clarification here that external card payments should be recorded via Add external payment (and which Type values to use / how to represent card payments) so the flow remains actionable.
|
|
||
| | 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 | |
There was a problem hiding this comment.
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.
| | [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 | |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| 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. | ||
|
|
||
| | <div style="width:350px">'How to' use case</div> | 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 %} |
There was a problem hiding this comment.
This section no longer explains how to record an external card payment taken outside of Mews now that “Add credit card payment” has been removed from the tables. Currently only “Add external payment” and “Add alternative payment” are listed, but the API still supports representing card payments via external payments (e.g., Type: CreditCard, though marked deprecated) and/or the deprecated addCreditCard operation for partners who still need card metadata. Please clarify the recommended path for external card payments so readers don’t conclude card payments can’t be recorded anymore.
Summary
Checklist
SUMMARY.mdupdated if new pages addedAPI