Mews
Mews Payments API

The Payments API from Mews — 5 operation(s) for payments.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.4
info:
  title: Mews Booking Engine API (Distributor) Account notes Payments API
  version: v1
  description: The Mews Booking Engine API (historically the Distributor API, served from /api/distributor/v1) lets developers build guest-facing booking engines that create reservations directly in Mews. It exposes enterprise configuration, availability, pricing, products, vouchers, payment cards, and reservation group creation for front-end client consumption.
  x-generated-from: documentation
  x-source-url: https://api.mews.com/Swagger/distributor/swagger.json
  x-last-validated: '2026-06-02'
servers:
- url: https://api.mews.com
  description: Production
- url: https://api.mews-demo.com
  description: Demo / sandbox
security:
- MewsClientToken: []
  MewsAccessToken: []
tags:
- name: Payments
paths:
  /api/connector/v1/payments/getAll:
    post:
      tags:
      - Payments
      summary: Mews Get All Payments
      description: Returns all payments in the system, filtered by various parameters. At least one filter parameter must be specified. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: payments_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentFilterParameters'
            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:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResult'
              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
        '400':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsGetAll400Example:
                  summary: Default payments_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsGetAll401Example:
                  summary: Default payments_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: 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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsGetAll403Example:
                  summary: Default payments_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: 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)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsGetAll408Example:
                  summary: Default payments_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsGetAll204Example:
                  summary: Default payments_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsGetAll429Example:
                  summary: Default payments_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsGetAll500Example:
                  summary: Default payments_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/connector/v1/payments/refund:
    post:
      tags:
      - Payments
      summary: Mews Refund Payment
      description: "Refunds a specified payment on a specified account. A reason must be provided. Optionally, specify an amount for a partial refund. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).\r\n                                                   \r\n* **Payment types**: Only `CreditCardPayment` and `AlternativePayment` can be refunded. Other payment types will fail.\r\n* **Refund information**: The refund is a payment itself. To get more information, use [Get all payments](https://mews-systems.gitbook.io/connector-api/operations/payments#get-all-payments) with the `RefundId` as the `PaymentId`.\r\n* **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 [Get all payments](https://mews-systems.gitbook.io/connector-api/operations/payments#get-all-payments)."
      operationId: payments_refund
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRefundParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              PaymentId: f6313945-94c1-4e27-b402-031c2a8c989f
              AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d
              Reason: Sample reason
              ValueToRefund: 110.5
              EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRefundResult'
              example:
                PaymentId: f6313945-94c1-4e27-b402-031c2a8c989f
                RefundId: 1d65c488-111a-4719-b3ea-e1a9969c6069
                Type: CreditCardPayment
                Amount:
                  Currency: GBP
                  Value: 100.0
                State: Pending
        '400':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsRefund400Example:
                  summary: Default payments_refund 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsRefund401Example:
                  summary: Default payments_refund 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: 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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsRefund403Example:
                  summary: Default payments_refund 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: 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)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsRefund408Example:
                  summary: Default payments_refund 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsRefund204Example:
                  summary: Default payments_refund 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsRefund429Example:
                  summary: Default payments_refund 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsRefund500Example:
                  summary: Default payments_refund 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/connector/v1/payments/addCreditCard:
    post:
      tags:
      - Payments
      summary: Mews Add Credit Card Payment
      description: "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. \nThe bill can then be closed manually by a Mews user, or automatically via API with the [Close bill](https://mews-systems.gitbook.io/connector-api/operations/bills/#close-bill) operation."
      operationId: payments_addCreditCard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditCardPaymentParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98
              Amount:
                Currency: GBP
                GrossValue: 100
              CreditCard:
                Type: Visa
                Number: 411111******1111
                Expiration: 12/2016
                Name: John Smith
              AccountingCategoryId: null
              ReceiptIdentifier: '123456'
              Notes: Terminal A
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCreditCardResult'
              example:
                CreditCardId: ee2209ce-71c6-4e3a-978f-aac700c82c7b
        '400':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddCreditCard400Example:
                  summary: Default payments_addCreditCard 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddCreditCard401Example:
                  summary: Default payments_addCreditCard 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: 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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddCreditCard403Example:
                  summary: Default payments_addCreditCard 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: 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)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddCreditCard408Example:
                  summary: Default payments_addCreditCard 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddCreditCard204Example:
                  summary: Default payments_addCreditCard 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddCreditCard429Example:
                  summary: Default payments_addCreditCard 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddCreditCard500Example:
                  summary: Default payments_addCreditCard 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/connector/v1/payments/addExternal:
    post:
      tags:
      - Payments
      summary: Mews Add External Payment
      description: "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 [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).\r\n\r\n**Prerequisites:** The external payment type must be enabled by the property in order to accept such payments in their Mews environment. Use [Get configuration](https://mews-systems.gitbook.io/connector-api/operations/configuration#get-configuration) to check which external payment types are supported."
      operationId: payments_addExternal
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalPaymentParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              AccountId: 35d4b117-4e60-44a3-9580-c582117eff98
              EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              Amount:
                Currency: GBP
                GrossValue: 100
              ExternalIdentifier: b06de5e4-7137-47ec-8a49-3303131b02c0
              Type: Cash
              AccountingCategoryId: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddExternalPaymentResult'
              example:
                ExternalPaymentId: 4ee05b77-ae21-46e8-8418-ac1c009dfb2b
        '400':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddExternal400Example:
                  summary: Default payments_addExternal 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                PaymentsAddExternal401Example:
                  summary: Default payments_addExternal 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: 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.
          content:
            application/json:
              schema:
                $ref: '#/com

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mews-systems/refs/heads/main/openapi/mews-systems-payments-api-openapi.yml
Mews Payments API

Documentation

Specifications

Other Resources

OpenAPI Specification
