Table des matières
| Table of Contents |
|---|
About This Guide
This guide serves as a reference for the format and content of reports generated and provided through the Axepta BNP Paribas Smart Data product.
Target Audience
This document is intended for technical personnel who will retrieve and analyze the reports generated by Axepta BNP Paribas Smart Data.
Data Formats
| Format | Description |
|---|---|
a | Alphabetic |
as | Alphabetic with special characters |
n | Numeric |
an | Alphanumeric |
ans | Alphanumeric with special characters |
ns | Numeric with spécial characters |
bool | Boolean expression (true or false) |
3 | Fixed length with 3 digits/characters |
..3 | Variable length with a maximum of 3 digits/characters |
enum | Enumeration of admissible values |
dttm | ISO date and time (YYYY-MM-DDThh:mm:ss) |
Definitions
Payment/ | Veuillez noter que les termes « paiement » et « transaction » sont utilisés de façon interchangeable dans le présent document. Un paiement – ou une transaction – peut englober un certain nombre d'activités opérationnelles. Dans un cycle de vie de transaction, le statut de la transaction change en fonction de l'action effectuée. Parmi ces actions figurent l'autorisation, la saisie, la vente, l'annulation et le remboursement. Une transaction est ainsi définie comme une séquence d'actions. |
Action | Une action consiste en une opération qui modifie le statut d'un paiement lorsqu'elle est exécutée avec succès. |
Job | Dans le cadre de BNP Smart Data, un job inclut un ensemble d'informations générales sur la présentation du rapport, les options de filtrage et les champs de données. |
Task | Une tâche constitue la représentation réelle d'un job avec un temps d'exécution attribué. |
Présentation du produit
BNP Smart Data est un service automatisé conçu pour créer un ou plusieurs rapport(s) prédéfini(s) mis à disposition dans le compte FTP d'un commerçant ou via le Backoffice à des fins de récupération. Ce service permet aux commerçants de programmer des rapports périodiques en fonction de leurs besoins individuels.
Les rapports Smart Data sont fournis sous forme de fichiers texte délimités (CSV) avec un ensemble standard de champs de données par défaut. Les commerçants ont néanmoins la possibilité de personnaliser leurs rapports en sélectionnant les champs de l'ensemble standard qu'ils souhaitent inclure. Les enregistrements peuvent englober des données relatives à des transactions effectuées entre un jour et maximum un an avant la date du rapport. À noter que les données en temps réel ne sont pas prises en charge par ce produit.
Pour toute configuration individuelle, veuillez contacter le service d'assistance BNP.
Please note that the terms payment and transaction are used interchangeably throughout this document. A payment respectively a transaction may encompass a number of operational activities. During a transaction lifecycle, the state of a transaction will change, depending on the performed action. These actions may include authorization, capture, sale, cancel and refund. A transaction is thereby defined as a sequence of actions. | |
Action | An action is an operation that changes the status of a payment when performed successfully. |
Job | In the context of Smart Data a job contains a set of general information about the report layout, filter options and data fields. |
Task | A task is the actual representation of a job with an assigned execution time. |
Product Overview
Smart Data is an automated service designed to create one or more predefined reports that are made available in a merchant’s FTP account or via back-Office for retrieval. The service enables merchants to schedule periodic reports according to their individual needs.
Smart Data reports are delivered as delimited text files (CSV) with a standard set of data fields by default. Merchants however may customize their reports by choosing the fields from the standard set they would like have included. Data records may encompass transactions between one day and maximum one year prior to the report date. Please note that real-time data are not supported through this product.
For individual setup and configuration please contact BNP Paribas assistance.
Report Filter
The following filter options are available:
- MerchantID
- Company
- Currency
- Payment Method
- Payment Status
- Card Brand
- Action
- Successful transactions only
- Unsuccessfull transactions only
- Only transactions with specific Code/s,
- Only transactions without specific Code/s
Please note that all filter options may contain multiple values.
Report Schedule
Smart Data reports can be setup according to the following options:
Once-off Report
- Given time period between two dates
Periodic Reports
- Daily
- Weekly (weekday of delivery at merchant’s discretion)
- Monthly (on 1st, 2nd, 3rd, ... each month)
File Layout
Smart Data reports are created as plain text files in CSV format. Currently comma, tab and colon are supported delimiters to separate values (please contact for individual setup). The default delimiter is colon unless specified otherwise.
Each file will contain an initial header row and zero or more data rows. A header row will consist of a separated list of the individual field names, as defined in this document, in the specified order. The field names of the header row are currently available in English and German. The data rows will consist of a separated list of the data field values that contain characters encoded in UTF-8.
Security
For security reasons all files are PGP encrypted and transferred via SFTP or available in the Back-Office.
| Info |
|---|
The files will be automatically deleted from the Axepta sFTP server after 14 days. The reconciliation file is generated only when transactions are processed. |
File Names
The file names are assigned according to the following convention
Filtrage des rapports
Les options de filtrage suivantes sont disponibles :
- MerchantID
- Société
- Devise
- Mode de paiement
- Statut du paiement
- Marque de la carte
- Action
- Uniquement les transactions réussies
- Uniquement les transactions non réussies
- Uniquement les transactions avec code(s) spécifique(s)
- Uniquement les transactions sans code(s) spécifique(s)
Veuillez noter que toutes les options de filtrage sont susceptibles de contenir plusieurs valeurs.
Planification des rapports
Les rapports Smart Data peuvent être configurés selon les options suivantes :
Rapport unique
- Période donnée entre deux dates
Rapports périodiques
- Tous les jours
- Toutes les semaines (jour de livraison en semaine à la seule discrétion du commerçant)
- Tous les mois (le 1er, le 2, le 3, ... du mois)
Format de fichiers
Les rapports BNP Smart Data sont créés dans des fichiers CSV sous forme de texte brut. Les virgules, les tabulations et les deux points sont des séparateurs pris en charge pour séparer des valeurs (pour toute configuration individuelle, veuillez contacter le service d'assistance BNP). Sauf indication contraire, les deux points sont utilisés comme séparateur par défaut.
Chaque fichier contiendra une première ligne d'en-tête et zéro ou plusieurs ligne(s) de données. Une ligne d'en-tête sera constituée d'une liste séparée des différents noms de champs, tels que définis dans le présent document, dans la commande spécifiée. Les noms des champs de la ligne d'en-tête sont actuellement disponibles en anglais et en allemand. Les lignes de données consistent en une liste séparée des valeurs des champs de données qui contiennent des caractères codés en UTF-8.
Sécurité
Pour des raisons de sécurité, tous les fichiers sont chiffrés (PGP) et transférés via SFTP ou disponibles dans le Back-Office.
| Info |
|---|
Les fichiers seront automatiquement supprimés du serveur sFTP Axepta après 14 jours. Le fichier de réconciliation est généré uniquement lorsque des transactions sont effectuées. |
Noms de fichier
Les noms de fichiers sont attribués selon la convention suivante : BNPSmartData_[JobID]_[TaskID]_[AAAAMMJJYYYYMMDD_hhmmss].CSV.pgp
Les différents éléments du nom sont décrits dans le tableau ci-dessousThe individual name elements are described in the table below.
# | ÉlémentElement | Format | ExempleExample |
|---|---|---|---|
1 | PréfixePrefix | a12 | BNPSmartData |
2 | JobID | n..10 | Identifiant interne du Internal job identifier |
3 | TaskID | n..10 | Identifiant interne de la tâcheInternal task identifier |
4 | HorodatageTimestamp | an15 | AAAAMMJJYYYYMMDD_hhmmss |
Exemple de nom de fichier valide A valid file name example is : BNPSmartData_12_789_20160320_023609.CSV.pgp
Data Records and Field Description
Each record represents an operation/action that has been performed on a payment. Regularly a payment will consist of multiple operation records. Available data fields are listed in the table below. Individual data fields can be omitted on request.
# | Parameter |
|---|
Enregistrements de données et description des champs
Chaque enregistrement représente une opération/action effectuée sur un paiement. En règle générale, un paiement se compose de plusieurs enregistrements d'opérations. Les champs de données disponibles sont répertoriés dans le tableau ci-dessous. Les champs de données individuels peuvent être omis sur demande.
# | Paramètre | Format | Description | |||
|---|---|---|---|---|---|---|
01 | PaymentID | an..32 | Identifiant de paiement généré par la plate-forme de paiementPayment identifier generated by Axepta BNP Paribas | |||
02 | MerchantID | an..20 | Identifiant de commerçant attribué par BNPMerchant identifier assigned by Axepta BNP Paribas during the onboarding phase | |||
03 | Payment Date | ans19 | Horodatage de l'heure de création du paiement : JJTimestamp of payment creation time: DD.MM. | AAAA YYYY hh:mm:ss | ||
04 | TransID | ans..64 | Identifiant de transaction attribué par le commerçant au niveau du paiementTransaction identifier assigned by the merchant on payment level | |||
05 | RefNr | ans..12 | Identifiant de transaction supplémentaire attribué par le commerçant au niveau du paiementSupplementary transaction identifier assigned by merchant on payment level | |||
06 | Amount Auth | n..10 | Montant autorisé dans la plus petite unité de la devise de transactionAuthorized amount in its smallest unit of transaction currency | |||
07 | Amount Cap | n..10 | Montant saisi dans la plus petite unité de la devise de transactionCaptured amount in its smallest unit of transaction currency | |||
08 | Amount Cred | n..10 | Montant remboursé dans la plus petite unité de la devise de transactionRefunded amount in its smallest unit of transaction currency | |||
09 | Currency | a3 | Code pour la devise, trois caractères ISO 4217 three-letter currency code | |||
10 | Payment Status | a..30 | Statut de la transaction avec l'une des valeurs suivantes Transaction status with one of the following values: · AUTHORIZED · CANCELED · CAPTURE_REQUEST · CREDIT_REQUEST · FAILED · OK · PENDING · SUCCESS | Veuillez noter que les valeurs de statut susmentionnées ne sont pas exhaustives et peuvent varier en fonction du mode de paiementPlease note that the above listed status values are not exhaustive and may vary depending on the payment method. | ||
11 | Payment Method | ans..64 | Mode de paiement (par ex. carte, PayPal, Payment method (e.g. Barzahlen, Card, PayPal etc.) | |||
12 | Card Brand | a..22 | Système de cartes (par exCard scheme (e.g. Visa, MasterCard, Maestro | , etc.) | ||
13 | Country of Origin Card A2 | a..2 | Pays d'origine selon Country of origin according to BIN/IIN (2 | caractères ou characters or n/a, | par exe.g. DE) | |
14 | Country of Origin Card | A3 A3 | a..3 | Pays d'origine selon Country of origin according to BIN/IIN (3 | caractères ou characters or n/a, | par exe.g. DEU) |
15 | Country of Origin Card N3 | an..3 | Pays d'origine selon Country of origin according to BIN/IIN (3 | chiffres ou digits or n/a, | par exe.g. 276) | |
16 | Card Number | an..19 | Numéro de carte masquéMasked card number | |||
17 | Card Token | n..19 | Token de carte généré par la plate-forme de paiementCard token generated by Axepta BNP Paribas | |||
18 | Expiry | Datedate | n6 | Date d'expiration de la carte de crédit au format aaaaMM, par exCredit card's expiry date in the format yyyyMM, e.g. 202005 | ||
19 | Approval | Codecode | an6 | Code d'autorisation de laAuthorisation code of the transaction | ||
20 | Cardholder Name | ans..60 | Nom du titulaire de la carteName of cardholder | |||
21 | CardType | ans..64 | Type de carte, par ex. crédit, débit, prépayéeCard type, e.g. Credit, Debit, Prepaid,... | |||
22 | Category (Card) | ans..64 | Catégorie de carte de crédit, par ex. standard, businessCredit card category, e.g. Standard, Business,... | |||
23 | SubBrand | a..22 | CardBrand2 | ou sousor Sub- | marqueBrand | |
24 | BIN | n6..11 | Numéro d'identification bancaireBank Identification Number | |||
25 | TerminalID | an8 | ID | des Terminauxof the terminal | ||
26 | CardAcceptorID | n5..12 | Numéro de partenaire contractuelContract partner number | |||
27 | Acquirer Name | an3 | Shortcode de l'acquéreurAcquirer shortcode | |||
28 | IBAN | an..30 | Numéro de compte bancaire internationalInternational Bank Account Number | |||
29 | BIC | an..11 | ISO 9362 Business Identifier Code | d'identification des banques|||
30 | User Data | ans..256 | Données personnalisées du commerçant qui sont incluses dans la réponse et qui pourraient être transmises à l'hôte de traitement suivant en fonction de l'acquéreur et des dispositions spécifiquesCustom merchant data that are included in the response and that might get conveyed to the subsequent processing host depending on the acquirer and custom arrangements | |||
31 | OrderDesc | an..768 | Description de la commandeOrder description | |||
| 32 | ActionID | an..64 | Identifiant d'action univoque attribué par la plate-forme de paiementUnique action identifier assigned by Axepta BPN Paribas Online | |||
| 33 | Payment Action | a..30 | Action effectuée pour le paiementSpecifies the action performed on the payment | |||
| 34 | Action Date | ans19 | Horodatage de l'action : JJTimestamp of the action: DD.MM. | AAAA YYYY hh:mm:ss | ||
35 | Numéro de référence (transactionReference number (Transaction) | ans..30 | ID de transaction supplémentaire du marchand au niveau de l'action | 36 | Information du titulaire de carte 1 (transactionAdditional Transactions-ID from the merchant on action level | |
36 | Card holder information 1 (Transaction) | ans..64 | Texte imprimé sur la facture de carte de crédit du client à côté du bénéficiaire | 37 | Text printed on the customer’s credit card bill alongside the payee | |
| 37 | Card holder information 2 (Transaction | Information du titulaire de carte 2 (transaction) | ans..64 | Texte imprimé sur la facture de carte de crédit du client à côté du bénéficiaireText printed on the customer’s credit card bill alongside the payee | ||
38 | Response Code | n8 | Code de réponse Paygateresponse code | |||
39 | Action Status | a..50 | Statut reçu pour l'action exécutéeStatus received on the performed action | |||
40 | Action Amount | n..10 | Montant de l’opération dans la plus petite unité de la devise de transactionOperation amount in its smallest unit of transaction currency | |||
41 | Code Description | an..1024 | Description du code d'erreurError code description |