Get all payments
POST /api/connector/v1/payments/getAll
Returns all payments in the system, filtered by various parameters. At least one filter parameter must be specified. Note this operation uses Pagination and supports Portfolio Access Tokens.
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.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of specific Payment items. Required if no other filter is provided.
Unique identifiers of specific Accounts to which payments belong. Required if no other filter is provided.
Unique identifiers of specific Bill items to which payments are assigned. Required if no other filter is provided.
Unique identifiers of specific Reservations to which payments belong. Required if no other filter is provided.
Time interval during which the Payment was created. Required if no other filter is provided.
object
Time interval during which the Payment was updated. Required if no other filter is provided.
object
Time interval during which the Payment was charged. Required if no other filter is provided.
object
Time interval during which the Payment was closed. Required if no other filter is provided.
object
Interval in which the Payments were settled.
object
ISO-4217 code of the Currency the item costs should be converted to.
Accounting state of the item.
Payment state of the item.
Payment state of the item.
Payment
CreditCardPayment
AlternativePayment
CashPayment
InvoicePayment
ExternalPayment
GhostPayment
TaxDeductedPayment
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "PaymentIds": [ "f6313945-94c1-4e27-b402-031c2a8c989f", "be922eb7-bc5f-4877-b847-1120c0c2acd2" ], "AccountIds": [ "fadd5bb6-b428-45d5-94f8-fd0d89fece6d" ], "BillIds": [ "ea087d64-3901-4eee-b0b7-9fce4c58a005", "d23ac52f-9b86-4a03-a6fe-5822dfcfc5c4" ], "ReservationIds": [ "0f515589-99b4-423d-b83a-b237009f0509", "b7a3f5cb-1e69-4a5f-a069-10f461996d7f" ], "CreatedUtc": { "StartUtc": "2023-03-01T00:00:00Z", "EndUtc": "2023-03-31T00:00:00Z" }, "UpdatedUtc": { "StartUtc": "2023-03-01T00:00:00Z", "EndUtc": "2023-03-31T00:00:00Z" }, "ChargedUtc": { "StartUtc": "2023-03-01T00:00:00Z", "EndUtc": "2023-03-31T00:00:00Z" }, "ClosedUtc": { "StartUtc": "2023-03-01T00:00:00Z", "EndUtc": "2023-03-31T00:00:00Z" }, "SettlementUtc": { "StartUtc": "2023-03-01T00:00:00Z", "EndUtc": "2023-03-31T00:00:00Z" }, "Currency": "EUR", "AccountingStates": [ "Closed", "Open" ], "States": [ "Charged", "Pending" ], "Type": "Payment", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
The list of filtered payments.
object
Unique identifier of the payment.
Unique identifier of the Enterprise.
Unique identifier of the account (for example Customer) the payment belongs to.
Unique identifier of the Bill the payment is assigned to.
Unique identifier of the Reservation the payment belongs to.
Unique identifier of the AccountingCategory the payment belongs to.
Payment’s amount, negative amount represents either rebate or a payment.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Payment’s original amount, negative amount represents either rebate or a payment. Contains the earliest known value in conversion chain.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Additional notes.
Identifier of the settled payment from the external system (ApplePay/GooglePay).
Date and time of the item consumption in UTC timezone in ISO 8601 format.
Date and time of the payment bill closure in UTC timezone in ISO 8601 format.
Charged date and time of the payment in UTC timezone in ISO 8601 format.
Creation date and time of the payment created in UTC timezone in ISO 8601 format.
Last update date and time of the payment in UTC timezone in ISO 8601 format.
Date and time of the payment settlement in UTC timezone in ISO 8601 format.
Accounting state of the payment.
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 have been closed on a bill or invoice.)
Inactive (Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive.)
Canceled (Order items which have been canceled, regardless of whether the item is of zero value.)
Payment state of the payment.
Charged
Canceled
Pending
Failed
Verifying
Additional unique identifier of the payment.
Payment type, e.g. whether credit card or cash.
Payment
CreditCardPayment
AlternativePayment
CashPayment
InvoicePayment
ExternalPayment
GhostPayment
TaxDeductedPayment
Payment kind, e.g. whether payment or refund. Value provided only for payments processed by Mews Payments.
Payment
Chargeback
ChargebackReversal
Refund
Additional payment data.
object
Discriminator pointing to the fields within this object that contains additional data.
CreditCard
Invoice
External
Ghost
Contains additional data in the case of a card payment.
object
Unique identifier of the payment card.
The credit card payment transaction.
object
Unique identifier of the PaymentItem.
Identifier of the settlement.
Settlement date and time in UTC timezone in ISO 8601 format.
Transaction fee - this includes an estimate of bank charges.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Transaction fee (adjusted) - this is the final confirmed transaction fee, including confirmed bank charges.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Charged amount of the transaction.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Settled amount of the transaction.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Contains additional data in the case of an invoice payment.
object
Unique identifier of the invoice Bill.
Type of the invoice payment.
Receivable
Balancing
UnderpaymentBalancingReceivable
OverpaymentBalancingReceivable
Overpayment
Contains additional data in the case of an external payment.
object
Type of the external payment. *Except for enterprises based in the French Legal Environment. 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.
Contains additional data in the case of a ghost payment.
object
Unique identifier of the original payment.
Unique identifier of the last and hence oldest payment returned. This can be used in Limitation in a subsequent request to fetch the next batch of payments.
Example
{ "Payments": [ { "Id": "f6313945-94c1-4e27-b402-031c2a8c989f", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AccountId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f", "AccountType": "Company", "BillId": "ea087d64-3901-4eee-b0b7-9fce4c58a005", "ReservationId": "0f515589-99b4-423d-b83a-b237009f0509", "AccountingCategoryId": null, "Amount": { "Currency": "EUR", "NetValue": -3700, "GrossValue": -3700, "TaxValues": [], "Breakdown": { "Items": [ { "TaxRateCode": null, "NetValue": -3700, "TaxValue": 0 } ] } }, "OriginalAmount": { "Currency": "GBP", "NetValue": -3700, "GrossValue": -3700, "TaxValues": [], "Breakdown": { "Items": [ { "TaxRateCode": null, "NetValue": -3700, "TaxValue": 0 } ] } }, "Notes": null, "SettlementId": null, "ConsumedUtc": "2023-03-02T12:12:35Z", "ClosedUtc": null, "ChargedUtc": "2023-03-06T07:31:52Z", "CreatedUtc": "2023-03-06T07:31:51Z", "UpdatedUtc": "2023-03-06T07:31:53Z", "SettlementUtc": null, "AccountingState": "Open", "State": "Charged", "Identifier": "ch_764309db-4bcd-4f2c-ad6a-1c178089deec", "Type": "CreditCardPayment", "Kind": "Payment", "Data": { "Discriminator": "CreditCard", "CreditCard": { "CreditCardId": "c922266b-291d-4e25-9df7-afbd007c1991", "Transaction": null }, "Invoice": null, "External": null, "Ghost": null } }, { "Id": "be922eb7-bc5f-4877-b847-1120c0c2acd2", "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc", "AccountId": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d", "AccountType": "Customer", "BillId": "d23ac52f-9b86-4a03-a6fe-5822dfcfc5c4", "ReservationId": "b7a3f5cb-1e69-4a5f-a069-10f461996d7f", "AccountingCategoryId": null, "Amount": { "Currency": "EUR", "NetValue": -300, "GrossValue": -300, "TaxValues": [], "Breakdown": { "Items": [ { "TaxRateCode": null, "NetValue": -300, "TaxValue": 0 } ] } }, "OriginalAmount": { "Currency": "EUR", "NetValue": -300, "GrossValue": -300, "TaxValues": [], "Breakdown": { "Items": [ { "TaxRateCode": null, "NetValue": -300, "TaxValue": 0 } ] } }, "Notes": null, "SettlementId": null, "ConsumedUtc": "2023-03-02T12:12:35Z", "ClosedUtc": "2023-03-02T12:12:35Z", "ChargedUtc": "2023-03-02T12:12:32Z", "CreatedUtc": "2023-03-02T12:12:32Z", "UpdatedUtc": "2023-03-02T12:12:37Z", "SettlementUtc": null, "AccountingState": "Closed", "State": "Charged", "Identifier": "", "Type": "CashPayment", "Kind": "Payment", "Data": null } ], "Cursor": "be922eb7-bc5f-4877-b847-1120c0c2acd2"}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.