Documentazione
Documentazione
Schema analitico BETA
account account

Account

  • accounttype  
     
    string  
  • createdby  
    L'ID dell'utente da cui è stato creato l'account.  
    bigint  
  • createdon  
    La data e l'ora di creazione dell'account.  
    timestamp  
  • deletedby  
    L'ID di un utente da cui è stato eliminato l'account.  
    bigint  
  • deletedon  
    La data e l'ora in cui l'account è stato eliminato.  
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • lastmodifieddate  
    La data e l'ora dell'ultima modifica dell'oggetto.  
    timestamp  
  • name  
    Il nome utilizzato per identificare il conto.  
    string  
  • parentaccount_id
    Parent account ID  
    bigint  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • scope_id
    Scope ID  
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • statechangeevent  
     
    string  
  • subaccountlimit  
    Il numero di sottoconti che possono essere creati all'interno di questo conto.  
    bigint  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
banktransaction banktransaction

Transazione bancaria

  • _db_id  
     
    int  
  • amountsnormalized  
     
    int  
  • banktransactiontype  
     
    bigint  
  • createdby  
    Il creato da indica l'utente che ha creato la transazione bancaria.  
    bigint  
  • createdon  
    La data e l'ora di creazione dell'oggetto.  
    timestamp  
  • currencybankaccount_id  
     
    bigint  
  • externalid  
     
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • paymentdate  
    La data di pagamento descrive la data in cui è stata effettuata la transazione.  
    timestamp  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • postingamount  
    L'importo di registrazione indica l'importo comprensivo degli aggiustamenti.  
    decimal(19,8)  
  • reference  
     
    string  
  • source  
     
    bigint  
  • spaceid  
     
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • valueamount  
     
    decimal(19,8)  
  • valuedate  
    La data valuta descrive la data in cui l'importo è effettivo sul conto.  
    timestamp  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
charge charge

Addebito

  • _db_id  
     
    int  
  • createdon  
    Data in cui sono state registrate le spese.  
    timestamp  
  • failurereason  
     
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • timeouton  
     
    timestamp  
  • transaction_id  
     
    bigint  
  • type  
     
    string  
  • userfailuremessage  
    Il messaggio d’errore spiega all’utente finale il motivo per cui l’addebito non è andato a buon fine. Il messaggio d’errore viene lanciato soltanto se l’addebito non è andato a buon fine.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
chargeattempt chargeattempt

Tentativo di addebito

  • _db_id  
     
    int  
  • charge_id
    Charge ID  
    bigint  
  • completionbehavior  
     
    string  
  • connectorconfiguration_id
    Connector Configuration ID  
    bigint  
  • connectorplugin  
     
    bigint  
  • connectorprocessingresulttype  
     
    string  
  • createdon  
    La data e l'ora di creazione dell'oggetto.  
    timestamp  
  • customerspresence  
    La presenza del cliente indica quale tipo di interazione con il cliente è stata utilizzata durante il tentativo di addebito.  
    string  
  • environment  
     
    string  
  • failedon  
     
    timestamp  
  • failurereason  
     
    bigint  
  • httpmessagebody  
     
    binary  
  • httpmessageheaders  
     
    binary  
  • httpmessagestatuscode  
     
    int  
  • id  
    A unique identifier for the object.  
    bigint  
  • initializingtokenversion  
     
    boolean  
  • invocation_id  
     
    bigint  
  • nextupdateon  
     
    timestamp  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • redirectionurl  
     
    string  
  • saleschannel  
     
    bigint  
  • spaceid  
     
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • succeededon  
     
    timestamp  
  • terminal_id
    Payment Terminal ID  
    bigint  
  • timeouton  
     
    timestamp  
  • tokenversion_id  
     
    bigint  
  • userfailuremessage  
    Inserire un messaggio da mostrare al cliente in caso di transazione fallita. Il messaggio viene localizzato in base alla lingua selezionata.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
  • wallet  
     
    bigint  
customer customer

Cliente

  • _db_id  
     
    int  
  • createdon  
    La data e l'ora di creazione dell'oggetto.  
    timestamp  
  • customerid  
    Inserire ID cliente come da sistema dell'esercente.  
    string  
  • emailaddress  
    Inserire l'indirizzo e-mail del cliente.  
    string  
  • familyname  
    Inserire il cognome del cliente.  
    string  
  • givenname  
    Inserire il nome del cliente  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • language  
    The language that is linked to the object.  
    string  
  • preferredcurrency  
    Inserire quale valuta il cliente preferisce utilizzare.  
    string  
  • spaceid  
     
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
legalorganizationform legalorganizationform

Forma giuridica. Legal organization form details

  • country  
    Il codice di due lettere del Paese in cui viene utilizzato il modulo di organizzazione legale (formato ISO 3166-1 alpha-2).  
    string  
  • descriptions  
     
    array<map<string,string>>  
  • englishdescription  
    Il nome inglese della forma giuridica dell'organizzazione.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • shortcut  
    Le scorciatoie localizzate del modulo di organizzazione legale.  
    array<map<string,string>>  
space space

Spazio

  • account_id
    Account ID  
    bigint  
  • address_city  
     
    string  
  • address_country  
     
    string  
  • address_dependentlocality  
     
    string  
  • address_emailaddress  
     
    string  
  • address_familyname  
     
    string  
  • address_givenname  
     
    string  
  • address_mobilephonenumber  
     
    string  
  • address_organizationname  
     
    string  
  • address_phonenumber  
     
    string  
  • address_postalstate  
     
    string  
  • address_postcode  
     
    string  
  • address_salestaxnumber  
     
    string  
  • address_salutation  
     
    string  
  • address_sortingcode  
     
    string  
  • address_street  
     
    string  
  • createdby  
    L'ID dell'utente che ha creato lo spazio.  
    bigint  
  • createdon  
    La data e l'ora di creazione dello spazio.  
    timestamp  
  • database_id  
     
    bigint  
  • deletedby  
    L'ID dell'utente che ha cancellato lo spazio.  
    bigint  
  • deletedon  
    La data e l'ora in cui lo spazio è stato eliminato.  
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • lastmodifieddate  
    La data e l'ora dell'ultima modifica dell'oggetto.  
    timestamp  
  • name  
    Il nome utilizzato per identificare lo spazio.  
    string  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • primarycurrency  
    La valuta utilizzata per visualizzare gli importi aggregati nello spazio.  
    string  
  • requestlimit  
    Il numero massimo di richieste API accettate entro due minuti. Questo limite può essere modificato solo con privilegi speciali.  
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • statechangeevent  
     
    string  
  • timezone  
    Il fuso orario utilizzato per pianificare ed eseguire i processi in background. Questo non influisce sulla formattazione delle date nell'interfaccia utente.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
spacereference spacereference

Space Reference

  • _db_id  
     
    int  
  • accountid  
     
    bigint  
  • billingaccountid  
     
    bigint  
  • createdon  
     
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • scopeid  
     
    bigint  
  • spaceid  
     
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
transaction transaction

Transazione

  • _db_id  
     
    int  
  • acceptheader  
    L'intestazione 'Accept' del browser web del cliente.  
    string  
  • acceptlanguageheader  
    L'intestazione 'Accept Language' del browser web del cliente.  
    string  
  • authorizationamount  
    La somma di tutti i prezzi delle voci, comprese le imposte, nella valuta della transazione.  
    decimal(19,8)  
  • authorizationenvironment  
    L'ambiente in cui è stata autorizzata la transazione.  
    string  
  • authorizationsaleschannel  
    Il canale di vendita attraverso il quale è stata effettuata la transazione.  
    bigint  
  • authorizationtimeouton  
    La data e l'ora in cui la transazione deve essere autorizzata, altrimenti verrà annullata.  
    timestamp  
  • authorizedon  
    La data e l'ora in cui la transazione è stata autorizzata.  
    timestamp  
  • autoconfirmationenabled  
    Se la transazione può essere confermata automaticamente o se deve essere fatta esplicitamente tramite l'API. L'impostazione predefinita è true.  
    boolean  
  • billingaddresscity  
     
    string  
  • billingaddresscommercialregisternumber  
     
    string  
  • billingaddresscountry  
     
    string  
  • billingaddressdateofbirth  
     
    string  
  • billingaddressdependentlocality  
     
    string  
  • billingaddressemailaddress  
     
    string  
  • billingaddressfamilyname  
     
    string  
  • billingaddressgender  
     
    string  
  • billingaddressgivenname  
     
    string  
  • billingaddressmobilephonenumber  
     
    string  
  • billingaddressorganizationform  
     
    bigint  
  • billingaddressorganizationname  
     
    string  
  • billingaddressphonenumber  
     
    string  
  • billingaddresspostalstate  
     
    string  
  • billingaddresspostcode  
     
    string  
  • billingaddresssalestaxnumber  
     
    string  
  • billingaddresssalutation  
     
    string  
  • billingaddresssocialsecuritynumber  
     
    string  
  • billingaddresssortingcode  
     
    string  
  • billingaddressstreet  
     
    string  
  • chargeretryenabled  
    Se il cliente può effettuare ulteriori tentativi di pagamento se il primo non è andato a buon fine. L'impostazione predefinita è true.  
    boolean  
  • completedamount  
    L'importo totale che è stato completato, nella valuta della transazione.  
    decimal(19,8)  
  • completedon  
    La data e l'ora in cui è stata completata la transazione.  
    timestamp  
  • completionbehavior  
    Il comportamento che controlla il completamento della transazione.  
    string  
  • completionretries  
     
    int  
  • completiontimeouton  
    La data e l'ora in cui la transazione viene completata automaticamente.  
    timestamp  
  • confirmedby  
    L'ID dell'utente che ha confermato la transazione.  
    bigint  
  • confirmedon  
    La data e l'ora di creazione della transazione.  
    timestamp  
  • createdby  
    L'ID dell'utente che ha creato la transazione.  
    bigint  
  • createdon  
    La data e l'ora di creazione dell'oggetto.  
    timestamp  
  • currency  
    Codice di tre lettere (formato ISO 4217) della valuta della transazione.  
    string  
  • customeremailaddress  
    Inserire l'indirizzo e-mail del cliente.  
    string  
  • customerid  
    L'identificativo univoco del cliente nel sistema esterno.  
    string  
  • customerspresence  
    La presenza del cliente indica se e in che modo il cliente della transazione è presente. L'impostazione predefinita è VIRTUAL_PRESENT.  
    string  
  • deliverydecisionmadeon  
    La data e l'ora in cui è stata presa la decisione di spedire l'ordine.  
    timestamp  
  • devicesessionidentifier  
    Permette di collegare la transazione ai dati raccolti dal dispositivo del cliente.  
    string  
  • emailsdisabled  
    Se l'invio di e-mail è disattivato per la transazione. L'impostazione predefinita è false.  
    boolean  
  • endoflife  
    La data e l'ora in cui la transazione raggiunge la fine dell'attività. In questo momento non è possibile eseguire ulteriori azioni.  
    timestamp  
  • environment  
     
    string  
  • environmentselectionstrategy  
    La strategia per determinare se la transazione deve essere elaborata nell'ambiente di test o di produzione.  
    string  
  • failedon  
    La data e l'ora in cui la transazione è fallita.  
    timestamp  
  • failedurl  
    L'URL a cui reindirizzare il cliente dopo l'annullamento o la mancata autenticazione del pagamento.  
    string  
  • failurereason  
    Il motivo del fallimento della transazione.  
    bigint  
  • group_id
    Transaction Group ID  
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • internetprotocoladdress  
    L'indirizzo IP del dispositivo del cliente.  
    string  
  • internetprotocoladdresscountry  
    Il paese determinato dall'indirizzo IP del dispositivo del cliente.  
    string  
  • invoicemerchantreference  
    Il riferimento dell'esercente utilizzato per identificare la fattura.  
    string  
  • javaenabled  
    Se Java è abilitato sul browser web del cliente.  
    boolean  
  • language  
    The language that is linked to the object.  
    string  
  • lastuseractivitydate  
     
    timestamp  
  • locktimeout  
     
    timestamp  
  • merchantreference  
    Il riferimento dell'esercente utilizzato per identificare la transazione.  
    string  
  • migration  
     
    int  
  • parent_id
    Transaction ID  
    bigint  
  • paymentconnectorconfiguration_id
    Payment Connector Configuration ID  
    bigint  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • processingon  
    La data e l'ora in cui è stata avviata l'elaborazione della transazione.  
    timestamp  
  • refundedamount  
    L'importo totale che è stato rimborsato, nella valuta della transazione.  
    decimal(19,8)  
  • screencolordepth  
    La profondità di colore dello schermo del browser web del cliente.  
    string  
  • screenheight  
    L'altezza dello schermo del browser web del cliente.  
    string  
  • screenwidth  
    La larghezza dello schermo del browser web del cliente.  
    string  
  • shippingaddresscity  
     
    string  
  • shippingaddresscommercialregisternumber  
     
    string  
  • shippingaddresscountry  
     
    string  
  • shippingaddressdateofbirth  
     
    string  
  • shippingaddressdependentlocality  
     
    string  
  • shippingaddressemailaddress  
     
    string  
  • shippingaddressfamilyname  
     
    string  
  • shippingaddressgender  
     
    string  
  • shippingaddressgivenname  
     
    string  
  • shippingaddressmobilephonenumber  
     
    string  
  • shippingaddressorganizationform  
     
    bigint  
  • shippingaddressorganizationname  
     
    string  
  • shippingaddressphonenumber  
     
    string  
  • shippingaddresspostalstate  
     
    string  
  • shippingaddresspostcode  
     
    string  
  • shippingaddresssalestaxnumber  
     
    string  
  • shippingaddresssalutation  
     
    string  
  • shippingaddresssocialsecuritynumber  
     
    string  
  • shippingaddressssortingcode  
     
    string  
  • shippingaddressstreet  
     
    string  
  • shippingmethod  
    Il nome del metodo di spedizione utilizzato per spedire i prodotti.  
    string  
  • spaceid  
     
    bigint  
  • spaceviewid  
    L'ID della vista dello spazio a cui questo oggetto è collegato.  
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • successurl  
    L'URL a cui reindirizzare il cliente dopo l'autenticazione del pagamento.  
    string  
  • terminal_id
    Payment Terminal ID  
    bigint  
  • timezone  
    Il fuso orario del cliente, che influisce sulla formattazione di date e orari nelle comunicazioni con il cliente.  
    string  
  • tokenizationmode  
    La modalità di tokenizzazione specifica se e come la tokenizzazione delle informazioni di pagamento viene applicata alla transazione.  
    string  
  • totalappliedfees  
    Il totale di tutte le commissioni addebitate, nella valuta della transazione.  
    decimal(19,8)  
  • totalsettledamount  
    L'importo totale che è stato regolato, nella valuta della transazione.  
    decimal(19,8)  
  • useragentheader  
    L'intestazione 'User Agent' del browser web del cliente.  
    string  
  • userfailuremessage  
    Il messaggio che può essere visualizzato al cliente per spiegare il motivo del fallimento della transazione, nella lingua del cliente.  
    string  
  • userinterfacetype  
    Il tipo di interfaccia utente utilizzata dal cliente per fornire le informazioni di pagamento.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
  • windowheight  
    L'altezza della finestra del browser web del cliente.  
    string  
  • windowwidth  
    La larghezza della finestra del browser web del cliente.  
    string  
  • yearstokeep  
    Il numero di anni in cui la transazione viene conservata dopo la sua autorizzazione.  
    int  
transactioninvoice transactioninvoice

Fattura della transazione

  • _db_id  
     
    int  
  • amount  
     
    decimal(19,8)  
  • billingaddresscity  
     
    string  
  • billingaddresscommercialregisternumber  
     
    string  
  • billingaddresscountry  
     
    string  
  • billingaddressdateofbirth  
     
    string  
  • billingaddressdependentlocality  
     
    string  
  • billingaddressemailaddress  
     
    string  
  • billingaddressfamilyname  
     
    string  
  • billingaddressgender  
     
    string  
  • billingaddressgivenname  
     
    string  
  • billingaddressmobilephonenumber  
     
    string  
  • billingaddressorganizationform  
     
    bigint  
  • billingaddressorganizationname  
     
    string  
  • billingaddressphonenumber  
     
    string  
  • billingaddresspostalstate  
     
    string  
  • billingaddresspostcode  
     
    string  
  • billingaddresssalestaxnumber  
     
    string  
  • billingaddresssalutation  
     
    string  
  • billingaddresssocialsecuritynumber  
     
    string  
  • billingaddresssortingcode  
     
    string  
  • billingaddressstreet  
     
    string  
  • completion_id
    Transaction Completion ID  
    bigint  
  • createdon  
    Data in cui è stata creata la fattura.  
    timestamp  
  • derecognizedby  
    L'id dell'utente che ha segnato la fattura come non riconosciuta.  
    bigint  
  • derecognizedon  
    La data in cui la fattura è contrassegnata come stornata.  
    timestamp  
  • dueon  
    Data in cui deve essere pagata la fattura.  
    timestamp  
  • externalid  
    L'ID esterno aiuta a identificare l'entità e una successiva creazione di un'entità con lo stesso ID non creerà una nuova entità.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • merchantreference  
     
    string  
  • outstandingamount  
    L’importo in sospeso indica quanto il cliente deve al commerciante. Un importo negativo significa che il cliente ha pagato troppo.  
    decimal(19,8)  
  • paidon  
    La data in cui la fattura è stata contrassegnata come saldata. È possibile che questa data sia precedente alla data di pagamento attuale.  
    timestamp  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • taxamount  
     
    decimal(19,8)  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
transactionlineitemversion transactionlineitemversion

Transaction Line Item Version

  • _db_id  
     
    int  
  • amount  
     
    decimal(19,8)  
  • authorizationamountincrease  
     
    decimal(19,8)  
  • createdby  
     
    bigint  
  • createdon  
    La data e l'ora di creazione dell'oggetto.  
    timestamp  
  • executedon  
     
    timestamp  
  • externalid  
    Un nonce generato dal client che identifica l'entità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece l'entità creata inizialmente.  
    string  
  • failedon  
     
    timestamp  
  • failurereason  
     
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • nextupdateon  
     
    timestamp  
  • plannedpurgedate  
    La data e l'ora in cui è prevista la rimozione definitiva dell'oggetto. Se il valore è vuoto, l'oggetto non verrà rimosso.  
    timestamp  
  • processingon  
     
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    Lo stato attuale dell'oggetto.  
    string  
  • succeededon  
     
    timestamp  
  • taxamount  
     
    decimal(19,8)  
  • timeouton  
     
    timestamp  
  • transaction_id
    Transaction ID  
    bigint  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
wallettype wallettype

Tipo di portafoglio. Wallet type details.

  • description  
    La descrizione localizzata dell'oggetto.  
    map<string,string>  
  • id  
    A unique identifier for the object.  
    bigint  
  • name  
    Il nome localizzato dell'oggetto.  
    map<string,string>