Skip to content

Get all preauthorizations by customers

POST
/api/connector/v1/preauthorizations/getAllByCustomers

Returns all preauthorizations of specified customers.

MultipleCustomerParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
CustomerIds
required

Unique identifier of the Customer.

Array<string>
>= 1 items <= 1000 items
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"CustomerIds": [
"e98995b0-140a-4208-bbeb-b77f2c43d6ee"
]
}

OK

PreauthorizationResult
object
Preauthorizations

Preauthorizations of the specified Customers.

Array<object>
nullable
Preauthorization
object
Id

Unique identifier of the preauthorization.

string format: uuid
CustomerId
string format: uuid
CreditCardId

Unique identifier of the credit card.

string format: uuid
nullable
Amount
Amount
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
State

State of the preauthorization.

string
nullable
Code

Code of the preauthorization.

string
nullable
IsActive
boolean
Example
{
"Preauthorizations": [
{
"Amount": {
"Currency": "EUR",
"NetValue": null,
"GrossValue": 10,
"TaxValues": []
},
"Code": null,
"CreditCardId": "e417dfe8-c813-4938-837b-36081199ce88",
"CustomerId": "20725048-b6ec-40f0-9d0a-7e5273d8b861",
"Id": "2d93962f-067f-45a6-b7c4-bc4b9d899456",
"IsActive": false,
"State": "Cancelled"
},
{
"Amount": {
"Currency": "EUR",
"NetValue": null,
"GrossValue": 22,
"TaxValues": []
},
"Code": null,
"CreditCardId": "41fa39ab-4b12-4816-95a3-d06cdbbdcb69",
"CustomerId": "20725048-b6ec-40f0-9d0a-7e5273d8b861",
"Id": "ad44411a-1efc-46b6-b903-ec5fa7842000",
"IsActive": true,
"ReceiptIdentifier": null,
"SequenceCode": null,
"State": "Charged"
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable