OperatorDto

Le OperatorDto (Data Transfer Object de l’opérateur) définit les attributs clés d’un fournisseur de services financiers (comme un opérateur de mobile money) intégré à l’API NoWallet.
Ce DTO est essentiel pour permettre à la plateforme de communiquer correctement avec l’opérateur, en gérant les processus de transaction, les exigences de sécurité et les règles opérationnelles.

Exemple JSON

Cette configuration JSON montre comment l’opérateur MTN MONEY est défini. La structure inclut les codes de transaction pour différentes méthodes (par exemple, MERCHANT, CASHIN), le logo de l’opérateur, ainsi que les préfixes téléphoniques utilisés. Elle comprend également les paramètres liés à l'OTP (mot de passe à usage unique) et aux niveaux de sécurité pour chaque type de transaction.

{
  "name": "MTN MONEY",
  "codeoperator": "MTN",
  "logo": "https://www.example.com/assets/img/MTN.png",
  "code": {
    "MERCHANT": "ORANGEMONEYMERCHANTCODE",
    "CASHIN": "ORANGEMONEYCASHINCODE",
    "CASHOUT": "none"
  },
  "startwith": ["01", "02"],
  "otpstarter": {
    "MERCHANT": false,
    "CASHIN": false,
    "CASHOUT": false
  },
  "active": true,
  "secure": {
    "MERCHANT": false,
    "CASHIN": false,
    "CASHOUT": false
  },
  "instruction": {}
}

Propriétés

• name: Le nom complet de l’opérateur (ex. : “MTN MONEY”). Il permet aux utilisateurs ou aux systèmes d’identifier l’opérateur dans l’interface ou dans d’autres contextes opérationnels.
• codeoperator: Le code court de l’opérateur (ex. : MTN). Cela est utilisé dans le backend pour identifier l’opérateur de manière programmatique.
• logo: Une URL pointant vers le logo de l’opérateur au format PNG. Cela est généralement utilisé pour afficher la marque de l’opérateur dans l’interface utilisateur de la plateforme.
• code: Un objet qui mappe chaque méthode de transaction (MERCHANT, CASHIN, CASHOUT) aux codes de transaction spécifiques à l’opérateur. Ces codes sont cruciaux pour interagir avec le système de l’opérateur pour chaque type de transaction.
• startwith: Un tableau contenant les préfixes de numéros de téléphone (ex. : “01”, “02”) qui sont utilisés pour identifier les utilisateurs de l’opérateur. Cela aide à automatiser le processus de détection de l’opérateur auquel appartient un numéro de téléphone.
• otpstarter: Un objet qui spécifie si un mot de passe à usage unique (OTP) est nécessaire pour chaque type de transaction (MERCHANT, CASHIN, CASHOUT). Ce champ indique si une étape de sécurité supplémentaire est requise pour le processus de transaction.
• active: Un indicateur booléen indiquant si l’opérateur est actuellement actif et disponible pour utilisation. Le fait de définir cela sur false désactiverait l’opérateur dans le système, empêchant d’autres transactions avec lui.
• secure: Une référence au SecureDto, qui spécifie les paramètres de sécurité (tels que la vérification par SMS ou QR code) pour chaque type de transaction. Cela détermine le niveau de sécurité requis pour les transactions impliquant l’opérateur.
• instruction: Un objet qui peut stocker des instructions spécifiques à l’opérateur. Cela est utile pour ajouter des conseils ou des règles qui s’appliquent aux transactions avec cet opérateur. L’objet est vide dans l’exemple fourni mais peut être rempli avec des instructions opérationnelles ou des informations pour les utilisateurs et les administrateurs.

Name	Type	Required	Restrictions	Description
name	string	true	aucune	nom de l’opérateur
codeoperator	string	true	aucune	code de l’opérateur
logo	string	true	aucune	image du logo de l’opérateur au format png
code	object	true	aucune	code de méthode de l’opérateur
startwith	array	true	aucune	liste des préfixes de numéros de téléphone de l’opérateur
otpstarter	object	true	aucune	l’opérateur nécessite un OTP
active	boolean	true	aucune	vérifier si l’opérateur est actif ou inactif
secure	SecureDto	true	aucune	mode de traitement de l’opérateur
instruction	object	true	aucune	instructions de l’opérateur

Cette structure permet des configurations de frais précises adaptées à différents contextes régionaux et opérationnels, ce qui la rend hautement flexible pour divers marchés africains.

Cette page vous a-t-elle été utile ?