No results

GET/structures

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/structures
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/structures

Find structure in reversed chronological order.

PARAM HEADER
NAME DESCRIPTION FORMAT
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
Correlation-Id Unique identifier of the request. String
Format: uuid
Example: 4935e818-38e0-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
No param path
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

NAME DESCRIPTION FORMAT
No param body
Arrow RESPONSE 200
Success - No Header for this response
BODY
NAME DESCRIPTION FORMAT
structure Object containing the detail of the structure. Object
terminalId Merchant terminal identifier. String
Example: 99999998
structureId Structure identifier, unique in the merchant domain. String
Max. length: 36
Example: 99a172e5-423c-4648-9895-4cb5d1d43134
status Activation status of the structure. Possible values:
- ACTIVE
- NOT_ACTIVE
String
Example: ACTIVE
structureCreationDate The timestamp related to structure creation date. String
Example: 2022-08-01
structureName Structure name. String
Max. length: 255
Example: Casa Rubino
structureEmail E-mail connected to the structure. String
Max. length: 255
Example: mauro.morandi@nexi.it
mobilePhoneCountryCode Structure telephone number prefix. String
Max. length: 4
Example: 39
mobilePhone Structure telephone number. String
Max. length: 15
Example: 3280987654
checkInFromTime Check in from time to be intended as a local time of the structure. String
Example: 14:00
checkInToTime Check in to time to be intended as a local time of the structure. String
Example: 23:00
checkOutFromTime Check out from time to be intended as a local time of the structure. String
Example: 06:00
checkOutToTime Check in to time to be intended as a local time of the structure. String
Example: 10:00
tecGuaranteedPenaltyId Identification code of the terms and conditions associated with the structure for guaranteed reservation with penalty (reservationType = GUARANTEED_PENALTY). String
Example: b5c66332-3853-48c3-b5a7-a12678d6ca9c
tecGuaranteedNoShowId Identification code of the terms and conditions associated with the structure for guaranteed reservation (reservationType = GUARANTEED_NOSHOW). String
Example: b5c66332-3853-48c3-b5a7-a12678d6ca9c
tecRefundableId Identification code of the terms and conditions associated with the structure for refundable prepaid reservation (reservationType = PREPAID_REFUNDABLE). String
Example: b7b20af0-01e1-431d-bfbc-c41697720d1d
tecNotRefundableId Identification code of the terms and conditions associated with the structure for non-refundable prepaid reservation (reservationType = PREPAID_NOT_REFUNDABLE). String
Example: b28aaa05-ae84-40a2-9292-8006f176534b
customField Array containing custom fields linked to the structure. Array
customFieldId The unique identifier for custom field. String
Example: 0d0f3240-efd3-4c6b-b305-b8ec3bb7a99a
customFieldTitle The custom field name to be intend as title. String
Example: Animali domestici
customFieldTranslations Array containing the translations of the custom fields. Array
language Language to be used on the transaction summary details, ISO 639-2. String
Example: ENG
label Label of the field. String
Example: Pets
Arrow RESPONSE 404
Not found - No Header and Body for this response
Arrow RESPONSE 401
Unauthorized - No Header and Body for this response
Arrow RESPONSE 500
Internal Server Error - No Header for this response
BODY
NAME DESCRIPTION FORMAT
errors Array containing the errors list. The possible values are shown in the table Error codes. Array
code Error code. String
Example: GW0001
description Error description. String
Example: Invalid merchant URL