OperatorDto

The OperatorDto (Operator Data Transfer Object) defines the key attributes for a financial service provider (like a mobile money operator) integrated with the NoWallet API.
This DTO is essential for ensuring that the platform can communicate correctly with the operator, handling transaction processes, security requirements, and operational rules.

JSON Example

This sample configuration demonstrates how the MTN MONEY operator is set up. The JSON structure includes transaction codes for different methods (e.g., MERCHANT, CASHIN), the operator’s logo, and the phone number prefixes that the operator uses. It also includes settings for OTP (One-Time Password) and security levels for various transactions.

{
  "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": {}
}

Properties

• name: The full name of the operator (e.g., “MTN MONEY”). This helps users or systems identify the operator in the user interface or other operational contexts.
• codeoperator: The operator's short code (e.g., MTN). This is used in the backend for identifying the operator programmatically.
• logo: A URL pointing to the operator’s logo in PNG format. This is typically used to display the operator’s branding within the platform’s user interface.
• code: An object that maps each transaction method (MERCHANT, CASHIN, CASHOUT) to the operator-specific transaction codes. These codes are crucial for interacting with the operator’s system for each transaction type.
• startwith: An array containing the phone number prefixes (e.g., “01”, “02”) that are used to identify the operator’s users. This helps automate the process of detecting which operator a phone number belongs to.
• otpstarter: An object that specifies whether a One-Time Password (OTP) is needed for each transaction type (MERCHANT, CASHIN, CASHOUT). This field indicates if an additional security step is required for the transaction process.
• active: A boolean flag indicating whether the operator is currently active and available for use. Setting this to false would deactivate the operator in the system, preventing further transactions with it.
• secure: A reference to the SecureDto, which specifies the security settings (such as SMS or QR code verification) for each transaction type. This determines the required level of security for transactions involving the operator.
• instruction: An object that can store operator-specific instructions. This is useful for adding guidance or rules that apply to transactions with this operator. The object is empty in the provided example but can be filled with operational instructions or information for users and administrators.

Name	Type	Required	Restrictions	Description
name	string	true	none	operator name
codeoperator	string	true	none	operator code
logo	string	true	none	operator logo image png format
code	object	true	none	operator methode code
startwith	array	true	none	operator phone number start with list
otpstarter	object	true	none	operator need otp
active	boolean	true	none	check if operator is active or inactive
secure	SecureDto	true	none	operator process mode
instruction	object	true	none	operator instructions

This DTO is fundamental for integrating and configuring financial operators within the NoWallet system. It provides detailed control over how each operator interacts with the platform, including transaction types, security levels, and phone number identification.

Was this page helpful?