Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all payment requests
  • Request
  • Response
  • Add payment requests
  • Request
  • Response
  • Cancel payment requests
  • Request
  • Response

Was this helpful?

  1. API Operations

Payment requests

PreviousPaymentsNextPreauthorizations

Last updated 4 months ago

Was this helpful?

Get all payment requests

Get all payment requests belonging to the specified customer accounts. Note this operation uses and supports .

Request

[PlatformAddress]/api/connector/v1/paymentRequests/getAll

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "4d0201db-36f5-428b-8d11-4f0a65e960cc"
    ],
    "PaymentRequestIds": [
        "bcc76295-4e47-4cf1-a7cb-afae00bd1c35"
    ],
    "AccountIds": [
        "8466DFDD-0964-4002-8719-AFA900D0F1BA"
    ],
    "ReservationIds": 
    [
        "9e6d4492-315b-4089-b9d6-5b1bd2eddc1b"
    ],
    "UpdatedUtc": {
        "StartUtc": "2020-01-05T00:00:00Z",
        "EndUtc": "2020-01-10T00:00:00Z"
    },
    "States": [ "Pending", "Expired" ],
    "Limitation": { "Count": 10 }
}
Property
Type
Contract
Description

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.

EnterpriseIds

array of string

optional, max 1000 items

PaymentRequestIds

string

optional, max 1000 items

AccountIds

array of string

optional, max 1000 items

ReservationIds

array of string

optional, max 1000 items

UpdatedUtc

optional, max length 3 months

States

optional

A list of payment request states to filter by.

Limitation

required

Limitation on the quantity of payment requests returned (using cursor pagination).

Response

{
    "PaymentRequests": [
        {
            "Id": "bcc76295-4e47-4cf1-a7cb-afae00bd1c35",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "AccountId": "8466dfdd-0964-4002-8719-afa900d0f1ba",
            "ReservationId": "9e6d4492-315b-4089-b9d6-5b1bd2eddc1b",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "ReservationGroupId": null,
            "State": "Pending",
            "Amount": {
                "Currency": "EUR",
                "NetValue": 10,
                "GrossValue": 10,
                "TaxValues": [],
                "Breakdown": {
                    "Items": [
                        {
                            "TaxRateCode": null,
                            "NetValue": 10,
                            "TaxValue": 0
                        }
                    ]
                }
            },
            "Type": "Payment",
            "Reason": "PaymentCardDeclined",
            "ExpirationUtc": "2023-02-23T23:00:00Z",
            "Description": "Payment required.",
            "Notes": null
        }
    ],
    "Cursor": "bcc76295-4e47-4cf1-a7cb-afae00bd1c35"
}
Property
Type
Contract
Description

PaymentRequests

required

The filtered payment requests.

Cursor

string

optional

Payment request

Property
Type
Contract
Description

Id

string

required

Unique identifier of the payment request.

EnterpriseId

string

required

AccountId

string

required

ReservationId

string

optional

CreatedUtc

string

required

Creation date and time of the payment request in UTC timezone in ISO 8601 format.

UpdatedUtc

string

required

Last update date and time of the payment request in UTC timezone in ISO 8601 format.

ReservationGroupId

string

optional

State

required

A payment request state.

Amount

required

Amount of the payment request.

Type

required

A payment request type.

Reason

required

A payment request reason.

ExpirationUtc

string

required

Date and time of the payment request's expiration in ISO 8601 format.

Description

string

required

Description of the payment request.

Notes

string

optional

Payment request's notes.

Payment request state

  • Pending - payment request is active and waiting for completion.

  • Completed - payment request was fulfilled.

  • Canceled - payment request was canceled.

  • Expired - payment request is past its expiration date and no longer active.

Payment request type

  • Payment - indicates that a payment is requested.

Payment request reason

  • PaymentCardMissing

  • PaymentCardDeclined

  • Prepayment

  • Fee

  • Other

  • ...

Add payment requests

Request

[PlatformAddress]/api/connector/v1/paymentRequests/add

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "PaymentRequests": [
        {
            "AccountId": "8466dfdd-0964-4002-8719-afa900d0f1ba",
            "Amount": {
                "Currency": "EUR",
                "Value": 10
            },
            "Type": "Payment",
            "Reason": "PaymentCardMissing",
            "ExpirationUtc": "2023-02-20T12:00:00.000Z",
            "Description": "Payment required",
            "ReservationId": "9e6d4492-315b-4089-b9d6-5b1bd2eddc1b",
            "Notes": "Internal notes."
        }
    ]
}
Property
Type
Contract
Description

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

optional

PaymentRequests

required, max 1000 items

Payment requests to be added.

Payment request parameters

Property
Type
Contract
Description

AccountId

string

required

Amount

required

Amount of the payment request.

Type

required

A payment request type.

Reason

required

A payment request reason.

ExpirationUtc

string

required

Date and time of the payment request's expiration in ISO 8601 format.

Description

string

required, max 1000 characters

Description of the payment request.

ReservationId

string

optional

Notes

string

optional, max 1000 characters

Payment request's notes.

Currency value

Property
Type
Contract
Description

Currency

string

required

Value

number

required

Amount in the currency.

Response

{
    "PaymentRequests": [
        {
            "Id": "6282d17b-a068-4a9f-83d3-afae00c39bfb",
            "AccountId": "8466dfdd-0964-4002-8719-afa900d0f1ba",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "ReservationGroupId": null,
            "State": "Pending",
            "Amount": {
                "Currency": "EUR",
                "NetValue": 10,
                "GrossValue": 10,
                "TaxValues": [],
                "Breakdown": {
                    "Items": [
                        {
                            "TaxRateCode": null,
                            "NetValue": 10,
                            "TaxValue": 0
                        }
                    ]
                }
            },
            "Type": "Payment",
            "Reason": "PaymentCardMissing",
            "ExpirationUtc": "2023-02-20T12:00:00Z",
            "Description": "Payment required",
            "ReservationId": "9e6d4492-315b-4089-b9d6-5b1bd2eddc1b",
            "Notes": "Internal notes."
        }
    ]
}
Property
Type
Contract
Description

PaymentRequests

required

Added payment requests.

Cancel payment requests

Cancels specified payment requests. Only payment requests which are in Pending state can be canceled.

Request

[PlatformAddress]/api/connector/v1/paymentRequests/cancel

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "PaymentRequestIds": [
        "6282d17b-a068-4a9f-83d3-afae00c39bfb"
    ]
}
Property
Type
Contract
Description

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.

PaymentRequestIds

array of string

required, max 1000 items

Identifiers of payment requests to be canceled.

Response

{
    "PaymentRequests": [
        {
            "Id": "6282d17b-a068-4a9f-83d3-afae00c39bfb",
            "AccountId": "8466dfdd-0964-4002-8719-afa900d0f1ba",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "ReservationGroupId": null,
            "State": "Canceled",
            "Amount": {
                "Currency": "EUR",
                "NetValue": 10,
                "GrossValue": 10,
                "TaxValues": [],
                "Breakdown": {
                    "Items": [
                        {
                            "TaxRateCode": null,
                            "NetValue": 10,
                            "TaxValue": 0
                        }
                    ]
                }
            },
            "Type": "Payment",
            "Reason": "PaymentCardMissing",
            "ExpirationUtc": "2023-02-20T12:00:00Z",
            "Description": "Payment required",
            "ReservationId": "9e6d4492-315b-4089-b9d6-5b1bd2eddc1b",
            "Notes": "Internal notes."
        }
    ]
}
Property
Type
Contract
Description

PaymentRequests

required

Canceled payment requests.

Unique identifiers of the . If not specified, the operation returns data for all enterprises within scope of the Access Token.

Unique identifiers of the requested .

Unique identifiers of accounts to which payment requests were issued.

Unique identifiers of specific to which payment requests belong.

Interval in which was updated.

array of

Unique identifier of the last and hence oldest payment request returned. This can be used in in a subsequent request to fetch the next batch of older payment requests.

Unique identifier of the .

Unique identifier of the to which the payment request was issued.

Unique identifier of the the payment request belongs to.

Unique identifier of the .

Preauthorization - indicates that a is requested.

Creates a payment request to the specified . Note this operation supports .

Unique identifier of the . Required when using a , ignored otherwise.

array of

Unique identifier of the account to which the payment request is issued.

Unique identifier of the the payment request belongs to.

ISO-4217 code of the .

array of

array of

Pagination
Portfolio Access Tokens
Reservation group
Payment requests
Payment request
Payment request state
Payment requests
Payment request state
Payment request type
Payment request reason
Payment request parameters
Currency value
Payment request type
Payment request reason
Payment requests
Payment requests
Portfolio Access Tokens
Portfolio Access Token
Preauthorization
Limitation
Limitation
Currency
Amount value
Customer
Customer
Customer
Customer
Reservations
Reservation
Reservation
Enterprises
Enterprise
Enterprise
Time interval