PARAM QUERY

		NOME	DESCRIZIONE	FORMATO
No param query

PARAM BODY

request

		NOME	DESCRIZIONE	FORMATO
card Oggetto contenente i dati della carta di pagamento. Object cvv Valore di convalida della carta, quando disponibile. String Lunghezza min: 3 Lunghezza max: 4 Esempio: 123 expiryDate Data di scadenza della carta nel formato mmaa. String Lunghezza min: 4 Lunghezza max: 5 Esempio: 1225 pan Carta PAN. String Lunghezza min: 12 Lunghezza max: 19 Esempio: 1234567890123456 order Oggetto contenente i dettagli dell'ordine. Object amount Importo della transazione nell'unità monetaria più piccola. 50 euro sono rappresentati come 5000 (2 decimali) 50 JPY è rappresentato come 50 (0 decimali) String Esempio: 3545 currency Valuta della transazione. Codice alfabetico ISO 4217 String Esempio: EUR customField Descrizione aggiuntiva della transazione String Lunghezza max: 255 Esempio: weekend promotion customerId Identificatore del cliente calcolato dal commerciante per corrispondere al cliente registrato sulla piattaforma di e-commerce. Utilizzare solo lettere, cifre, trattino basso (_) o trattino (-). String Lunghezza max: 27 Esempio: mcid97295873 customerInfo Oggetto contenente il dettaglio del cliente. L'invio del contenuto di questo oggetto aumenta il livello di sicurezza della transazione, aumentando quindi la probabilità che nel pagamento non venga richiesta l'autenticazione a due fattori. Object billingAddress Oggetto contenente il dettaglio dell'indirizzo del cliente. Object additionalInfo Informazioni aggiuntive sull'indirizzo, ad esempio il piano. Lunghezza massima consigliata: 50 caratteri. String Esempio: Quinto Piano, Scala B city Città. Lunghezza massima consigliata: 40 caratteri. String Esempio: Bologna country Stato nel codice ISO 3166-1 alpha-3. Lunghezza massima consigliata: 3 caratteri. String Esempio: ITA name Nome e cognome. Lunghezza massima consigliata: 50 caratteri. String Esempio: Mario Rossi postCode Codice Postale. Lunghezza massima consigliata: 16 caratteri. String Esempio: 40124 province Codice della provincia. Lunghezza massima consigliata: 3 caratteri. String Esempio: BO street Indirizzo completo. Lunghezza massima consigliata: 50 caratteri. String Esempio: Piazza Maggiore, 1 cardHolderAcctInfo Oggetto contenente informazioni sull'account dell'acquirente. Object chAccAgeIndicator Indicatore dell'età dell'account sul sito del commerciante: 01 = Nessun conto 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 web del commerciante, incluso indirizzo di fatturazione o spedizione, nuovo account di pagamento o nuovi utenti aggiunti. String Esempio: 2019-02-11T00:00:00.000+0000 chAccChangeIndicator Tempo trascorso dall'ultima modifica alle informazioni dell'account dell'acquirente sul sito del commerciante, incluso l'indirizzo di fatturazione o di spedizione, il nuovo account 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 chAccDate Data di attivazione dell'account sul sito web del commerciante. String Esempio: 2019-02-11T00:00:00.000+0000 chAccPwChangeDate Data dell'ultima modifica della password dell'account (inclusa la reimpostazione della password). String Esempio: 2019-02-11T00:00:00.000+0000 chAccPwChangeIndicator Tempo trascorso da quando l'account dell'acquirente ha eseguito una modifica della password o un ripristino dell'account: 01 = Nessun conto 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 destinationAddressUsageDate Data dell'ultimo utilizzo di questo indirizzo di consegna. String Esempio: 2019-02-11T00:00:00.000+0000 destinationAddressUsageIndicator Indica quando è stato utilizzato per la prima volta l'indirizzo di spedizione utilizzato per questa transazione: 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 account identico al nome dell'indirizzo di spedizione. 02 = Nome account diverso dal nome dell'indirizzo di spedizione String Esempio: 01 nbPurchaseAccount Numero di acquisti di questo account negli ultimi 6 mesi. Integer Esempio: 0 paymentAccAgeDate Data di attivazione del conto di pagamento. String Esempio: 2019-02-11T00:00:00.000+0000 paymentAccIndicator Indica quando l'acquirente ha inserito il Conto di pagamento sul sito del commerciante: 01 = Nessun conto 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: 0 provisionAttemptsDay Numero di tentativi di aggiungere una nuova carta nelle ultime 24 ore. Integer Esempio: 0 suspiciousAccActivity Indica se il commerciante ha rilevato attività sospette (incluse frodi precedenti) sul conto dell'acquirente: 01 = Nessuna attività sospetta verificata. 02 = Rilevata attività sospetta String Esempio: 01 txnActivityDay Numero di transazioni (riuscite e abbandonate) per questo account nelle 24 ore precedenti. Integer Esempio: 0 txnActivityYear Numero di transazioni (riuscite e abbandonate) per questo conto nell'anno precedente. Integer Esempio: 0 cardHolderEmail E-mail del titolare della carta. Lunghezza massima consigliata: 255 caratteri. String Esempio: mauro.morandi@nexi.it cardHolderName Nome e cognome del titolare della carta. Lunghezza massima consigliata: 255 caratteri. String Esempio: Mauro Morandi homePhone Numero di telefono di casa fornito dal titolare della carta. Lunghezza massima consigliata: 18 caratteri. String Esempio: 391231234567 merchantRiskIndicator Oggetto contenente informazioni relative all'acquisto effettuato. Object deliveryEmail In caso di acquisto di prodotti virtuali/digitali: indirizzo email a 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 lo stesso giorno. 03 = Consegna notturna. 04 = Consegna in due o più giorni String Esempio: 01 giftCardAmount Oggetto contenente l'importo totale e la valuta delle carte prepagate o gift card acquistate. Object currency Per l'acquisto di carte prepagate o regalo, il codice valuta della carta come definito nella norma ISO 4217. EMVCO: GiftCardCurr String Esempio: EUR value Per l'acquisto di carte prepagate o regalo, l'importo totale dell'acquisto di carte prepagate o regalo in unità principali (ad esempio, 123,45 USD è 123). EMVCO: importo della carta regalo String Lunghezza max: 18 Esempio: 100 giftCardCount Numero totale di carte/codici individuali prepagati o regalo acquistati. Integer Esempio: 0 preOrderDate Per un acquisto preordinato, la data prevista in cui la merce sarà disponibile. String Esempio: 2019-02-11T00:00:00.000+0000 preOrderPurchaseIndicator Indica se l'acquirente sta effettuando un ordine per merce con disponibilità futura: 01 = Merci disponibili. 02 = Disponibilità futura. String Esempio: 01 reorderItemsIndicator Indica se il titolare della carta sta riordinando la merce acquistata in precedenza: 01 = Primo ordine. 02 = Merce già acquistata in precedenza. String Esempio: 01 shipIndicator Indicatore sul tipo di consegna: 01 = Spedizione all'indirizzo di fatturazione. 02 = Spedizione ad un altro indirizzo verificato dal commerciante. 03 = Consegna ad un indirizzo diverso da quello di fatturazione. 04 = Spedizione o ritiro presso il negozio (nell'oggetto "destinationAddress" deve essere indicato l'indirizzo del negozio). 05 = Beni virtuali/digitali, compresi servizi online, buoni regalo elettronici, codici di recupero. 06 = Biglietti di viaggio ed eventi (non inviati). 07 = Altro: ad esempio giochi, servizi digitali non inviati, abbonamenti a media elettronici String Esempio: 01 mobilePhone Telefono cellulare. Lunghezza massima consigliata: 15 caratteri. String Esempio: 3280987654 mobilePhoneCountryCode Prefisso del telefono cellulare. Lunghezza massima consigliata: 4 caratteri. String Esempio: +39 recontactConsent In alcuni scenari è possibile raccogliere il consenso del pagatore ad essere ricontattato dal commerciante. Questo campo indica se il pagatore ha dato tale consenso. Boolean shippingAddress Oggetto contenente il dettaglio dell'indirizzo del cliente. Object additionalInfo Informazioni aggiuntive sull'indirizzo, ad esempio il piano. Lunghezza massima consigliata: 50 caratteri. String Esempio: Quinto Piano, Scala B city Città. Lunghezza massima consigliata: 40 caratteri. String Esempio: Bologna country Stato nel codice ISO 3166-1 alpha-3. Lunghezza massima consigliata: 3 caratteri. String Esempio: ITA name Nome e cognome. Lunghezza massima consigliata: 50 caratteri. String Esempio: Mario Rossi postCode Codice Postale. Lunghezza massima consigliata: 16 caratteri. String Esempio: 40124 province Codice della provincia. Lunghezza massima consigliata: 3 caratteri. String Esempio: BO street Indirizzo completo. Lunghezza massima consigliata: 50 caratteri. String Esempio: Piazza Maggiore, 1 tin Il numero di identificazione fiscale viene raccolto in determinati scenari, come le donazioni, per conformarsi alle normative fiscali. È un identificatore utilizzato in molti paesi a fini fiscali. String Lunghezza max: 32 Esempio: 12345678901 workPhone Numero di telefono lavorativo fornito dal titolare della carta. Lunghezza massima consigliata: 18 caratteri. String Esempio: 391231234567 description Descrizione della transazione String Lunghezza max: 255 Esempio: TV LG 3423 invoiceId L'ID della fattura. Deve contenere solo caratteri supportati: alfanumerici, carattere di sottolineatura (_), meno (-) o più (+) con una lunghezza massima di 30 caratteri. Questo campo è facoltativo. [rif. ISOv93 127,98] String Lunghezza max: 30 orderId Identificatore dell'ordine del commerciante, univoco nel dominio del commerciante. La lunghezza massima è di 27 caratteri. Per rispettare le specifiche del circuito di pagamento, si consiglia vivamente di utilizzare un orderId fino a 18 caratteri. Una buona strategia di unicità è quella di combinare un commerciante stabile o un prefisso di canale con una sequenza monotona, un timestamp o un riferimento all'ordine della piattaforma, evitando il riutilizzo per pagamenti diversi. String Lunghezza max: 27 Esempio: btid2384983 plan Oggetto contenente i dettagli della descrizione del piano. Puoi visualizzare il piano creato tramite il menu "subscription" nel tuo backoffice. In base ai diversi valori di `planType`, il piano può essere utilizzato per scopi differenti: - FIXED: ogni rata ha lo stesso importo e date di scadenza specificate. - VARIABLE: ogni rata può avere un importo diverso e date di scadenza specificate. - ACQUIRER_AGREEMENT: gestito dall'accordo con l'acquirer, il numero di rate e l'importo di ciascuna rata sono definiti dall'acquirer. Object contractId Identificatore del contratto. Il valore deve essere lungo tra 1 e 18 caratteri. Per mantenerlo unico, utilizza un commerciante stabile o un prefisso di canale insieme a una sequenza monotona, un timestamp o un riferimento al contratto della piattaforma, evitando il riutilizzo per diversi contratti ricorrenti. String Lunghezza min: 1 Lunghezza max: 18 Esempio: C2834987 planType Valori possibili: - FIXED: ogni rata ha lo stesso importo e date di scadenza specificate. - VARIABLE: ogni rata può avere un importo diverso e date di scadenza specificate. - ACQUIRER_AGREEMENT: gestito dall'accordo con l'acquirer, il numero di rate e l'importo di ciascuna rata sono definiti dall'acquirer. String status Valori possibili: - ACTIVE: il piano è attivo e può essere utilizzato per le transazioni. - INACTIVE: il piano è inattivo e non può essere utilizzato per le transazioni. - COMPLETED: il piano è stato completato e tutte le rate sono state pagate. String totalAmount Importo totale del piano nell'unità di valuta più piccola. La valuta applicata è quella dell'ordine. String products Elenco dei prodotti nel carrello (noto anche come carrello degli acquisti) come rappresentazione virtuale degli articoli di un cliente seleziona durante lo shopping in un negozio online. Nota: per i pagamenti KLARNA, la lista dei prodotti è obbligatoria e l'importo totale dell'ordine deve corrispondere alla somma dei prezzi dei prodotti. Array description Una spiegazione dettagliata del prodotto che fornisce informazioni essenziali per aiutare i clienti e gli elaboratori di pagamento capire cosa si sta acquistando String Lunghezza max: 255 Esempio: The Nike Air Zoom Pegasus 39 is designed for runners seeking comfort and responsiveness. Featuring a lightweight, breathable mesh upper, these shoes are built to keep your feet cool and dry throughout your run. itemCategory Diverse categorie di articoli lavorabili: - PHYSICAL: un oggetto tangibile, come un prodotto o una merce. - DISCOUNT: Una riduzione del prezzo totale dell'ordine. - SHIPPING_FEE: il costo associato alla consegna dell'ordine. - DIGITAL: un bene immateriale, come un e-book o un software. - GIFT_CARD: Una carta prepagata che può essere utilizzata per acquisti futuri. - STORE_CREDIT: credito emesso dal negozio, spesso per resi o promozioni. - SURCHARGE: Un costo aggiuntivo aggiunto all'ordine. String Esempio: DIGITAL name Il nome del prodotto visualizzato al cliente. Dovrebbe essere chiaro e conciso per aiutare il cliente a capire cosa sta acquistando String Lunghezza max: 255 Esempio: Nike Air Zoom Pegasus 39 Running Shoes price Il prezzo del prodotto per unità nell'unità monetaria più piccola. - 50 EUR sono rappresentati come 5000 (2 decimali) - 50 JPY è rappresentato come 50 (0 decimali) La valuta del prodotto corrisponde alla valuta specificata nell'ordine. Il prezzo non è strettamente correlato all'importo dell'ordine String Esempio: 1000 quantity Il numero di unità che il cliente intende acquistare Integer Esempio: 2 sku Unità di custodia delle scorte. È un identificatore o codice univoco assegnato\\ a ciascun prodotto o articolo venduto da un rivenditore o da un negozio di e-commerce String Lunghezza max: 64 Esempio: RUN-NIK-AZP39-BLK-10 termsAndConditionsIds Matrice di identificatori T&C della struttura. Inserimento di termini e condizioni Array transactionSummary Elenco di riepilogo della transazione, contenente i dettagli della transazione. Array language Lingua nel codice a tre lettere ISO 639-2. String Lunghezza min: 3 Lunghezza max: 3 Default: ITA Esempio: ENG summaryList Matrice contenente l'elenco di riepilogo. Array label Etichetta dei campi. String Lunghezza max: 50 Esempio: Number of people value Valore. String Lunghezza max: 50 Esempio: 4 paymentSession Questo è l'oggetto base della sessione di pagamento per l'endpoint di pagamento. Contiene le informazioni su importo, azione e capture. Object action Indica il tipo di operazione: * PAY - esegue una transazione di pagamento * VERIFY - effettua un'operazione di verifica, senza alcun addebito, con il solo scopo di confermare la validità dei dati della carta inseriti dal cliente * PREAUTH - esegue un'operazione di preautorizzazione String Default: PAY Esempio: PAY amount Importo del primo pagamento che può essere inferiore o uguale al'importo dell'ordine. 50 EUR sono rappresentati come 5000 (2 decimali) 50 JPY è rappresentato come 50 (0 decimali) Funziona come descritto nella norma ISO 4217 String Esempio: 5000 capture Sovrascrive il metodo di conferma predefinito del terminale, solo per i pagamenti con carta: * IMPLICITO - conferma automatica *ESPLICITO - solo autorizzazione Il valore predefinito dipende dalla configurazione del terminale. 1. Terminale impostato su ESPLICITO: un. se captureType è EXPLICIT la cattura sarà EXPLICIT b. se captureType non è presente o è nullo la cattura sarà ESPLICITA c. se captureType è IMPLICIT la cattura sarà IMPLICITA 2. Terminale impostato su IMPLICITO: un. se captureType è EXPLICIT l'acquisizione sarà un errore b. se captureType non è presente o è nullo la cattura sarà IMPLICITA c. se captureType è IMPLICIT la cattura sarà IMPLICITA String Esempio: EXPLICIT exemptions NO_PREFERENCE, CHALLENGE_REQUESTED String Esempio: NO_PREFERENCE recurrence Definisce le impostazioni per un pagamento ricorrente. Le impostazioni vengono utilizzate per creare un contratto che può essere usato per i pagamenti successivi. Il contenuto di questo oggetto può variare in base a `contractType`, fare riferimento allo specifico tipo di contratto per maggiori dettagli. Object contractId Il contractId è un identificatore univoco del contratto. Viene generato dai sistemi degli esercenti e viene utilizzato per identificare il contratto nei pagamenti successivi. String Lunghezza min: 1 Lunghezza max: 18 Esempio: C2834987 contractType Definisce la tipologia di contratto che verrà utilizzata per i successivi\\ pagamenti: * CIT - il contratto può essere utilizzato solo per pagamenti successivi\\ disposti dal cliente. * MIT_SCHEDULED - il contratto può essere utilizzato\ \ per transazioni programmate avviate dal commerciante. Il numero di giorni tra\\ un pagamento e l'altro dovrà essere pari o superiore al valore di contractFrequency. \ * MIT_UNSCHEDULED - il contratto può essere utilizzato per transazioni non programmate avviate dal commerciante. Il valore contractFrequency non ha alcun effetto in questo caso. String Esempio: CIT recurringAction Definisce l'azione per un pagamento ricorrente: * **SUBSEQUENT_PAYMENT** – Pagamento “OneClick” utilizzando un contratto esistente * **CONTRACT_CREATION** – Creazione di un nuovo contratto * **CARD_SUBSTITUTION** – Sostituzione della carta legata ad un contratto in essere (Nota: solo per contratti creati con la modalità di pagamento CARD) String Esempio: CONTRACT_CREATION