{ "opencollection": "1.0.0", "info": { "name": "Mews Booking Engine API (Distributor) Account notes Payments API", "version": "v1" }, "request": { "auth": { "type": "apikey", "key": "ClientToken", "value": "{{ClientToken}}", "placement": "header" } }, "items": [ { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "Mews Get All Payments", "type": "http" }, "http": { "method": "POST", "url": "https://api.mews.com/api/connector/v1/payments/getAll", "body": { "type": "json", "data": "{}" } }, "docs": "Returns all payments in the system, filtered by various parameters. At least one filter parameter must be specified. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property)." }, { "info": { "name": "Mews Refund Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.mews.com/api/connector/v1/payments/refund", "body": { "type": "json", "data": "{}" } }, "docs": "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](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).\r\n \r\n* **Payment types**: Only `CreditCardPayment` and `AlternativePayment` can be refunded. Other payment types will fail.\r\n* **Refund information**: The refund is a payment itself. To get more in" }, { "info": { "name": "Mews Add Credit Card Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.mews.com/api/connector/v1/payments/addCreditCard", "body": { "type": "json", "data": "{}" } }, "docs": "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. \nThe bill can then be closed manually by a Mews user, or automatically via API with the [Close bill](https://mews-systems.gitbook.io/con" }, { "info": { "name": "Mews Add External Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.mews.com/api/connector/v1/payments/addExternal", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new external payment to a bill of the specified customer. An external payment represents a payment that is tracked outside of the system. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).\r\n\r\n**Prerequisites:** The external payment type must be enabled by the property in order to accept such payments in their Mews environment. Use [Get configuration](https://mews-systems.gitbook.io/connector-api/operations/config" }, { "info": { "name": "Mews Add Alternative Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.mews.com/api/connector/v1/payments/addAlternative", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new alternative payment to a specified customer.\n**Pre-requisites:** The property must have the relevant type of alternative payment method enabled in their Mews subscriptions in order to accept such payments in their Mews environment. Please ask the property to confirm." } ] } ], "bundled": true }