Mews · Example Payload

Mews Payments Getall Example

HospitalityHotelsPMSProperty Management

Mews Payments Getall Example is an example object payload from Mews, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "payments_getAll",
  "method": "POST",
  "path": "/api/connector/v1/payments/getAll",
  "summary": "Get all payments",
  "requestExamples": [
    {
      "contentType": "application/json",
      "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
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Payments": [
          {
            "Id": "f6313945-94c1-4e27-b402-031c2a8c989f",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "AccountId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
            "AccountType": "Company",
            "PaymentRequestId": "bcc76295-4e47-4cf1-a7cb-afae00bd1c35",
            "BillId": "ea087d64-3901-4eee-b0b7-9fce4c58a005",
            "ReservationId": "0f515589-99b4-423d-b83a-b237009f0509",
            "AccountingCategoryId": null,
            "Amount": {
              "Currency": "EUR",
              "NetValue": -3700.0,
              "GrossValue": -3700.0,
              "TaxValues": [],
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": -3700.0,
                    "TaxValue": 0.0
                  }
                ]
              }
            },
            "OriginalAmount": {
              "Currency": "GBP",
              "NetValue": -3700.0,
              "GrossValue": -3700.0,
              "TaxValues": [],
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": -3700.0,
                    "TaxValue": 0.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,
              "Alternative": null
            },
            "PaymentOrigin": "Terminal"
          },
          {
            "Id": "be922eb7-bc5f-4877-b847-1120c0c2acd2",
            "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
            "AccountId": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d",
            "AccountType": "Customer",
            "PaymentRequestId": "6282d17b-a068-4a9f-83d3-afae00c39bfb",
            "BillId": "d23ac52f-9b86-4a03-a6fe-5822dfcfc5c4",
            "ReservationId": "b7a3f5cb-1e69-4a5f-a069-10f461996d7f",
            "AccountingCategoryId": null,
            "Amount": {
              "Currency": "EUR",
              "NetValue": -300.0,
              "GrossValue": -300.0,
              "TaxValues": [],
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": -300.0,
                    "TaxValue": 0.0
                  }
                ]
              }
            },
            "OriginalAmount": {
              "Currency": "EUR",
              "NetValue": -300.0,
              "GrossValue": -300.0,
              "TaxValues": [],
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": -300.0,
                    "TaxValue": 0.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,
            "PaymentOrigin": "PointOfSales"
          },
          {
            "Id": "a3e7f291-6c4d-4b8a-9f12-1d3e5c7b9a01",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "AccountId": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d",
            "AccountType": "Customer",
            "PaymentRequestId": null,
            "BillId": "ea087d64-3901-4eee-b0b7-9fce4c58a005",
            "ReservationId": "0f515589-99b4-423d-b83a-b237009f0509",
            "AccountingCategoryId": null,
            "Amount": {
              "Currency": "EUR",
              "NetValue": -500.0,
              "GrossValue": -500.0,
              "TaxValues": [],
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": -500.0,
                    "TaxValue": 0.0
                  }
                ]
              }
            },
            "OriginalAmount": {
              "Currency": "EUR",
              "NetValue": -500.0,
              "GrossValue": -500.0,
              "TaxValues": [],
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": -500.0,
                    "TaxValue": 0.0
                  }
                ]
              }
            },
            "Notes": null,
            "SettlementId": null,
            "ConsumedUtc": null,
            "ClosedUtc": null,
            "ChargedUtc": null,
            "CreatedUtc": "2023-03-06T09:00:00Z",
            "UpdatedUtc": "2023-03-06T09:00:01Z",
            "SettlementUtc": null,
            "AccountingState": "Open",
            "State": "Pending",
            "Identifier": null,
            "Type": "AlternativePayment",
            "Kind": "Payment",
            "Data": {
              "Discriminator": "Alternative",
              "CreditCard": null,
              "Invoice": null,
              "External": null,
              "Ghost": null,
              "Alternative": {
                "Type": "WireTransfer"
              }
            },
            "PaymentOrigin": "System"
          }
        ],
        "Cursor": "a3e7f291-6c4d-4b8a-9f12-1d3e5c7b9a01"
      }
    }
  ]
}