---
title: "Add payment requests"
method: POST
path: "/api/connector/v1/paymentRequests/add"
tags: ["Payment requests"]
---

# Add payment requests

`POST /api/connector/v1/paymentRequests/add`

Creates a payment request to the specified [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).

## Request body

- MultiplePaymentRequestAddParameters
  - `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, uuid, nullable — Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
  - `PaymentRequests` PaymentRequestAddParameters[], required — Payment requests to be added.
    - `AccountId` string, uuid, required — Unique identifier of the `Customer` account to which the payment request is issued.
    - `Amount` CurrencyValue, required — Absolute value of the fee.
      - `Currency` string, currency, required — ISO-4217 code of the `Currency`.
      - `Value` number, double, required — Amount in the currency.
    - `Type` 'Payment' | 'Preauthorization', required — A payment request type.
    - `Reason` 'Other' | 'PaymentCardMissing' | 'PaymentCardDeclined' | 'Deposit' | 'Prepayment' | 'Fee' | 'RecurringPayment', required — A payment request reason.
    - `ExpirationUtc` string, date-time, required — Date and time of the payment request's expiration in ISO 8601 format.
    - `Description` string, required — Description of the payment request.
    - `Notes` string, nullable — Payment request's notes.
    - `ReservationId` string, uuid, nullable — Unique identifier of the `Reservation` the payment request belongs to.
    - `BillId` string, uuid, nullable — Unique identifier of the `Bill` the payment request is linked to.
  - `SendPaymentRequestEmails` boolean, nullable — Specifies whether a payment request email is sent to the customer. Defaults to `true`.

## Response `200`

OK

- PaymentRequestAdditionResult
  - `PaymentRequests` PaymentRequest[], required — The added payment requests.
    - `Id` string, uuid, required — Unique identifier of the payment request.
    - `EnterpriseId` string, uuid, required — Unique identifier of the `Enterprise`.
    - `AccountId` string, uuid, required — Unique identifier of the `Customer` to which the payment request was issued.
    - `CustomerId` string, uuid, nullable — Unique identifier of the `Customer` to which the payment request was issued.
    - `ReservationGroupId` string, uuid, nullable — Unique identifier of the `ReservationGroup`.
    - `ReservationId` string, uuid, nullable — Unique identifier of the `Reservation` the payment request belongs to.
    - `State` 'Pending' | 'Completed' | 'Canceled' | 'Expired', required — A payment request state.
    - `Amount` Amount, required
      - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency).
      - `NetValue` number, double, required — Net value without taxes.
      - `GrossValue` number, double, required — Gross value including all taxes.
      - `TaxValues` TaxValue[], required — The tax values applied.
        - `Code` string, nullable — Code corresponding to tax type.
        - `Value` number, double, required — Amount of tax applied.
      - `Breakdown` TaxBreakdown, required
        - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied.
          - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts.
          - `NetValue` number, double, required — The net value that the tax is calculated from.
          - `TaxValue` number, double, required — The value of the tax.
    - `Type` 'Payment' | 'Preauthorization', required — A payment request type.
    - `Reason` 'Other' | 'PaymentCardMissing' | 'PaymentCardDeclined' | 'Deposit' | 'Prepayment' | 'Fee' | 'RecurringPayment', required — A payment request reason.
    - `ExpirationUtc` string, date-time, required — Date and time of the payment request's expiration in ISO 8601 format.
    - `Description` string, required — Description of the payment request.
    - `Notes` string, nullable — Payment request's notes.
    - `CreatedUtc` string, date-time, required — Creation date and time of the payment request in UTC timezone in ISO 8601 format.
    - `UpdatedUtc` string, date-time, required — Last update date and time of the payment request in UTC timezone in ISO 8601 format.

## 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/versions/81933a8ff730/schema)