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
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
structureId Structure identifier unique in the merchant domain. String
Max. length: 36
Example: 99a172e5-423c-4648-9895-4cb5d1d43134
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
Example: GUARANTEED
name Free label to let the merchant identify the termsAndConditions. String
Example: Grand Hotel Mississipi selling conditions v01
termsAndConditions Array of terms and conditions in multiple languages. Array
language Language to be used on the termsAndConditions labels, ISO 639-2. String
Min. length: 3
Max. length: 3
Example: ENG
checkMarkLabelStructureCondition Text to be showed beside the checkmark of acceptance. String
Example: Confirm to accept terms and conditions
linkLabelStructureCondition Text of the hyperlink of the T&C detailed text. String
Example: Property Condition
textStructureCondition Text of the terms and conditions in html format, encoded in Base64. String
Example: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdCwgc2VkIGRvIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdWEuIFV0IGVuaW0gYWQgbWluaW0gdmVuaWFtLCBxdWlzIG5vc3RydWQgZXhlcmNpdGF0aW9uIHVsbGFtY28gbGFib3JpcyBkb2xvciBzaXQgYW1ldA==
checkMarkLabelCancellationCondition Text to be showed beside the checkmark of acceptance of the cancellation terms. String
Example: Confirm to accept terms and conditions
linkLabelCancellationCondition Text of the hyperlink of the cancellation terms detailed text. String
Example: Property cancellation Condition
textCancellationCondition Text of the cancellation terms and conditions in html format, encoded in Base64. String
Example: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdCwgc2VkIGRvIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdWEuIFV0IGVuaW0gYWQgbWluaW0gdmVuaWFtLCBxdWlzIG5vc3RydWQgZXhlcmNpdGF0aW9uIHVsbGFtY28gbGFib3JpcyBkb2xvciBzaXQgYW1ldA==
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
Example: aeca2ac3-1d03-4f17-855b-19767f9c4586
Arrow RESPONSE 400
Invalid request data - 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
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