Payments
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all payments in the system, filtered by various parameters. At least one filter parameter must be specified. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/payments/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
PaymentIds
array of string
optional, max 1000 items
Unique identifiers of specific Payment
items. Required if no other filter is provided.
AccountIds
array of string
optional, max 100 items
Unique identifiers of specific Accounts
to which payments belong. Required if no other filter is provided.
BillIds
array of string
optional, max 1000 items
Unique identifiers of specific Bill
items to which payments are assigned. Required if no other filter is provided.
ReservationIds
array of string
optional, max 1000 items
Unique identifiers of specific Reservations
to which payments belong. Required if no other filter is provided.
CreatedUtc
optional, max length 3 months
Time interval during which the Payment
was created. Required if no other filter is provided.
UpdatedUtc
optional, max length 3 months
Time interval during which the Payment
was updated. Required if no other filter is provided.
ChargedUtc
optional, max length 3 months
Time interval during which the Payment
was charged. Required if no other filter is provided.
ClosedUtc
optional, max length 3 months
Time interval during which the Payment
was closed. Required if no other filter is provided.
SettlementUtc
optional, max length 3 months
Interval in which the Payments
were settled.
Currency
string
optional
ISO-4217 code of the Currency
the item costs should be converted to.
AccountingStates
optional
Accounting state of the item.
States
optional
Payment state of the item.
Type
optional
Payment state of the item.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Charged
Canceled
Pending
Failed
Verifying
Payments
required, max 1000 items
The list of filtered payments.
Cursor
string
optional
Id
string
required
Unique identifier of the payment.
EnterpriseId
string
required
Unique identifier of the Enterprise
.
AccountId
string
required
Unique identifier of the account (for example Customer
) the payment belongs to.
AccountType
required
A discriminator specifying the account type, e.g. Customer
or Company
.
BillId
string
optional
Unique identifier of the Bill
the payment is assigned to.
ReservationId
string
optional
Unique identifier of the Reservation
the payment belongs to.
AccountingCategoryId
string
optional
Unique identifier of the AccountingCategory
the payment belongs to.
Amount
required
Payment's amount, negative amount represents either rebate or a payment.
OriginalAmount
required
Payment's original amount, negative amount represents either rebate or a payment. Contains the earliest known value in conversion chain.
Notes
string
optional
Additional notes.
SettlementId
string
optional
Identifier of the settled payment from the external system (ApplePay/GooglePay).
ConsumedUtc
string
optional
Date and time of the item consumption in UTC timezone in ISO 8601 format.
ClosedUtc
string
optional
Date and time of the payment bill closure in UTC timezone in ISO 8601 format.
ChargedUtc
string
optional
Charged date and time of the payment in UTC timezone in ISO 8601 format.
CreatedUtc
string
required
Creation date and time of the payment created in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the payment in UTC timezone in ISO 8601 format.
SettlementUtc
string
required
Date and time of the payment settlement in UTC timezone in ISO 8601 format.
AccountingState
required
Accounting state of the payment.
State
required
Payment state of the payment.
Identifier
string
optional
Additional unique identifier of the payment.
Type
required
Payment type, e.g. whether credit card or cash.
Kind
optional
Payment kind, e.g. whether payment or refund. Value provided only for payments processed by Mews Payments.
Data
optional
Additional payment data.
Charged
Canceled
Pending
Failed
Verifying
Payment
CreditCardPayment
AlternativePayment
CashPayment
InvoicePayment
ExternalPayment
GhostPayment
TaxDeductedPayment
Payment
Chargeback
ChargebackReversal
Refund
Discriminator
required
Discriminator pointing to the fields within this object that contains additional data.
CreditCard
optional
Contains additional data in the case of a card payment.
Invoice
optional
Contains additional data in the case of an invoice payment.
External
optional
Contains additional data in the case of an external payment.
Ghost
optional
Contains additional data in the case of a ghost payment.
CreditCard
Invoice
External
Ghost
CreditCardId
string
optional
Unique identifier of the payment card.
Transaction
optional
The credit card payment transaction.
PaymentId
string
required
Unique identifier of the PaymentItem
.
SettlementId
string
optional
Identifier of the settlement.
SettledUtc
string
optional
Settlement date and time in UTC timezone in ISO 8601 format.
Fee
optional
Transaction fee - this includes an estimate of bank charges.
AdjustedFee
optional
Transaction fee (adjusted) - this is the final confirmed transaction fee, including confirmed bank charges.
ChargedAmount
required
Charged amount of the transaction.
SettledAmount
optional
Settled amount of the transaction.
InvoiceId
string
optional
Unique identifier of the invoice Bill
.
Type
required
Type of the invoice payment.
Receivable
Balancing
UnderpaymentBalancingReceivable
OverpaymentBalancingReceivable
Overpayment
Type
required
Type of the external payment. *Except for enterprises based in the French Legal Environment. Unspecified
is considered as fraud.
ExternalIdentifier
string
optional
Identifier of the payment from external system.
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
Prepayment
- Prepayment
Cheque
- Cheque
Bancontact
- Bancontact
IDeal
- iDeal
PayPal
- PayPal
GiftCard
- Gift card
LoyaltyPoints
- Loyalty points
ChequeVacances
- Chèque-Vacances
OnlinePayment
- Online payment
CardCheck
- Card check
PaymentHubRedirection
- Payment hub redirection
Voucher
- Voucher
MasterCard
- MasterCard
Visa
- Visa
Amex
- American Express
Discover
- Discover
DinersClub
- Diners Club
Jcb
- JCB
UnionPay
- UnionPay
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
OriginalPaymentId
string
required
Unique identifier of the original payment.
[PlatformAddress]/api/connector/v1/payments/addExternal
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
AccountId
string
required
BillId
string
optional
Unique identifier of an open bill of the customer where to assign the payment.
AccountingCategoryId
string
optional
ReservationId
string
optional
Unique identifier of the reservation the payment belongs to.
Amount
required
Amount of the external card payment.
Type
optional
Type of the external payment. (Required for the enterprises based in the French Legal Environment where Unspecified
is considered as fraud.)
ExternalIdentifier
string
optional
Identifier of the payment from external system.
Notes
string
optional
Additional payment notes.
CustomerId
string
optional
ExternalPaymentId
string
required
[PlatformAddress]/api/connector/v1/payments/addCreditCard
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
BillId
string
optional
Unique identifier of an open bill of the customer where to assign the payment.
AccountingCategoryId
string
optional
ReservationId
string
optional
Unique identifier of the reservation the payment belongs to.
Amount
required
Amount of the credit card payment.
Notes
string
optional
Additional payment notes.
CustomerId
string
required
CreditCard
required
ReceiptIdentifier
string
optional
Identifier of the payment receipt.
Type
string
required
Type of the credit card, one of: Visa
, MasterCard
, Amex
, Discover
, DinersClub
, Jcb
, EnRoute
, Maestro
, UnionPay
.
Number
string
required
Obfuscated credit card number. At most first six digits and last four digits can be specified, the digits in between should be replaced with *
. It is possible to provide even more obfuscated number or just last four digits. Never provide full credit card number. For example 411111******1111
.
Expiration
string
optional
Expiration of the credit card in format MM/YYYY
, e.g. 12/2016
or 04/2017
.
Name
string
required
Name of the card holder.
CreditCardId
string
required
Adds a new alternative payment to a specified customer.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.
[PlatformAddress]/api/connector/v1/payments/addAlternative
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
CustomerId
string
required
Amount
required
Price of the product that overrides the price defined in Mews.
ReservationId
string
optional
Unique identifier of the reservation the payment belongs to.
Data
required
Data specific to particular alternative payment method.
Method
required
Payment method to use for the alternative payment. Deprecated! Use Data
instead.
RedirectUrl
string
optional
URL where the customer will be redirected after completing their payment. Deprecated! Pass redirect URL to relevant method in Data
instead.
Ideal
ApplePay
GooglePay
Discriminator
required
Type of alternative payment method (e.g. Ideal
).
SepaDirectDebit
optional
SEPA Direct Debit payment method data. Required when Discriminator
is SepaDirectDebit
.
Ideal
optional
iDEAL payment method data. Required when Discriminator
is Ideal
.
Ideal
- iDEAL data.
ApplePay
- No additional data.
GooglePay
- No additional data.
SepaDirectDebit
- SEPA Direct Debit data.
Iban
string
required
The customer's bank account number in IBAN format.
Name
string
required
Full name of the customer.
Email
string
required
Email address of the customer.
UserAgent
string
required
The user agent of the browser from which the Mandate was accepted by the customer.
RemoteIpAddress
string
required
The IP address from which the Mandate was accepted by the customer.
RedirectUrl
string
required
URL where the customer will be redirected after completing their iDEAL payment.
PaymentId
string
required
Unique identifier of the created payment.
NextAction
optional
Next action to take in order to complete the payment.
Discriminator
required
Determines type of value.
Value
string
required
String value depending on Type
.
RedirectToUrl
- Redirect customer to a URL where they can complete their payment.
Payment types: Only CreditCardPayment
and AlternativePayment
can be refunded. Other payment types will fail.
[PlatformAddress]/api/connector/v1/payments/refund
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
PaymentId
string
required
AccountId
string
required
Reason
string
required
Refund reason.
ValueToRefund
number
optional
Refund amount. If not provided, the whole payment will be refunded.
PaymentId
string
required
RefundId
string
required
Unique identifier of refund.
Type
required
Type of refund.
Amount
required
Absolute value of the fee.
State
required
Payment state of the refund.
CreditCardPayment
AlternativePayment
array of
array of
array of
Unique identifier of the last and hence oldest payment returned. This can be used in in a subsequent request to fetch the next batch of payments.
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 .
Prerequisites: The external payment type must be enabled by the property in order to accept such payments in their Mews environment. Use to check which external payment types are supported.
Unique identifier of the enterprise. Required when using , ignored otherwise.
Unique identifier of the or . Company billing may not be enabled for your integration.
Unique identifier of an to be assigned to the external payment.
Unique identifier of the . Deprecated! Deprecated! Use AccountId
.
Unique identifier of the .
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. The bill can then be closed manually by a Mews user, or automatically via API with the operation.
Unique identifier of an to be assigned to the credit card payment.
Unique identifier of the .
Unique identifier of the .
Unique identifier of the .
Refunds a specified payment on a specified account. A reason must be provided. Optionally, specify an amount for a partial refund. This operation supports .
Refund information: The refund is a payment itself. To get more information, use with the RefundId
as the PaymentId
.
Potential failures: This operation initiates the refund process, but refunds can fail if the payment is in a Pending
state and fails processing. To check the status of a pending payment, including refunds, use .
Unique identifier of the enterprise. Required when using , ignored otherwise.
Unique identifier of specific .
Unique identifier of the account (for example ) the payment belongs to.
Unique identifier of specific .