Add external payment
POST /api/connector/v1/payments/addExternal
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.
Prerequisites: The external payment type must be enabled by the property in order to accept such payments in their Mews environment. Use Get configuration to check which external payment types are supported.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
Unique identifier of the Customer. Deprecated!
Unique identifier of an open bill of the customer where to assign the payment.
Unique identifier of an Accounting category to be assigned to the external payment.
Unique identifier of the reservation the payment belongs to.
Amount of the external card payment.
object
ISO-4217 code of the Currency.
The tax values applied.
Net value in case the item is taxed.
Gross value including all taxes.
Type of the external payment. (Required for the enterprises based in the French Legal Environment where Unspecified is considered as fraud.)
Unspecified (Unspecified (unavailable in French Legal Environment))
BadDebts (Bad debts)
Bacs (Bacs payment)
WireTransfer (Wire transfer)
Invoice (Invoice)
ExchangeRateDifference (Exchange rate difference)
Complimentary (Complimentary)
Reseller (Reseller)
ExchangeRoundingDifference (Exchange rounding difference)
Barter (Barter)
Commission (Commission)
BankCharges (Bank charges)
CrossSettlement (Cross settlement)
Cash (Cash)
CreditCard (Credit card – deprecated, only for existing partners)
Prepayment (Prepayment)
Cheque (Cheque)
Bancontact (Bancontact)
IDeal (iDeal – deprecated, only for existing partners)
PayPal (PayPal – deprecated, only for existing partners)
GiftCard (Gift card)
LoyaltyPoints (Loyalty points)
ChequeVacances (Chèque-Vacances)
OnlinePayment (Online payment – deprecated, only for existing partners)
CardCheck (Card check)
PaymentHubRedirection (Payment hub redirection)
Voucher (Voucher)
MasterCard (MasterCard – deprecated, only for existing partners)
Visa (Visa – deprecated, only for existing partners)
Amex (American Express – deprecated, only for existing partners)
Discover (Discover – deprecated, only for existing partners)
DinersClub (Diners Club – deprecated, only for existing partners)
Jcb (JCB – deprecated, only for existing partners)
UnionPay (UnionPay – deprecated, only for existing partners)
Twint (TWINT)
Reka (Reka)
LoyaltyCard (Loyalty card)
PosDiningAndSpaReward (POS Dining & Spa Reward)
DirectDebit (Direct debit)
DepositCheck (Deposit - check)
DepositCash (Deposit - cash)
DepositCreditCard (Deposit - credit card)
DepositWireTransfer (Deposit - wire transfer)
Identifier of the payment from external system.
Additional payment notes.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "AccountId": "35d4b117-4e60-44a3-9580-c582117eff98", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Amount": { "Currency": "GBP", "GrossValue": 100 }, "ExternalIdentifier": "b06de5e4-7137-47ec-8a49-3303131b02c0", "Type": "Cash", "AccountingCategoryId": null}Responses
Section titled “ Responses ”OK
object
Unique identifier of the Payment item.
Example
{ "ExternalPaymentId": "4ee05b77-ae21-46e8-8418-ac1c009dfb2b"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.