Connector API
Search…
Preauthorizations

Get all preauthorizations by customers

Returns all preauthorizations of specified customers.

Request

[PlatformAddress]/api/connector/v1/preauthorizations/getAllByCustomers
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"CustomerIds": [
6
"e98995b0-140a-4208-bbeb-b77f2c43d6ee"
7
]
8
}
Copied!
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.
CustomerIds
array of string
required, max 1000 items
Unique identifier of the Customer.

Response

1
{
2
"Preauthorizations": [
3
{
4
"Amount": {
5
"Currency": "EUR",
6
"NetValue": null,
7
"GrossValue": 10,
8
"TaxValues": []
9
},
10
"Code": null,
11
"CreditCardId": "e417dfe8-c813-4938-837b-36081199ce88",
12
"CustomerId": "20725048-b6ec-40f0-9d0a-7e5273d8b861",
13
"Id": "2d93962f-067f-45a6-b7c4-bc4b9d899456",
14
"IsActive": false,
15
"State": "Cancelled"
16
},
17
{
18
"Amount": {
19
"Currency": "EUR",
20
"NetValue": null,
21
"GrossValue": 22,
22
"TaxValues": []
23
},
24
"Code": null,
25
"CreditCardId": "41fa39ab-4b12-4816-95a3-d06cdbbdcb69",
26
"CustomerId": "20725048-b6ec-40f0-9d0a-7e5273d8b861",
27
"Id": "ad44411a-1efc-46b6-b903-ec5fa7842000",
28
"IsActive": true,
29
"ReceiptIdentifier": null,
30
"SequenceCode": null,
31
"State": "Charged"
32
}
33
]
34
}
Copied!
Property
Type
Contract
Description
Preauthorizations
array of Preauthorization
required
Preauthorizations of the specified Customers.

Preauthorization

Property
Type
Contract
Description
Id
string
required
Unique identifier of the preauthorization.
CreditCardId
string
required
Unique identifier of the credit card.
Amount
required
Value of the preauthorization.
State
required
State of the preauthorization.
Code
string
optional
Code of the preauthorization.

Preauthorization state

  • Chargeable - Created and prepared for the charging.
  • Expired - A preauthorization that is not charged and expired.
  • Cancelled - A preauthorization that was canceled before charging.
  • Charged - Charged preauthorization.
Last modified 3mo ago