Nessun risultato trovato

GET/structures

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

Elenco strutture in ordine cronologico inverso.

PARAM HEADER
NOME DESCRIZIONE FORMATO
X-Api-Key Chiave API d'autenticazione. String
Formato: uuid
Esempio: 625b4884-38f8-11ed-a261-0242ac120002
Correlation-Id Identificatore univoco della richiesta. String
Formato: uuid
Esempio: 4935e818-38e0-11ed-a261-0242ac120002
PARAM PATH
NOME DESCRIZIONE FORMATO
No param path
PARAM QUERY
NOME DESCRIZIONE FORMATO
No param query
PARAM BODY

NOME DESCRIZIONE FORMATO
No param body
Arrow RESPONSE 200
Success - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
structure Oggetto contenente il dettaglio della struttura. Object
terminalId Identificativo del terminale dell'esercente. String
Esempio: 99999998
structureId Identificatore della struttura, univoco nel dominio esercente. String
Lunghezza max: 36
Esempio: 99a172e5-423c-4648-9895-4cb5d1d43134
status Stato di attivazione della struttura. Valori possibili:
- ACTIVE
- NOT_ACTIVE
String
Esempio: ACTIVE
structureCreationDate Il timestamp relativo alla data di creazione della struttura. String
Esempio: 2022-08-01
structureName Nome della struttura. String
Lunghezza max: 255
Esempio: Casa Rubino
structureEmail E-mail associata alla struttura. String
Lunghezza max: 255
Esempio: mauro.morandi@nexi.it
mobilePhoneCountryCode Prefisso del numero telefonico della struttura. String
Lunghezza max: 4
Esempio: 39
mobilePhone Numero telefonico della struttura. String
Lunghezza max: 15
Esempio: 3280987654
checkInFromTime Orario di inizio check-in. Da intendersi come ora locale della struttura. String
Esempio: 14:00
checkInToTime Orario di fine check-in. Da intendersi come ora locale della struttura. String
Esempio: 23:00
checkOutFromTime Orario di inizio check-out. Da intendersi come ora locale della struttura. String
Esempio: 06:00
checkOutToTime Orario di fine check-out. Da intendersi come ora locale della struttura. String
Esempio: 10:00
tecGuaranteedPenaltyId Codice identificativo dei termini e condizioni associati alla struttura per la prenotazione garantita con penale (reservationType = GUARANTEED_PENALTY). String
Esempio: b5c66332-3853-48c3-b5a7-a12678d6ca9c
tecGuaranteedNoShowId Codice identificativo dei termini e condizioni associati alla struttura per la prenotazione garantita (reservationType = GUARANTEED_NOSHOW). String
Esempio: b5c66332-3853-48c3-b5a7-a12678d6ca9c
tecRefundableId Codice identificativo dei termini e condizioni associati alla struttura per la prenotazione prepagato rimborsabile (reservationType = PREPAID_REFUNDABLE). String
Esempio: b7b20af0-01e1-431d-bfbc-c41697720d1d
tecNotRefundableId Codice identificativo dei termini e condizioni associati alla struttura per la prenotazione prepagato non rimborsabile (reservationType = PREPAID_NOT_REFUNDABLE). String
Esempio: b28aaa05-ae84-40a2-9292-8006f176534b
customField Array containing custom fields linked to the structure. Array
customFieldId Identificato dei campi personalizzati. String
Esempio: 0d0f3240-efd3-4c6b-b305-b8ec3bb7a99a
customFieldTitle Il nome del campo personalizzato da intendersi come titolo. String
Esempio: Animali domestici
customFieldTranslations Array contenente le traduzioni dei campi personalizzati. Array
language Lingua da utilizzare nei dettagli di riepilogo della transazione, ISO 639-2. String
Esempio: ENG
label Etichetta del campo. String
Esempio: Pets
Arrow RESPONSE 404
Not found - Nessun header e body per questa risposta
Arrow RESPONSE 401
Unauthorized - Nessun header e body per questa risposta
Arrow RESPONSE 500
Internal Server Error - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
errors Array contenente la lista degli errori. I valori possibili sono riportati nella tabella Codici errore. Array
code Codice errore. String
Esempio: GW0001
description Descrizione errore. String
Esempio: Invalid merchant URL