No results

POST/agencies/custom_fields

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

createCustomField

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

customFieldRequest

NAME DESCRIPTION FORMAT
agencyId String
customFieldEnabled Boolean
customFieldOrd Integer
customFieldTitle String
customFieldTranslations Array
id Integer
label String
Max. length: 255
language Language in ISO 639-2 three-letter code. String
Min. length: 3
Max. length: 3
Default: ITA
Example: ENG
Arrow RESPONSE 200
OK - No Header for this response
BODY
NAME DESCRIPTION FORMAT
customFieldId The unique identifier for custom field.
 String
Arrow RESPONSE 201
Created - No Header and Body for this response
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 403
Forbidden - No Header and Body for this response
Arrow RESPONSE 404
Not Found - 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