No results

POST/agencies

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

createAgency

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

request

NAME DESCRIPTION FORMAT
agency Object
agencyEmail String
agencyId String
agencyName String
Max. length: 255
checkInTime String
Max. length: 5
checkOutTime String
Max. length: 5
creationDate String
customFields Array
customFieldTitle String
Max. length: 255
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
enabled Boolean
fieldOrder Integer
id String
identifier Integer
mobilePhone String
Max. length: 15
mobilePhoneCountryCode String
status String
tecBundleId String
tecNotRefundableId String
tecRefundableId String
terminalId String
Min. length: 8
Max. length: 8
timeLabel String
Arrow RESPONSE 200
OK - No Header and Body for this response
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