Get all payment requests
POST /api/connector/v1/paymentRequests/getAll
Get all payment requests belonging to the specified customer accounts. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of the requested Payment requests.
Unique identifiers of Customer accounts to which payment requests were issued.
object
A list of payment request states to filter by.
Example
{ "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" ], "UpdatedUtc": { "StartUtc": "2020-01-05T00:00:00Z", "EndUtc": "2020-01-10T00:00:00Z" }, "States": [ "Pending", "Expired" ], "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
The filtered payment requests.
object
Unique identifier of the payment request.
Unique identifier of the Enterprise.
Unique identifier of the Customer to which the payment request was issued.
Unique identifier of the Reservation group.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Date and time of the payment request’s expiration in ISO 8601 format.
Description of the payment request.
Payment request’s notes.
Creation date and time of the payment request in UTC timezone in ISO 8601 format.
Last update date and time of the payment request in UTC timezone in ISO 8601 format.
Unique identifier of the last and hence oldest payment request returned. This can be used in Limitation in a subsequent request to fetch the next batch of older payment requests.
Example
{ "PaymentRequests": [ { "Id": "bcc76295-4e47-4cf1-a7cb-afae00bd1c35", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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": "PaymentCardDeclined", "ExpirationUtc": "2023-02-23T23:00:00Z", "Description": "Payment required.", "Notes": null } ], "Cursor": "bcc76295-4e47-4cf1-a7cb-afae00bd1c35"}Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.