How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mews Payments API

The Payments API from Mews — 5 operation(s) for payments.

Mews Payments API is one of 154 APIs that Mews publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and a support channel.

This API exposes 5 operations across 5 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://api.mews.com, https://api.mews-demo.com.

5 operations 5 paths 50 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.mews.com/api/connector/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Mews Payments API declares 2 security schemes for authenticating requests. An API key is passed in the header as ClientToken (MewsClientToken). An API key is passed in the header as AccessToken (MewsAccessToken). By default, every request must be authenticated.

  • MewsClientToken — Mews authentication is performed by supplying ClientToken, AccessToken and Client as fields in the JSON request body (not as HTTP headers). This securityScheme…
  • MewsAccessToken — Tooling-compatible representation of the AccessToken credential, which is supplied in the JSON request body. AccessToken is unique to the connection with a pro…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 5
POST
/api/connector/v1/payments/getAll
Mews Get All Payments
payments_getAll body → 200400401403408204429500
POST
/api/connector/v1/payments/refund
Mews Refund Payment
payments_refund body → 200400401403408204429500
POST
/api/connector/v1/payments/addCreditCard
Mews Add Credit Card Payment
payments_addCreditCard body → 200400401403408204429500
POST
/api/connector/v1/payments/addExternal
Mews Add External Payment
payments_addExternal body → 200400401403408204429500
POST
/api/connector/v1/payments/addAlternative
Mews Add Alternative Payment
payments_addAlternative body → 200400401403408204429500

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are Payment (25 properties), PaymentFilterParameters (18 properties), ExternalPaymentParameters (13 properties), CreditCardPaymentParameters (11 properties). Each schema is shown below with its type and property counts.

NextAction
object
2 properties 2 required
Amount
object
5 properties 5 required
ExtendedAmountParameters
object
4 properties 1 required
CreditCardPaymentParameters
object
11 properties 6 required
AddCreditCardResult
object
1 property
PaymentStateEnum
string
Charged Canceled Pending Failed Verifying
AccountingStateEnum
string
Open (Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice.) Closed (Order items which carry a non-zero value and…
TimeFilterInterval
object
When a time interval is used for filtering (for example in parameters such as CreatedUtc.StartUtc / CreatedUtc.EndUtc), the following rules apply: - Start equa…
2 properties
ExtendedAmount
object
9 properties 5 required
CreditCardParameters
object
4 properties 3 required
AccountingState
string
PaymentFilterParameters
object
18 properties 4 required
InvoicePaymentTypeEnum
string
Receivable Balancing UnderpaymentBalancingReceivable OverpaymentBalancingReceivable Overpayment
AmountParameters
object
Price of the product that overrides the price defined in Mews.
4 properties 2 required
TaxBreakdownItem
object
3 properties 2 required
PaymentState
string
PaymentAlternativeData
object
1 property 1 required
AlternativePaymentParameters
object
9 properties 6 required
AlternativePaymentMethodDeprecated
string
NextActionTypeEnum
string
RedirectToUrl (Redirect customer to a URL where they can complete their payment.)
PaymentResult
object
2 properties 1 required
AlternativePaymentMethodTypeEnum
string
Ideal (iDEAL) ApplePay (Apple Pay) GooglePay (Google Pay) SepaDirectDebit (SEPA Direct Debit) PayPal (PayPal) WireTransfer (Wire transfer)
AlternativePaymentResult
object
2 properties 1 required
PaymentDiscriminatorEnum
string
Payment CreditCardPayment AlternativePayment CashPayment InvoicePayment ExternalPayment GhostPayment TaxDeductedPayment
SepaDirectDebitData
object
5 properties 5 required
AddExternalPaymentResult
object
1 property
PaymentDataDiscriminatorEnum
string
CreditCard Invoice External Ghost Alternative
AlternativePaymentMethodEnum
string
Ideal (iDEAL data.) ApplePay (No additional data.) GooglePay (No additional data.) SepaDirectDebit (SEPA Direct Debit data.)
PaymentRefundResult
object
5 properties 5 required
IdealData
object
1 property 1 required
TaxBreakdown
object
1 property 1 required
PaymentGhostData
object
1 property 1 required
ExternalPaymentParameters
object
13 properties 5 required
Limitation
object
Limitation on the quantity of data returned.
2 properties 1 required
PaymentData
object
6 properties 1 required
PaymentCreditCardData
object
2 properties
CurrencyValue
object
Absolute value of the fee.
2 properties 2 required
PaymentInvoiceData
object
2 properties 1 required
PaymentKindEnum
string
Payment Chargeback ChargebackReversal Refund
PaymentExternalData
object
2 properties 1 required
ExternalPaymentTypeEnum
string
Unspecified (Unspecified (unavailable in French Legal Environment)) BadDebts (Bad debts) Bacs (Bacs payment) WireTransfer (Wire transfer) Invoice (Invoice) Exc…
TaxValue
object
2 properties 1 required
AlternativePaymentsData
object
3 properties 1 required
Payment
object
25 properties 12 required
PaymentRefundParameters
object
8 properties 6 required
CreditCardTransaction
object
7 properties 2 required
ConnectorApiExceptionResult
object
3 properties
AccountType
string
A discriminator specifying the account type, e.g. Customer or Company
RefundTypeEnum
string
CreditCardPayment AlternativePayment
PaymentOriginEnum
string
Other (Fallback value unmapped in the current version of the API.) System Operations AutomaticPayment PaymentRequest BookingEngine Api (Connector API.) Termina…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mews-systems-payments-api-openapi.yml Raw ↑

Other APIs Mews publishes across the network.

Mews Channel Manager API
Mews POS API
Mews Loyalty Partner API
Mews Account notes API
Mews Accounting categories API
Mews Accounting items API
Mews Accounts API
Mews Addresses API
Mews Age categories API
Mews Availability adjustments API
Mews Availability Blocks API
Mews Billing automations API
Where this information came from

This is an independent, third-party profile of Mews Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.