This documentation details the steps of setting up a payment gateway to use top-up vouchers.  

Payment Processors

Payment processors can be setup and configured under Customers --> Payments --> Payment Processors.  Credit Card Payments can be setup using or Paypal.  Starting in Sippy 2020 Stripe Payment Processor is also an option.

When adding a new payment processor you will have to specify a few configuration variables.  Switch operators will be able to specify the currency, payment gateway, and card type.  They will also need to be able to provide login information for their payment gateway so that payments can be handled securely.  These can be obtained when you create your account with the respective payment gateway provider.  There are additional optional settings that can be configured as well.  If you have any questions on any of the fields here please let us know by contacting our support team.

Account Top Ups with Credit Cards

If an Account holder wishes to top up their accounts with a credit card then they will need to add their respective credit card information into the account's Web Self Care portal.

From here the Users will be able to add or modify or remove credit cards as necessary.

  • To Add a Credit Card Number Click on the Add Button
  • To Modify Credit Cards click on the Alias Name in the Left most column
  • To Delete a Credit Card click the X button on the Right most column

Once Credit Card information is entered Account users will now be able to access Payments --> Make Payment from the Menu and select their Card and the amount to be charged.  Once done Clicking on the Proceed Payment will apply the payment to the account.

Top Up Vouchers

Vouchers allow users to top-up the balance of their accounts using the pre-uploaded set of cards:

Top-up may be done via the web GUI, IVR application, or xmlapi.

To activate a top-up feature, please add a new Payment Processor with an appropriate Payment Gateway.

See example on the screenshot:

SippySoft supports two types of payment gateways related to the use of vouchers:

  1. Vouchers;
  2. Vouchers with a PIN;

The 1st option allows the use of vouchers with or without a PIN.  A PIN would be requested only for vouchers where the PIN is configured (more flexible option).

The 2nd option (with a PIN) will always force the IVR to request a PIN for the registered voucher (more secure).

When the appropriate gateway is added for the voucher's use, the Sippy Softswitch will automatically activate an additional page on the Account's web self-care interface. Thus an Account would be able to top-up his balance by use of the known voucher id:

SippySoft supports the use of an Account to create a voucher for top-ups - this requires changes on the backend of the Softswitch.
When so configured, SippySoft will permit the use of the Account's username for the top-up of other Accounts. Thus, users would be allowed to top-up their Account by knowing the id/username (digits) of the Account.

That being said all balance of entered account would be transferred to the authenticated account accordingly.

How to activate vouchers for sub-customers

  1. Go to the Permissions page and tick the three check boxes marked below (for the intended customer of course):

  1. Click the "Set" button on the right side of the page. This will save changes you've made:

  1. That's it. Customer is now able to create vouchers.

        4. Create vouchers on the customer's web self-care interface:

Top Up Vouchers can be generated in bulk by pressing the Generate button displayed in the graphic above.  Both Voucher IDs and Pins can be automatically generated with some degree of randomness built in.

Voucher IDs and Secret Pins can be populated with auto-generated values if a specific format is used.  For the fields to contain Auto-generated values the following format is allowed:

${N:xxx}, sequence of random digits. xxx here should be in the format [range1][range2]...[rangeN], where rangeX is either list of allowed digits for this position (i.e. [0,4,9]) or range of such digits (i.e. [0-6]). For example: [2,3,4][0-8][0-9][0-9] will generate numbers in the ranges 2000-2899, 3000-3899 and 4000-4899.  As the number is generated digit by digit it is then vetted and checked against the list of existing voucher IDs to mitigate any duplication.

To help explain this a bit further from the Screenshot example above the following values would produce voucher IDs of 10 digits of length, and Secret PINs of 4 digits in length.

Voucher ID: ${N:[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]}

Secret PIN: ${N:[0-9][0-9][0-9][0-9]}

A download of the xlsx will begin once the Top-up Vouchers are created.  By default the Secret Pins will not be displayed in the file.  To view the pin used you will need to tick off the "Use Secret Pin" checkbox when the vouchers are created.

Top-up vouchers behavior between different versions (comparison table)

Voucher setup
IVR is denied
to ask PIN
Behavior 4.55.0/5.1/5.2
IVR requests secret PINRecharge successfulIVR requests secret PIN
Recharge successful
Vouchersno PINTRUEnoyesnoyes


no PINFALSEnoyesnoyes

Vouchers with PINno PINTRUEnoyesnono


no PINFALSEnoyesnono