No results

GET/custom_fields/{customFieldId}

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/custom_fields/{customFieldId}
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/custom_fields/{customFieldId}

Retrieve custom fields details

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
customFieldId String
Format: uuid
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

NAME DESCRIPTION FORMAT
No param body
Arrow RESPONSE 200
Terms and conditions returned - No Header for this response
BODY
NAME DESCRIPTION FORMAT
structureId Structure identifier unique in the merchant domain. String
Max. length: 36
Example: 99a172e5-423c-4648-9895-4cb5d1d43134
customFieldOrd The custom fields ordering Integer
Example: 1
customFieldTitle The title used for identify the custom field String
Max. length: 50
Example: Animali domestici
customFieldEnabled The custom field status. Boolean
Example: true
customFieldTranslations Array of labels in multiple languages. Array
language Custom field language, ISO 639-2. String
Min. length: 3
Max. length: 3
Example: ENG
label Label translated of the custom field. String
Example: Pets
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