3.5.4 Adding free credit on signup
- Former user (Deleted)
The feature allows to add a credit (bonus) to newly provisioned accounts. When a client signs up with the phone number, the mobile app sends a request to the EMCD API register.ashx method.
When the new account is created, the EMCD checks the config_signup_country table where the free credit per country configuration is stored. If, for the user’ country code, there is a free credit defined the EMCD adds the predefined amount to the user’s account balance.
If there is no specific configuration for the country code the EMCD will use the free credit configuration defined in the EMCD/AppSettings.config file:
<add key="tariff" value="1”/> <!—default client tariff -->
<add key="currency" value="1”/> <!—default client currency -->
<add key="amount" value="1”/> <!—default free credit amount -->
The default setting is optional. If you want to offer free credit for users in specific country or countries only use the sign up configuration described later in the document.
Database and the configuration file
SQL script:
CREATE TABLE `config_signup_country` (
`cc` INT(11) UNSIGNED NOT NULL,
`key` VARCHAR(20) NOT NULL,
`val` VARCHAR(100) NOT NULL,
PRIMARY KEY (`cc`,`key`)
) ENGINE=INNODB DEFAULT CHARSET=utf8;
The configuration is stored in the config_signup_country table in the api schema. This is a multipurpose table with the country code (cc field) as the primary key.
In order to set the free credit feature the key field should be set to amount. It defines the action which should be taken by the EMCD. The val field should store the money amount which should be added to client account.
For example:
insert into `config_signup_country` (`cc`, `key`, `val`) values('48','amount','10.00’);
The above statement sets the free credit for country code 48 (Poland). All new accounts from Poland will be credited with amount 10.
As the account from Poland are created with the currency EUR the amount to be added must be in EUR as well.
The default sign up bonus is defined in the EMCD AppSettings.config file. The key is used for all requests from the countries for which there is no entry in the config_signup_country table.
Fraud prevention
Before crediting user account the EMCD checks if the phone number and the UDID of the newly created account had been used before. If either of them has ever been associated with any account on the system then the free credit action will not be executed.
VSM management
The management panel allows to define the feature rules per country code. In the VSM Settings/Online payments/Sign up menu is the list of all existing rules.
In order to add a new rule click on the New button above the list. A new panel will appear containing the following settings:
Country – the country for which the rule will apply
Country phone code – shows the country code of the selected country
Amount – the amount which will be added to the client account
Tariff – allows to define the tariff which will be associate with the account (leave none if the older approach with the country parameter sent by the app is used)
Note: the amount must be in the currency assigned to the tariff. For example if the tariff selected for a country, for example for France (country code 33) has the rates denoted in EUR then the amount of the free credit should also be in EUR. It is assumed that when configuring the bonus feature the currencies for given countries are already known.
Reports
The free credit is saved into the database as a payment with a special tag free credit. You can see the payments report in the VSM Reports/Sales/Payments menu. Use the search filter Tag to narrow the result to the free credits only.
The free credits are shown also in the Charts menu.
Notifications
When a free credit is added to client account the EMCD can send a chat message to the client. To enable this option go to the VSM Settings/Online payments/Notification menu and click the New button.
Client type – set the Retail clients
Operation type – choose the free credit type
Status – select Approved
Body – enter the message text
This notification rule will make the system send a chat message to every client who got the free credit.
Languages
The message text can be written in different languages. During sign up the app sends the language two letter code in the Accept-Language http header. The language is the one set in the mobile system. It is then stored in the user’s profile on the server. Before a notification is sent the EMCD checks which language is assigned to the user.
To add texts in different languages in the body text area you have to separate each section with an empty line and the two letters language code and the colon.
Example:
EN:Your account has been credited.
PL:Twoje konto zostało doładowane!
In the message text you can use the variable [AMOUNT] which is replaced with the actual amount with the currency sign when the message is sent.
Example:
PL:Twoje konto zostało doładowane kwotą [AMOUNT]!
Will be changed to:
Twoje konto zostało doładowane kwotą 10.00 EUR!