---
title: "Get all payment policies"
method: POST
path: "/api/connector/v1/paymentPolicies/getAll"
tags: ["Payment policies"]
---

# Get all payment policies

`POST /api/connector/v1/paymentPolicies/getAll`

Returns all payment policies matching the specified filter parameters. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).

## Request body

- PaymentPolicyFilterParameters
  - `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.
  - `Limitation` Limitation, required — Limitation on the quantity of data returned.
    - `Count` integer, required
    - `Cursor` string, uuid, nullable
  - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
  - `PaymentPolicyIds` string[], nullable — Unique identifiers of the payment policies.
  - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.
    - `StartUtc` string, date-time, nullable
    - `EndUtc` string, date-time, nullable
  - `ActivityStates` ActivityStates[], nullable — Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.

## Response `200`

OK

- PaymentPolicyResult
  - `PaymentPolicies` PaymentPolicy[], required — The payment policies.
    - `Id` string, uuid, required — Unique identifier of the payment policy.
    - `EnterpriseId` string, uuid, required — Unique identifier of the enterprise the payment policy belongs to.
    - `CreatedUtc` string, date-time, required — Date and time of the payment policy creation in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Date and time of the last update of the payment policy in UTC timezone in ISO 8601 format.
    - `SettlementAction` 'ChargeCreditCard' | 'CreatePreauthorization', required — ChargeCreditCard (The amount is charged to the credit card.) CreatePreauthorization (An authorization hold is placed on the credit card without charging it.)
    - `SettlementTrigger` 'Confirmation' | 'Start' | 'End' | 'StartDate' | 'EndDate', required — Confirmation (Settlement is triggered when the reservation is confirmed.) Start (Settlement is triggered at the start of the reservation.) End (Settlement is triggered at the end of the reservation.) StartDate (Settlement is triggered on a specific date before the reservation start date.) EndDate (Settlement is triggered on a specific date before the reservation end date.)
    - `SettlementType` 'Manual' | 'Automatic', required — Manual (Mews creates a task for hotel staff to initiate the settlement manually from the Mews UI. The integration is not the executor.) Automatic (Mews automatically processes the settlement at the trigger moment without any human intervention.)
    - `SettlementOffset` string, required — ISO 8601 duration offset applied relative to the settlement trigger.
    - `RelativeValue` number, double, nullable — Relative portion of the total amount to settle, expressed as a fraction of 1 (e.g. `0.5` means 50%). Non-null when the policy is relative; null when absolute.
    - `AbsoluteValue` CurrencyValue — Absolute value of the fee.
      - `Currency` string, currency, required — ISO-4217 code of the `Currency`.
      - `Value` number, double, required — Amount in the currency.
    - `IsActive` boolean, required — Whether the payment policy is still active.
    - `Name` string, nullable — Name of the payment policy. Null when not defined.
  - `Cursor` string, uuid, nullable — Pagination cursor for retrieving the next page of results. Null if there are no more results.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — 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).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — 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.
- `408` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500` — 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](https://github.com/MewsSystems/gitbook-connector-api).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/f37f136ed35a/schema)