Documentation
Documentation
Schéma d'analyse BETA
account account

Compte

  • accounttype  
     
    string  
  • createdby  
    L'ID de l'utilisateur par lequel le compte a été créé.  
    bigint  
  • createdon  
    La date et l'heure de la création du compte.  
    timestamp  
  • deletedby  
    L'ID d'un utilisateur par lequel le compte a été supprimé.  
    bigint  
  • deletedon  
    La date et l'heure auxquelles le compte a été supprimé.  
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • lastmodifieddate  
    La date et l'heure de la dernière modification de l'objet.  
    timestamp  
  • name  
    Nom utilisé pour identifier le compte  
    string  
  • parentaccount_id
    Parent account ID  
    bigint  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • scope_id
    Scope ID  
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • statechangeevent  
     
    string  
  • subaccountlimit  
    Nombre de sous-comptes pouvant être créés au sein de ce compte.  
    bigint  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
banktransaction banktransaction

Transaction bancaire

  • _db_id  
     
    int  
  • amountsnormalized  
     
    int  
  • banktransactiontype  
     
    bigint  
  • createdby  
    L'ID de l'utilisateur par lequel la transaction bancaire a été créée.  
    bigint  
  • createdon  
    La date et l'heure de création de l'objet.  
    timestamp  
  • currencybankaccount_id  
     
    bigint  
  • externalid  
    Un nonce généré par le client qui identifie l'entité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront l'entité initialement créée.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • paymentdate  
    La date de paiement indique la date à laquelle le paiement a été traité.  
    timestamp  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • postingamount  
    Le montant comptable fait référence à la valeur monétaire enregistrée pour la transaction bancaire avant tout ajustement.  
    decimal(19,8)  
  • reference  
    Une référence unique pour identifier la transaction bancaire.  
    string  
  • source  
    La source indique comment la transaction bancaire a été créée.  
    bigint  
  • spaceid  
     
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • valueamount  
    Le montant de la valeur représente la valeur monétaire nette de la transaction après les déductions applicables.  
    decimal(19,8)  
  • valuedate  
    La date de valeur indique la date à laquelle le montant de la transaction devient effectif.  
    timestamp  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
charge charge

Débit

  • _db_id  
     
    int  
  • createdon  
    La date et l'heure de création de l'objet.  
    timestamp  
  • failurereason  
    La raison de l'échec de l'accusation.  
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • timeouton  
    La date et l'heure d'expiration de la taxe.  
    timestamp  
  • transaction_id  
     
    bigint  
  • type  
    Le type spécifiant comment le client a été facturé.  
    string  
  • userfailuremessage  
    Le message qui peut être affiché au client expliquant la raison de l'échec du prélèvement, dans la langue du client.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
chargeattempt chargeattempt

Tentative d’inscription au débit

  • _db_id  
     
    int  
  • charge_id
    Identifiant de Charge  
    bigint  
  • completionbehavior  
    Le comportement qui contrôle la fin de la transaction.  
    string  
  • connectorconfiguration_id
    Connector Configuration ID  
    bigint  
  • connectorplugin  
     
    bigint  
  • connectorprocessingresulttype  
     
    string  
  • createdon  
    La date et l'heure de création de l'objet.  
    timestamp  
  • customerspresence  
    La présence du client indique si et de quelle manière le client de la tentative de prélèvement est présent.  
    string  
  • environment  
    L'environnement dans lequel la tentative d'inculpation est exécutée.  
    string  
  • failedon  
    La date et l'heure de l'échec de la tentative de chargement.  
    timestamp  
  • failurereason  
    La raison de l'échec de la tentative d'inculpation.  
    bigint  
  • httpmessagebody  
     
    binary  
  • httpmessageheaders  
     
    binary  
  • httpmessagestatuscode  
     
    int  
  • id  
    A unique identifier for the object.  
    bigint  
  • initializingtokenversion  
    Indique si une nouvelle version du jeton est en cours d'initialisation.  
    boolean  
  • invocation_id  
     
    bigint  
  • nextupdateon  
    Date et heure auxquelles la prochaine mise à jour de l'état de l'objet est prévue.  
    timestamp  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • redirectionurl  
    URL vers laquelle rediriger le client après le traitement du paiement.  
    string  
  • saleschannel  
    Le canal de vente par lequel la tentative de prélèvement a été effectuée.  
    bigint  
  • spaceid  
     
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • succeededon  
    La date et l'heure auxquelles la tentative de charge a réussi.  
    timestamp  
  • terminal_id
    Payment Terminal ID  
    bigint  
  • timeouton  
    Date et heure d'expiration de l'objet.  
    timestamp  
  • tokenversion_id  
     
    bigint  
  • userfailuremessage  
    Le message qui peut être affiché au client expliquant pourquoi la tentative de prélèvement a échoué, dans la langue du client.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
  • wallet  
    Le type de portefeuille utilisé pour effectuer la tentative de prélèvement.  
    bigint  
customer customer

Client

  • _db_id  
     
    int  
  • createdon  
    La date et l'heure de création de l'objet.  
    timestamp  
  • customerid  
    L'identifiant du client dans le système du commerçant.  
    string  
  • emailaddress  
    L'adresse électronique du client.  
    string  
  • familyname  
    Le nom de famille du client.  
    string  
  • givenname  
    Le nom ou le prénom du client.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • language  
    The language that is linked to the object.  
    string  
  • preferredcurrency  
    La devise préférée du client.  
    string  
  • spaceid  
     
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
legalorganizationform legalorganizationform

Forme juridique. Legal organization form details

  • country  
    Code à deux lettres du pays dans lequel la forme d'organisation juridique est utilisée (format ISO 3166-1 alpha-2).  
    string  
  • descriptions  
     
    array<map<string,string>>  
  • englishdescription  
    Le nom anglais de la forme d'organisation légale.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • shortcut  
    Les raccourcis localisés de la forme d'organisation juridique.  
    array<map<string,string>>  
space space

Space

  • 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 de l'utilisateur qui a créé l'espace.  
    bigint  
  • createdon  
    La date et l'heure de création de l'espace.  
    timestamp  
  • database_id  
     
    bigint  
  • deletedby  
    L'ID de l'utilisateur qui a supprimé l'espace.  
    bigint  
  • deletedon  
    La date et l'heure auxquelles l'espace a été supprimé.  
    timestamp  
  • id  
    A unique identifier for the object.  
    bigint  
  • lastmodifieddate  
    La date et l'heure de la dernière modification de l'objet.  
    timestamp  
  • name  
    Nom utilisé pour identifier l'espace.  
    string  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • primarycurrency  
    La devise utilisée pour afficher les montants agrégés dans l'espace.  
    string  
  • requestlimit  
    Nombre maximal de demandes d'API acceptées en deux minutes. Cette limite ne peut être modifiée qu'avec des privilèges spéciaux.  
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • statechangeevent  
     
    string  
  • timezone  
    Le fuseau horaire utilisé pour planifier et exécuter les processus d'arrière-plan. Cela n'affecte pas le formatage des dates dans l'interface utilisateur.  
    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 date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • scopeid  
     
    bigint  
  • spaceid  
     
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
transaction transaction

Transaction

  • _db_id  
     
    int  
  • acceptheader  
    L'en-tête "Accept" du navigateur web du client.  
    string  
  • acceptlanguageheader  
    L'en-tête "Accept Language" du navigateur web du client.  
    string  
  • authorizationamount  
    La somme de tous les prix des postes, taxes comprises, dans la devise de la transaction.  
    decimal(19,8)  
  • authorizationenvironment  
    L'environnement dans lequel la transaction a été autorisée.  
    string  
  • authorizationsaleschannel  
    Le canal de vente par lequel la transaction a été effectuée.  
    bigint  
  • authorizationtimeouton  
    La date et l'heure auxquelles la transaction doit être autorisée, sinon elle sera annulée.  
    timestamp  
  • authorizedon  
    La date et l'heure auxquelles la transaction a été autorisée.  
    timestamp  
  • autoconfirmationenabled  
    Indique si la transaction peut être confirmée automatiquement ou si cela doit être fait explicitement via l'API. La valeur par défaut est 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  
    Indique si le client peut effectuer d'autres tentatives de paiement si la première a échoué. La valeur par défaut est true.  
    boolean  
  • completedamount  
    Le montant total qui a été réalisé, dans la devise de la transaction.  
    decimal(19,8)  
  • completedon  
    La date et l'heure auxquelles la transaction a été effectuée.  
    timestamp  
  • completionbehavior  
    Le comportement qui contrôle la fin de la transaction.  
    string  
  • completionretries  
     
    int  
  • completiontimeouton  
    La date et l'heure auxquelles la transaction est terminée automatiquement.  
    timestamp  
  • confirmedby  
    L'ID de l'utilisateur par lequel la transaction a été confirmée.  
    bigint  
  • confirmedon  
    La date et l'heure auxquelles la transaction a été créée.  
    timestamp  
  • createdby  
    L'ID de l'utilisateur par lequel la transaction a été créée.  
    bigint  
  • createdon  
    La date et l'heure de création de l'objet.  
    timestamp  
  • currency  
    Code à trois lettres (format ISO 4217) de la devise de la transaction.  
    string  
  • customeremailaddress  
    L'adresse électronique du client.  
    string  
  • customerid  
    L'identifiant unique du client dans le système externe.  
    string  
  • customerspresence  
    La présence du client indique si le client de la transaction est présent et de quelle manière. La valeur par défaut est VIRTUAL_PRESENT.  
    string  
  • deliverydecisionmadeon  
    Date et heure auxquelles la décision a été prise d'expédier ou non la commande.  
    timestamp  
  • devicesessionidentifier  
    Permet de lier la transaction aux données collectées sur l'appareil du client.  
    string  
  • emailsdisabled  
    Indique si l'envoi d'e-mails est désactivé pour la transaction. La valeur par défaut est false.  
    boolean  
  • endoflife  
    La date et l'heure à laquelle la transaction atteint sa fin de vie. Aucune autre action ne peut être effectuée à ce moment-là.  
    timestamp  
  • environment  
    L'environnement utilisé pour le rendu des ressources.  
    string  
  • environmentselectionstrategy  
    La stratégie permettant de déterminer si la transaction doit être traitée dans l'environnement de test ou de production.  
    string  
  • failedon  
    Date et heure de l'échec de la transaction.  
    timestamp  
  • failedurl  
    URL vers laquelle rediriger le client après l'annulation ou l'échec de l'authentification de son paiement.  
    string  
  • failurereason  
    La raison de l'échec de la transaction.  
    bigint  
  • group_id
    Transaction Group ID  
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • internetprotocoladdress  
    L'adresse IP de l'appareil du client.  
    string  
  • internetprotocoladdresscountry  
    Le pays déterminé à partir de l'adresse IP de l'appareil du client.  
    string  
  • invoicemerchantreference  
    Référence du commerçant utilisée pour identifier la facture.  
    string  
  • javaenabled  
    Si Java est activé sur le navigateur web du client.  
    boolean  
  • language  
    The language that is linked to the object.  
    string  
  • lastuseractivitydate  
     
    timestamp  
  • locktimeout  
     
    timestamp  
  • merchantreference  
    Référence du commerçant utilisée pour identifier la transaction.  
    string  
  • migration  
     
    int  
  • parent_id
    Transaction ID  
    bigint  
  • paymentconnectorconfiguration_id
    Payment Connector Configuration ID  
    bigint  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • processingon  
    La date et l'heure auxquelles le traitement de la transaction a commencé.  
    timestamp  
  • refundedamount  
    Le montant total remboursé, dans la devise de la transaction.  
    decimal(19,8)  
  • screencolordepth  
    La profondeur de couleur de l'écran du navigateur web du client.  
    string  
  • screenheight  
    La hauteur de l'écran du navigateur web du client.  
    string  
  • screenwidth  
    Largeur de l'écran du navigateur web du client.  
    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  
    Le nom de la méthode d'expédition utilisée pour expédier les produits.  
    string  
  • spaceid  
     
    bigint  
  • spaceviewid  
    L'ID de la vue de l'espace à laquelle cet objet est lié.  
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • successurl  
    L'URL vers laquelle le client doit être redirigé après avoir authentifié son paiement.  
    string  
  • terminal_id
    Payment Terminal ID  
    bigint  
  • timezone  
    Le fuseau horaire du client, qui affecte la façon dont les dates et les heures sont formatées lors de la communication avec le client.  
    string  
  • tokenizationmode  
    Le mode de symbolisation spécifie si et comment la symbolisation des informations de paiement est appliquée à la transaction.  
    string  
  • totalappliedfees  
    Le total de tous les frais facturés, dans la devise de la transaction.  
    decimal(19,8)  
  • totalsettledamount  
    Le montant total qui a été réglé, dans la devise de la transaction.  
    decimal(19,8)  
  • useragentheader  
    L'en-tête "User Agent" du navigateur web du client.  
    string  
  • userfailuremessage  
    Le message qui peut être affiché au client expliquant pourquoi la transaction a échoué, dans la langue du client.  
    string  
  • userinterfacetype  
    Le type d'interface utilisateur que le client a utilisé pour fournir les informations de paiement.  
    string  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
  • windowheight  
    La hauteur de la fenêtre du navigateur web du client.  
    string  
  • windowwidth  
    Largeur de la fenêtre du navigateur web du client.  
    string  
  • yearstokeep  
    Le nombre d'années pendant lesquelles la transaction est conservée après son autorisation.  
    int  
transactioninvoice transactioninvoice

Facture

  • _db_id  
     
    int  
  • amount  
    La somme totale de tous les postes de la facture, y compris les taxes.  
    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  
    La date et l'heure de création de l'objet.  
    timestamp  
  • derecognizedby  
    L'ID de l'utilisateur par lequel la facture a été décomptabilisée.  
    bigint  
  • derecognizedon  
    La date et l'heure auxquelles la facture a été décomptabilisée, ce qui signifie qu'elle n'est plus considérée comme en suspens ou valide dans le système.  
    timestamp  
  • dueon  
    La date d'échéance pour le paiement de la facture.  
    timestamp  
  • externalid  
    Un nonce généré par le client qui identifie de manière unique une action à exécuter. Les demandes ultérieures avec le même identifiant externe n'exécutent pas à nouveau l'action, mais renvoient le résultat original.  
    string  
  • id  
    A unique identifier for the object.  
    bigint  
  • merchantreference  
    Référence du commerçant utilisée pour identifier la facture.  
    string  
  • outstandingamount  
    Le montant restant que l'acheteur doit au commerçant. Une valeur négative indique que la facture a été payée en trop.  
    decimal(19,8)  
  • paidon  
    Date et heure auxquelles la facture a été enregistrée comme payée. Cette date peut différer de la date réelle de paiement en raison des délais de traitement.  
    timestamp  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • taxamount  
    La partie du montant facturé qui correspond aux taxes.  
    decimal(19,8)  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
transactionlineitemversion transactionlineitemversion

Version des articles

  • _db_id  
     
    int  
  • amount  
    Le montant total des postes mis à jour, y compris les taxes.  
    decimal(19,8)  
  • authorizationamountincrease  
     
    decimal(19,8)  
  • createdby  
    L'ID de l'utilisateur qui a créé la version du poste.  
    bigint  
  • createdon  
    La date et l'heure de création de l'objet.  
    timestamp  
  • executedon  
     
    timestamp  
  • externalid  
    Un nonce généré par le client qui identifie de manière unique une action à exécuter. Les demandes ultérieures avec le même identifiant externe n'exécutent pas à nouveau l'action, mais renvoient le résultat original.  
    string  
  • failedon  
    Date et heure de l'échec du traitement de la version du poste.  
    timestamp  
  • failurereason  
     
    bigint  
  • id  
    A unique identifier for the object.  
    bigint  
  • nextupdateon  
    Date et heure auxquelles la prochaine mise à jour de l'état de la version du poste est prévue.  
    timestamp  
  • plannedpurgedate  
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.  
    timestamp  
  • processingon  
    Date et heure de début du traitement de la version du poste.  
    timestamp  
  • spaceid  
     
    bigint  
  • state  
    L'état actuel de l'objet.  
    string  
  • succeededon  
    Date et heure auxquelles la version du poste a été traitée avec succès.  
    timestamp  
  • taxamount  
    La partie du montant total qui correspond aux impôts.  
    decimal(19,8)  
  • timeouton  
    Date et heure auxquelles la version du poste doit être traitée.  
    timestamp  
  • transaction_id
    Transaction ID  
    bigint  
  • version  
    The version is used for optimistic locking and incremented whenever the object is updated.  
    int  
wallettype wallettype

Type de portefeuille. Wallet type details.

  • description  
    La description localisée de l'objet.  
    map<string,string>  
  • id  
    A unique identifier for the object.  
    bigint  
  • name  
    Le nom localisé de l'objet.  
    map<string,string>