Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Payments

Add external payment

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.

post/api/connector/v1/payments/addExternal

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdstring uuid nullable

Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

AccountIdstring uuid required

Unique identifier of the Customer or Company. Company billing may not be enabled for your integration.

CustomerIdstring uuid nullable

Unique identifier of the Customer. Deprecated!

BillIdstring uuid nullable

Unique identifier of an open bill of the customer where to assign the payment.

AccountingCategoryIdstring uuid nullable

Unique identifier of an Accounting category to be assigned to the external payment.

ReservationIdstring uuid nullable

Unique identifier of the reservation the payment belongs to.

Type'Unspecified' | 'BadDebts' | 'Bacs' | 'WireTransfer' | 'Invoice' | 'ExchangeRateDifference' | 'Complimentary' | 'Reseller' | 'ExchangeRoundingDifference' | 'Barter' | 'Commission' | 'BankCharges' | 'CrossSettlement' | 'Cash' | 'CreditCard' | 'Prepayment' | 'Cheque' | 'Bancontact' | 'IDeal' | 'PayPal' | 'GiftCard' | 'LoyaltyPoints' | 'ChequeVacances' | 'OnlinePayment' | 'CardCheck' | 'PaymentHubRedirection' | 'Voucher' | 'MasterCard' | 'Visa' | 'Amex' | 'Discover' | 'DinersClub' | 'Jcb' | 'UnionPay' | 'Twint' | 'Reka' | 'LoyaltyCard' | 'PosDiningAndSpaReward' | 'DirectDebit' | 'DepositCheck' | 'DepositCash' | 'DepositCreditCard' | 'DepositWireTransfer'

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 – deprecated, only for existing partners)

DepositWireTransfer (Deposit - wire transfer)

ExternalIdentifierstring nullable

Identifier of the payment from external system.

Notesstring nullable

Additional payment notes.

Response

OK

ExternalPaymentIdstring uuid

Unique identifier of the Payment item.