No results

POST/terms_and_conditions

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

Create Terms and Condition for orders.

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
name Free label to let the merchant identify the Terms and Conditions version for audit purposes. 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 Terms and Conditions labels, ISO 639-2. String
Example: eng
checkMarkLabel Text to be showed beside the checkmark of acceptance. String
Example: Confirm to accept terms and conditions
linkLabel Text of the hyperlink of the T&C detailed text. String
Example: Property Condition
text Text of the terms and conditions in html format, encoded in Base64. String
Example: PGRpdj48aDM+Q29uZGl0aW9uPGgzPjxwPlRoZSBub24tcmVmdW5kYWJsZSByYXRlIHJlcXVpcmVzIHRoZSBmdWxsIGFtb3VudCB0byBiZSBjaGFyZ2VkIGF0IHRoZSB0aW1lIG9mIGJvb2tpbmc8L3A+PGRpdj4=
Arrow RESPONSE 200
Terms and conditions created successfully - No Header for this response
BODY
NAME DESCRIPTION FORMAT
termsAndConditionsId Unique identifier of Terms and Conditions. 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