Nessun risultato trovato

POST/reservations

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

Creazione prenotazione.

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
reservation Oggetto contenente il dettaglio della prenotazione. Object
reservationId ID prenotazione esercente, univoco nel dominio esercente. String
Lunghezza max: 27
Esempio: btid2384983
status Valori possibili:
- ACTIVE
- CANCELED
String
Esempio: ACTIVE
creationDate Il timestamp relativo alla data di creazione della struttura. String
Esempio: 2022-08-01
amount Importo della transazione nell'unità monetaria più piccola. 50 EUR sono rappresentati come 5000 (2 decimali) 50 JPY sono rappresentati come 50 (0 decimali). String
Esempio: 3545
currency Valuta della transazione nel codice ISO 4217. String
Esempio: EUR
deposit Importo della transazione nell'unità monetaria più piccola. 50 EUR sono rappresentati come 5000 (2 decimali) 50 JPY sono rappresentati come 50 (0 decimali). String
Esempio: 3500
description Descrizione della transazione. String
Lunghezza max: 255
Esempio: Prenotazione camera - Cefalù
reservationType Valori possibili:
- PREPAID_REFUNDABLE: la prenotazione viene pagata in anticipo per il servizio che verrà fornito e può essere rimborsata.
- PREPAID_NOT_REFUNDABLE: la prenotazione è pagata in anticipo per il servizio che verrà fornito e non è rimborsabile.
- GUARANTEED_NOSHOW: prenotazione, tramite una verifica carta senza addebito al cliente. Nel caso il cliente non si presenti presso la struttura, è possibile addebitare il costo della prima notte di soggiorno.
- GUARANTEED_PENALTY: prenotazione, tramite una verifica carta senza addebito al cliente. Viene effettuato un addebito in automatico della penale prestabilita nel caso in cui un ospite non si presenti presso la struttura.
- BUNDLE: prenotazione di un pacchetto contenente più servizi erogato dalla stessa struttura ad esempio soggiorno + escursione + ristorante + bus turistico.
 String
Esempio: GUARANTEED
structureId Identificatore della struttura univoco nel dominio dell'esercente. String
Lunghezza min: 1
Lunghezza max: 36
Esempio: 99a172e5-423c-4648-9895-4cb5d1d43134
termsAndConditionsIds Array di identificativi dei T&C della struttura. Inserimento termini e condizioni Array
checkInDate Check-in in formato ISO 8601. String
Esempio: 2022-09-01
checkInFromTime Ora inizio check in, da intendersi come orario locale della struttura. String
Lunghezza max: 11
Esempio: 09:00
checkInToTime Ora fine check in, da intendersi come orario locale della struttura. String
Lunghezza max: 11
Esempio: 20:00
checkOutDate Orario di check out in formato ISO 8601. String
Esempio: 2022-09-05
checkOutFromTime Ora inizio check out, da intendersi come orario locale della struttura. String
Lunghezza max: 11
Esempio: 09:00
checkOutToTime Ora fine check out, da intendersi come orario locale della struttura. String
Lunghezza max: 11
Esempio: 20:00
reservationPeriod Numero di giorni o notti per la prenotazione. String
Lunghezza max: 4
Esempio: 4
customerNumber Numero di persone per la prenotazione. String
Lunghezza max: 4
Esempio: 2
customerName Il nome del titolare della prenotazione. String
Lunghezza max: 255
Esempio: Mario
customerSurname Il cognome dell'intestatario della prenotazione. String
Lunghezza max: 255
Esempio: Rossi
linkExpirationDate Data di scadenza per Paybylink. String
Esempio: 2022-09-01
collectionType Tipologia contabilizzazione:
- INSTANT: immediato
- DELAYED: differito
- INSTALLMENT: dilazionato
Incasso Differito e Dilazionato
 String
Esempio: INSTANT
customerId Identificativo cliente per questa transazione. String
Lunghezza max: 27
Esempio: mcid97295873
customField Descrizione aggiuntiva della transazione. String
Lunghezza max: 255
Esempio: weekend promotion
customerTaxCode Il codice fiscale del cliente. String
Lunghezza max: 21
Esempio: SVTTRP95P03C478T
customerInfo Oggetto contenente il dettaglio del cliente. Inviare il contenuto di questo oggetto aumenta il livello di sicurezza della transazione, aumentando così la probabilità che non venga richiesta l'autenticazione a due fattori nel pagamento. Object
cardHolderName Nome e cognome del titolare della carta. String
Lunghezza max: 255
Esempio: Mauro Morandi
cardHolderEmail Email del titolare della carta. String
Lunghezza max: 255
Esempio: mauro.morandi@nexi.it
billingAddress Oggetto contenente il dettaglio dell'indirizzo del cliente. Object
name Nome e cognome. String
Lunghezza max: 50
Esempio: Mario Rossi
street Indirizzo completo. String
Lunghezza max: 50
Esempio: Piazza Maggiore, 1
additionalInfo Informazioni aggiuntive sull'indirizzo, per esempio il piano. String
Lunghezza max: 50
Esempio: Quinto Piano, Scala B
city Città. String
Lunghezza min: 1
Lunghezza max: 40
Esempio: Bologna
postCode Codice postale. String
Lunghezza max: 16
Esempio: 40124
province Codice della provincia. String
Lunghezza max: 3
Esempio: BO
country Stato secondo il codice ISO 3166-1 alpha-3.
Il parametro è obbligatorio con i seguenti metodi di pagamento alternativi:
- Bancontact: valorizzare "country" con "BEL".
- Giropay: valorizzare "country" con "DEU".
- Multibanco: valorizzare "country" con "PRT".
 String
Lunghezza min: 3
Lunghezza max: 3
Esempio: ITA
shippingAddress Oggetto contenente il dettaglio dell'indirizzo del cliente. Object
name Nome e cognome. String
Lunghezza max: 50
Esempio: Mario Rossi
street Indirizzo completo. String
Lunghezza min: 1
Lunghezza max: 50
Esempio: Piazza Maggiore, 1
additionalInfo Informazioni aggiuntive sull'indirizzo, per esempio il piano. String
Lunghezza max: 50
Esempio: Quinto Piano, Scala B
city Città. String
Lunghezza min: 1
Lunghezza max: 40
Esempio: Bologna
postCode Codice postale. String
Lunghezza max: 16
Esempio: 40124
province Codice della provincia. String
Lunghezza max: 3
Esempio: BO
country Stato secondo il codice ISO 3166-1 alpha-3. String
Lunghezza min: 3
Lunghezza max: 3
Esempio: ITA
mobilePhoneCountryCode Prefisso del numero di telefono. String
Lunghezza max: 4
Esempio: +39
mobilePhone Numero di cellulare. String
Lunghezza max: 15
Esempio: 3280987654
homePhone Telefono di casa fornito dal titolare carta. String
Lunghezza max: 18
Esempio: +391231234567
workPhone Numero di telefono lavorativo fornito dal titolare carta. String
Lunghezza max: 18
Esempio: 391231234567
cardHolderAcctInfo Oggetto contenente informazioni relative all'account dell'acquirente. Object
chAccDate Data di attivazione dell'account sul sito dell'esercente. String
Esempio: 2019-02-11
chAccAgeIndicator Indicatore dell'anzianità dell'account sul sito dell'esercente:
01 = Nessun account
02 = Creato durante questa transazione
03 = Creato negli ultimi 30 giorni
04 = Creato tra 30 e 60 giorni fa
05 = Creato prima di 60 giorni fa
 String
Esempio: 01
chAccChangeDate Data dell'ultima variazione dell'account sul sito dell'esercente, incluso l'indirizzo di fatturazione o spedizione, nuovo metodi di pagamento o l'aggiunta di nuovi utenti. String
Esempio: 2019-02-11
chAccChangeIndicator Tempo trascorso dall'ultima modifica delle informazioni sull'account dell'acquirente sul sito dell'esercente, incluso l'indirizzo di fatturazione o spedizione, nuovo metodo di pagamento o l'aggiunta di nuovi utenti.
01 = Creato durante questa transazione
02 = Creato negli ultimi 30 giorni
03 = Creato tra 30 e 60 giorni fa
04 = Creato prima di 60 giorni fa
 String
Esempio: 01
chAccPwChangeDate Data di ultimo cambio password dell'account (incluso reset password). String
Esempio: 2019-02-11
chAccPwChangeIndicator Tempo trascorso da quando l'account dell'acquirente ha eseguito una modifica della password o il ripristino dell'account:
01 = Nessun account
02 = Creato durante questa transazione
03 = Negli ultimi 30 giorni
04 = Tra 30 e 60 giorni fa
05 = Prima di 60 giorni fa
 String
Esempio: 01
nbPurchaseAccount Numero di acquisti di questo account negli ultimi 6 mesi. Number
Esempio: 0
destinationAddressUsageDate Data di ultimo utilizzo di questo indirizzo di consegna. String
Esempio: 2019-02-11
destinationAddressUsageIndicator Indica quando l'indirizzo di spedizione utilizzato per questa transazione è stato utilizzato per la prima volta:
01 = Creato durante questa transazione
02 = Creato negli ultimi 30 giorni
03 = Creato tra 30 e 60 giorni fa
04 = Creato prima di 60 giorni fa
 String
Esempio: 01
destinationNameIndicator Indica se il nome associato all'account corrisponde al nome indicato per la spedizione:
01 = Nome dell'account identico al nome dell'indirizzo di spedizione.
02 = Nome dell'account diverso dal nome dell'indirizzo di spedizione.
 String
Esempio: 01
txnActivityDay Numero di transazioni (riuscite e abbandonate) per questo account nelle 24 ore precedenti. Number
Esempio: 0
txnActivityYear Numero di transazioni (riuscite e abbandonate) per questo account nell'anno precedente. Number
Esempio: 0
provisionAttemptsDay Numero di tentativi di aggiunta nuova carta nelle ultime 24 ore. Number
Esempio: 0
suspiciousAccActivity Indica se l'esercente ha rilevato attività sospette (incluse precedenti frodi) sull'account dell'acquirente.
01 = Nessun attività sospetta verificata.
02 = Rilevate attività sospette.
 String
Esempio: 01
paymentAccAgeDate Data di attivazione dell'account di pagamento. String
Esempio: 2019-02-11
paymentAccIndicator Indica quando l'acquirente ha inserito l'account di pagamento sul sito del merchant:
0 = Nessun account
01 = Creato durante questa transazione
02 = Creato negli ultimi 30 giorni
03 = Creato tra 30 e 60 giorni fa
04 = Creato prima di 60 giorni fa
 String
Esempio: 0
merchantRiskIndicator Oggetto contenente informazioni relative all'acquisto effettuato. Object
deliveryEmail Nel caso di acquisto di prodotti virtuali/digitali: indirizzo mail verso cui viene inviato il prodotto. String
Esempio: john.doe@email.com
deliveryTimeframe Indicatore sul periodo di consegna della merce:
01 = Consegna immediata (prodotti virtuali/digitali).
02 = Consegna nello stesso giorno.
03 = Consegna notturna.
04 = Consegna in due o più giorni.
 String
Esempio: 01
giftCardAmount Oggetto contenente informazioni relative all'importo delle carte regalo o buoni. Object
value Valore della carta regalo o prepagata utilizzata per la transazione. L'importo deve essere espresso in centesimi. Number
Esempio: 100
currency Valuta della transazione nel codice ISO 4217. String
Esempio: EUR
giftCardCount Totale delle singole carte/codici prepagate o regalo acquistati. Number
Esempio: 2
preOrderDate Per un acquisto preordinato, la data prevista in cui la merce sarà disponibile. String
Esempio: 2019-02-11
preOrderPurchaseIndicator Indica se l'acquirente sta effettuando un ordine per merce con disponibilità futura:
01 = Merce disponibile.
02 = Disponibilità futura.
 String
Esempio: 01
reorderItemsIndicator Indica se l'acquirente sta riordinando merce acquistata in precedenza:
01 = Primo ordine.
02 = Merce già acquistata in precedenza.
 String
Esempio: 01
shipIndicator Indicatore sulla tipologia di consegna:
01 = Spedizione all'indirizzo di fatturazione.
02 = Spedizione ad un altro indirizzo verificato dal merchant.
03 = Spedizione ad un indirizzo differente da quello di fatturazione.
04 = Spedizione o ritiro al negozio (l'indirizzo del negozio deve essere indicato nei campi di destinazione).
05 = Beni virtuali/digitali, inclusi servizi online, buoni regalo elettronici, codici di riscossione.
06 = Biglietti di viaggi ed eventi (non spediti).
07 = Altro: per esempio giochi, servizi digitali non spediti, abbonamenti a media elettronici.
 String
Esempio: 01
installments Array contenente il dettaglio delle dilazioni. Obbligatorio con "collectionType" valorizzato a "INSTALLMENT". Array
date Data rata. String
Esempio: 2022-09-01
amount Importo rata. String
Esempio: 350
type Valori possibili:
- AUTOMATIC: le rate verranno eseguite automaticamente da XPay.
- MANUAL: le rate verranno eseguite manualmente dall'esercente.
 String
Esempio: AUTOMATIC
transactionSummary Array contenente il riepilogo della transazione. Array
language Lingua usata nel dettaglio del riepilogo della transazione, ISO 639-2. String
Esempio: eng
summaryList Array contenente il riepilogo della lista. Array
label Etichetta del campo. String
Lunghezza max: 50
Esempio: Number of people
value Valore. String
Esempio: 4
CancelationDetails Oggetto contenente i dettagli per la cancellazione della prenotazione. Object
dataType Tipologia data entro cui è possibile effettuare la cancellazione della prenotazione. Valori possibili:
- DATE: data
- HOUR_FROM_CHECKIN: ore dal check in
- DAY_FROM_CHECKIN: giorni dal checkin
 String
Esempio: HOUR_FROM_CHECKIN
cancellationCondition Array contenente i dettagli sulle penali delle cancellazioni. Array
dataTypeValue The value of the selected data type. String
Esempio: 2
value The value for the penalty amount or percentage of refund. String
Esempio: 5000
Arrow RESPONSE 200
Success - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
reservationId ID prenotazione esercente, univoco nel dominio esercente String
Esempio: btid2384983
Arrow RESPONSE 400
Invalid request data - 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
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