No results

POST/structure_conditions

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

Create terms and conditions defined for a unique structure.

PARAM HEADER
NAME DESCRIPTION FORMAT
Correlation-Id Mandatory field in UUID v4 format.
The purpose of this field is to trace the request across different systems, making debugging and request tracking easier.
 String
Format: uuid
Example: 123e4567-e89b-12d3-a456-426614174000
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
No param path
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

structureConditionRequest

NAME DESCRIPTION FORMAT
name Free label to let the merchant identify the termsAndConditions.
 String
Max. length: 255
reservationType Possible values:
- PREPAID_REFUNDABLE: reservation is paid in advace for the service that will be provided and it can be refundable.
- PREPAID_NOT_REFUNDABLE: reservation is paid in advace for the service that will be provided and it can not be refundable.
- GUARANTEED_NOSHOW: reservation, through a card verification without charge to the customer. If the customer does not show up at the property, it is possible to charge the cost of the first night of stay.
- GUARANTEED_PENALTY: reservation, through a card verification without charge to the customer. An automatic charge of the predetermined penalty is made in case a guest does not show up at the property.
- BUNDLE: booking of a package containing several services provided by the same structure, for example stay + excursion + restaurant + tourist bus.
 String
structureId Structure identifier unique in the merchant domain.
 String
Max. length: 36
termsAndConditions Array of terms and conditions in multiple languages.
 Array
checkMarkLabelCancellationCondition Text to be showed beside the checkmark of acceptance of the cancellation terms.
 String
checkMarkLabelStructureCondition Text to be showed beside the checkmark of acceptance.
 String
language Language in ISO 639-2 three-letter code. String
Min. length: 3
Max. length: 3
Default: ITA
Example: ENG
linkLabelCancellationCondition Text of the hyperlink of the cancellation terms detailed text.
 String
linkLabelStructureCondition Text of the hyperlink of the T&C detailed text.
 String
textCancellationCondition Text of the cancellation terms and conditions in html format, encoded in Base64.
 String
textStructureCondition Text of the terms and conditions in html format, encoded in Base64.
 String
Arrow RESPONSE 200
Terms and conditions created - No Header for this response
BODY
NAME DESCRIPTION FORMAT
structureConditionId Unique identifier of terms and conditions of the structure.
 String
Arrow RESPONSE 201
Created - No Header and Body for this response
Arrow RESPONSE 401
Unauthorized - No Header and Body for this response
Arrow RESPONSE 403
Forbidden - No Header and Body for this response
Arrow RESPONSE 404
Not Found - No Header and Body for this response