/
3.14.1.1 CHARGE

3.14.1.1 CHARGE

/GetProviders

  • Description: Gets the lilst of available providers in the system for authenticated user

  • Url: /VUP/api/Recharge/GetProviders

  • HTTP method: GET

[{ "name": "CreditCardProvider", "description": "Pay using credit card.", "caption": "Credit Card", "shortName": "creditcard", "imageUrl": "https://sip.voipswitchrcs.com/onlineshop/Images/Merchants/Stripe.png", "url": "https://sip.voipswitchrcs.com/Onlineshop/Pay.aspx" }, { "name": "BalanceTransfer", "description": "Balance transfer", "caption": "Balance transfer", "shortName": "BalanceTransfer", "imageUrl": "/VUP/Content/Images/CustomProviders/balance-transfer.png", "url": "Pay.aspx" }, { "name": "MobileTopUp", "description": "Mobile TopUp", "caption": "Mobile TopUp", "shortName": "MobileTopUp", "imageUrl": "/VUP/Content/Images/CustomProviders/mobile-top-up.png", "url": "Pay.aspx" }, { "name": "Autorecharge", "description": "Autorecharge", "caption": "Autorecharge", "shortName": "Autorecharge", "imageUrl": "/VUP/Content/Images/CustomProviders/autorecharge.png", "url": "Pay.aspx" } ]

/GetForm

  • Description: Get the form for provided provider for authenticated user

  • Url: /VUP/api/Recharge/GetForm

  • HTTP method: GET

?providerName=creditcard
[ { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "SELECT_CHARGE_AMOUNT" } }, { "field": { "type": "DropDown", "name": "x_amount", "regexp": ".+", "item": [ { "value": "5,00", "fee": "0.00", "tax": "0", "taxPercentage": "0", "currencyCode": "", "text": "5" }, { "value": "10,00", "fee": "0.00", "tax": "0", "taxPercentage": "0", "currencyCode": "", "text": "10" }, { "value": "20,00", "fee": "0.00", "tax": "0", "taxPercentage": "0", "currencyCode": "", "text": "20" } ] } } ] }, { "provider": "creditcard", "cell": { "field": { "type": "checkbox", "name": "x_auto_recharge", "label": "AUTO_RECHARGE_CREATE_OWN", "text": "x_auto_recharge" } } }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "FIRST_NAME" } }, { "field": { "type": "TextBox", "max_length": "30", "name": "x_firstname", "regexp": "^[^0-9!@#$%&*()\\[\\]\\:;,\\._=\\+/\\?\\\\|'\"{}^]+$" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "LAST_NAME" } }, { "field": { "type": "TextBox", "max_length": "30", "name": "x_lastname", "regexp": "^[^0-9!@#$%&*()\\[\\]\\:;,\\._=\\+/\\?\\\\|'\"{}^]+$" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "CC_CARD_NO" } }, { "field": { "type": "TextBox", "max_length": "150", "name": "x_creditcardnr", "regexp": "^(?:[*4][*0-9]{12}(?:[*0-9]{3})?|[*5][*1-5][*0-9]{14}|[*6](?:011|[*5][*0-9][*0-9])[*0-9]{12}|[*3][*47][*0-9]{13}|[*3](?:[*0][*0-5]|[*68][*0-9])[*0-9]{11}|(?:[*]{4}|[*]{5}|2131|1800|35[*0-9]{3})[*0-9]{11})$" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "CC_CODE" } }, { "field": { "type": "TextBox", "max_length": "12", "name": "x_cvd", "regexp": "^[*]*|[0-9]{3,4}$" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "EXPIRY_DATE" } }, { "field": { "type": "DropDown", "name": "x_expiremonth", "regexp": "^\\d+$", "item": [ { "value": "01", "text": "01" }, { "value": "02", "text": "02" }, { "value": "03", "text": "03" }, { "value": "04", "text": "04" }, { "value": "05", "text": "05" }, { "value": "06", "text": "06" }, { "value": "07", "text": "07" }, { "value": "08", "text": "08" }, { "value": "09", "text": "09" }, { "value": "10", "text": "10" }, { "value": "11", "text": "11" }, { "value": "12", "text": "12" } ] } }, { "field": { "type": "DropDown", "name": "x_expireyear", "regexp": "^\\d+$", "item": [ { "value": "2020", "text": "2020" }, { "value": "2021", "text": "2021" }, { "value": "2022", "text": "2022" }, { "value": "2023", "text": "2023" }, { "value": "2024", "text": "2024" }, { "value": "2025", "text": "2025" }, { "value": "2026", "text": "2026" }, { "value": "2027", "text": "2027" }, { "value": "2028", "text": "2028" }, { "value": "2029", "text": "2029" }, { "value": "2030", "text": "2030" }, { "value": "2031", "text": "2031" } ] } } ] }, { "provider": "creditcard,none", "cell": [ { "field": { "type": "Label", "text": "COUNTRY" } }, { "field": { "type": "CountryDropDown", "name": "x_country", "regexp": ".+", "country": [ { "name": "Afghanistan" }, { "name": "Aland Islands" }, { "name": "Albania" }, { "name": "Algeria" }, { "name": "American Samoa" }, { "name": "Andorra" }, { "name": "Angola" }, { "name": "Anguilla" }, { "name": "Antarctica" }, { "name": "Antigua and Barbuda" }, { "name": "Argentina" }, { "name": "Armenia" }, { "name": "Aruba" }, { "name": "Ascension Island" }, { "name": "Australia" }, { "name": "Austria" }, { "name": "Azerbaijan" }, { "name": "Bahamas" }, { "name": "Bahrain" }, { "name": "Bangladesh" }, { "name": "Barbados" }, { "name": "Belarus" }, { "name": "Belgium" }, { "name": "Belize" }, { "name": "Benin" }, { "name": "Bermuda" }, { "name": "Bhutan" }, { "name": "Bolivia" }, { "name": "Bonaire, Saint Eustatius, Saba" }, { "name": "Bosnia and Herzegovina" }, { "name": "Botswana" }, { "name": "Bouvet Island" }, { "name": "Brazil" }, { "name": "British Indian Ocean Territory" }, { "name": "British Virgin Islands" }, { "name": "Brunei Darussalam" }, { "name": "Bulgaria" }, { "name": "Burkina Faso" }, { "name": "Burma" }, { "name": "Burundi" }, { "name": "Cambodia" }, { "name": "Cameroon" }, { "name": "Canada", "province": [ { "name": "Alberta", "code": "AB" }, { "name": "British Columbia", "code": "BC" }, { "name": "Manitoba", "code": "MB" }, { "name": "New Brunswick", "code": "NB" }, { "name": "Newfoundland", "code": "NF" }, { "name": "Northwest Territories", "code": "NT" }, { "name": "Nova Scotia", "code": "NS" }, { "name": "Nunavut", "code": "NU" }, { "name": "Ontario", "code": "ON" }, { "name": "Prince Edward Island", "code": "PE" }, { "name": "Quebec", "code": "QC" }, { "name": "Saskatchewan", "code": "SK" }, { "name": "Yukon", "code": "YT" } ] }, { "name": "Cape Verde" }, { "name": "Cayman Islands" }, { "name": "Central African Republic" }, { "name": "Chad" }, { "name": "Chile" }, { "name": "China" }, { "name": "Christmas Island" }, { "name": "Cocos (Keeling) Islands" }, { "name": "Colombia" }, { "name": "Comoros" }, { "name": "Congo, Democratic Republic of the" }, { "name": "Congo, Republic of the" }, { "name": "Cook Islands" }, { "name": "Costa Rica" }, { "name": "Croatia" }, { "name": "Cuba" }, { "name": "Curaçao" }, { "name": "Cyprus" }, { "name": "Czech Republic" }, { "name": "Denmark" }, { "name": "Djibouti" }, { "name": "Dominica" }, { "name": "Dominican Republic" }, { "name": "East Timor" }, { "name": "Ecuador" }, { "name": "Egypt" }, { "name": "El Salvador" }, { "name": "Equatorial Guinea" }, { "name": "Eritrea" }, { "name": "Estonia" }, { "name": "Ethiopia" }, { "name": "Falkland Islands (Islas Malvinas)" }, { "name": "Faroe Islands" }, { "name": "Fiji" }, { "name": "Finland" }, { "name": "France" }, { "name": "French Guiana" }, { "name": "French Polynesia" }, { "name": "French Southern and Antarctic Lands" }, { "name": "Gabon" }, { "name": "Gambia" }, { "name": "Georgia" }, { "name": "Germany" }, { "name": "Ghana" }, { "name": "Gibraltar" }, { "name": "Greece" }, { "name": "Greenland" }, { "name": "Grenada" }, { "name": "Guadeloupe" }, { "name": "Guam" }, { "name": "Guatemala" }, { "name": "Guernsey" }, { "name": "Guinea" }, { "name": "Guinea-Bissau" }, { "name": "Guyana" }, { "name": "Haiti" }, { "name": "Heard Island and McDonald Islands" }, { "name": "Holy See (Vatican City)" }, { "name": "Honduras" }, { "name": "Hong Kong (SAR)" }, { "name": "Hungary" }, { "name": "Iceland" }, { "name": "India" }, { "name": "Indonesia" }, { "name": "Iran" }, { "name": "Iraq" }, { "name": "Ireland" }, { "name": "Israel" }, { "name": "Italy" }, { "name": "Ivory Coast" }, { "name": "Jamaica" }, { "name": "Japan" }, { "name": "Jersey" }, { "name": "Jordan" }, { "name": "Kazakhstan" }, { "name": "Kenya" }, { "name": "Kiribati" }, { "name": "Korea, North" }, { "name": "Korea, South" }, { "name": "Kuwait" }, { "name": "Kyrgyzstan" }, { "name": "Laos" }, { "name": "Latvia" }, { "name": "Lebanon" }, { "name": "Lesotho" }, { "name": "Liberia" }, { "name": "Libya" }, { "name": "Liechtenstein" }, { "name": "Lithuania" }, { "name": "Luxembourg" }, { "name": "Macao" }, { "name": "Macedonia" }, { "name": "Madagascar" }, { "name": "Malawi" }, { "name": "Malaysia" }, { "name": "Maldives" }, { "name": "Mali" }, { "name": "Malta" }, { "name": "Man, Isle of" }, { "name": "Marshall Islands" }, { "name": "Martinique" }, { "name": "Mauritania" }, { "name": "Mauritius" }, { "name": "Mayotte" }, { "name": "Mexico" }, { "name": "Micronesia" }, { "name": "Moldova" }, { "name": "Monaco" }, { "name": "Mongolia" }, { "name": "Montenegro" }, { "name": "Montserrat" }, { "name": "Morocco" }, { "name": "Mozambique" }, { "name": "Namibia" }, { "name": "Nauru" }, { "name": "Nepal" }, { "name": "Netherlands" }, { "name": "New Caledonia" }, { "name": "New Zealand" }, { "name": "Nicaragua" }, { "name": "Niger" }, { "name": "Nigeria" }, { "name": "Niue" }, { "name": "Norfolk Island" }, { "name": "Northern Mariana Islands" }, { "name": "Norway" }, { "name": "Oman" }, { "name": "Pakistan" }, { "name": "Palau" }, { "name": "Panama" }, { "name": "Papua New Guinea" }, { "name": "Paraguay" }, { "name": "Peru" }, { "name": "Philippines" }, { "name": "Pitcairn Islands" }, { "name": "Poland" }, { "name": "Portugal" }, { "name": "Puerto Rico" }, { "name": "Qatar" }, { "name": "Réunion" }, { "name": "Romania" }, { "name": "Russia" }, { "name": "Rwanda" }, { "name": "Saint Barthélemy" }, { "name": "Saint Helena" }, { "name": "Saint Kitts and Nevis" }, { "name": "Saint Lucia" }, { "name": "Saint Martin (French part)" }, { "name": "Saint Pierre and Miquelon" }, { "name": "Saint Vincent and the Grenadines" }, { "name": "Samoa" }, { "name": "San Marino" }, { "name": "São Tomé and Príncipe" }, { "name": "Saudi Arabia" }, { "name": "Senegal" }, { "name": "Serbia" }, { "name": "Seychelles" }, { "name": "Sierra Leone" }, { "name": "Singapore" }, { "name": "Sint Maarten (Dutch part)" }, { "name": "Slovakia" }, { "name": "Slovenia" }, { "name": "Solomon Islands" }, { "name": "Somalia" }, { "name": "South Africa" }, { "name": "South Georgia and the South Sandwich Islands" }, { "name": "South Sudan" }, { "name": "Spain" }, { "name": "Sri Lanka" }, { "name": "State of Palestine" }, { "name": "Sudan" }, { "name": "Suriname" }, { "name": "Svalbard" }, { "name": "Swaziland" }, { "name": "Sweden" }, { "name": "Switzerland" }, { "name": "Syria" }, { "name": "Taiwan" }, { "name": "Tajikistan" }, { "name": "Tanzania" }, { "name": "Thailand" }, { "name": "Togo" }, { "name": "Tokelau" }, { "name": "Tonga" }, { "name": "Trinidad and Tobago" }, { "name": "Tunisia" }, { "name": "Turkey" }, { "name": "Turkmenistan" }, { "name": "Turks and Caicos Islands" }, { "name": "Tuvalu" }, { "name": "Uganda" }, { "name": "Ukraine" }, { "name": "United Arab Emirates" }, { "name": "United Kingdom" }, { "name": "United States", "province": [ { "name": "Alabama", "code": "AL" }, { "name": "Alaska", "code": "AK" }, { "name": "Arizona", "code": "AZ" }, { "name": "Arkansas", "code": "AR" }, { "name": "California", "code": "CA" }, { "name": "Colorado", "code": "CO" }, { "name": "Connecticut", "code": "CT" }, { "name": "Delaware", "code": "DE" }, { "name": "District Of Columbia", "code": "DC" }, { "name": "Florida", "code": "FL" }, { "name": "Georgia", "code": "GA" }, { "name": "Hawaii", "code": "HI" }, { "name": "Idaho", "code": "ID" }, { "name": "Illinois", "code": "IL" }, { "name": "Indiana", "code": "IN" }, { "name": "Iowa", "code": "IA" }, { "name": "Kansas", "code": "KS" }, { "name": "Kentucky", "code": "KY" }, { "name": "Louisiana", "code": "LA" }, { "name": "Maine", "code": "ME" }, { "name": "Maryland", "code": "MD" }, { "name": "Massachusetts", "code": "MA" }, { "name": "Michigan", "code": "MI" }, { "name": "Minnesota", "code": "MN" }, { "name": "Mississippi", "code": "MS" }, { "name": "Missouri", "code": "MO" }, { "name": "Montana", "code": "MT" }, { "name": "Nebraska", "code": "NE" }, { "name": "Nevada", "code": "NV" }, { "name": "New Hampshire", "code": "NH" }, { "name": "New Jersey", "code": "NJ" }, { "name": "New Mexico", "code": "NM" }, { "name": "New York", "code": "NY" }, { "name": "North Carolina", "code": "NC" }, { "name": "North Dakota", "code": "ND" }, { "name": "Ohio", "code": "OH" }, { "name": "Oklahoma", "code": "OK" }, { "name": "Oregon", "code": "OR" }, { "name": "Pennsylvania", "code": "PA" }, { "name": "Rhode Island", "code": "RI" }, { "name": "South Carolina", "code": "SC" }, { "name": "South Dakota", "code": "SD" }, { "name": "Tennessee", "code": "TN" }, { "name": "Texas", "code": "TX" }, { "name": "Utah", "code": "UT" }, { "name": "Vermont", "code": "VT" }, { "name": "Virginia", "code": "VA" }, { "name": "Washington", "code": "WA" }, { "name": "West Virginia", "code": "WV" }, { "name": "Wisconsin", "code": "WI" }, { "name": "Wyoming", "code": "WY" } ] }, { "name": "United States Minor Outlying Islands" }, { "name": "Uruguay" }, { "name": "Uzbekistan" }, { "name": "Vanuatu" }, { "name": "Venezuela" }, { "name": "Vietnam" }, { "name": "Virgin Islands" }, { "name": "Wallis and Futuna" }, { "name": "Western Sahara" }, { "name": "Yemen" }, { "name": "Zambia" }, { "name": "Zimbabwe" }, { "name": "Other" } ] } } ] }, { "provider": "creditcard,none", "cell": [ { "field": { "type": "Label", "text": "STATE" } }, { "field": { "type": "TextBox", "max_length": "30", "name": "x_state", "regexp": ".+" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "ZIP" } }, { "field": { "type": "TextBox", "max_length": "30", "name": "x_zip", "regexp": ".+" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "CITY" } }, { "field": { "type": "TextBox", "max_length": "30", "name": "x_city", "regexp": ".+" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "ADDRESS" } }, { "field": { "type": "TextArea", "name": "x_address", "regexp": ".+" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "PHONE" } }, { "field": { "type": "TextBox", "max_length": "30", "name": "x_phoneno", "regexp": "^[+0-9]+$" } } ] }, { "provider": "creditcard", "cell": [ { "field": { "type": "Label", "text": "MOBILE_PHONE" } }, { "field": { "type": "TextBox", "max_length": "15", "name": "x_mobile_number", "regexp": "^[+0-9]+$" } } ] } ]

/GetAutorechargeDetails

  • Description: Get the information regarding the autorecharge feature for authenticated user

  • Url: /VUP/api/Recharge/GetAutorechargeDetails

  • HTTP method: GET

{ "autoChargeAmounts": [ { "Description": "5.00 USD", "Value": 5.00 }, { "Description": "10.00 USD", "Value": 10.00 }, { "Description": "20.00 USD", "Value": 20.00 } ], "autorechargeLowAmounts": [ { "Description": "5.00 USD", "Value": 5.00 }, { "Description": "10.00 USD", "Value": 10.00 }, { "Description": "20.00 USD", "Value": 20.00 }, { "Description": "50.00 USD", "Value": 50.00 } ], "creditCardData": null }

/SetAutoRechargeDetails

  • Description: Set the information regarding the autorecharge feature for authenticated user

  • Url: /VUP/api/Recharge/SetAutoRechargeDetails

  • HTTP method: POST

{ "amount": 10, "lowAmount": 10, "enabled": true }
{ "error": false, "message": "OK" }

/Transfer

  • Description: Invoke the balance transfer of provided amount from authenticated user to any other user ofthe same type

  • URL: /VUP/api/Recharge/Transfer

  • HTTP method: POST

{ "amount": 10, "targetLogin": "retail" }
{ "error": false, "message": "OK", "balance": 100 }

/ApplyVoucher

  • Description: Invoke the recharge with the voucher for authenticated user

  • Url: /VUP/api/Recharge/ApplyVoucher

  • HTTP method: POST

{ "pin": "value" }
{ "error": false, "message": "OK", "balance": 100 }

/CallhomeCashTransfer

  • Description: Invoke the balance transfer of provided amount from authenticated user to the bank account or mobile via the CallHomeCash provider

  • Url: /VUP/api/Recharge/CallhomeCashTransfer

  • HTTP method: POST

{ "amount": 10, "type": "", "phoneNumber": "", "accountNumber": "" }

Note that:

  • type: BANK_TRANSFER or MOBILE_OPERATOR

{ "error": false, "message": "OK", "balance": 100 }

/MtuLookup

  • Description: Do the lookup for MTU transakction - get the information regarding the mobile top up for provided phone number

  • Url: /VUP/api/Recharge/MtuLookup

  • HTTP method: POST

{ "number": "value" }
{ "error": false, "message": "OK", "isLoopupAvailable": false, "operatorId": -1, "openRange": false, "minAmount": 0, "maxAmount": 0, "amounts": [], "operators": [ { "Id": 148, "Mccmnc": 0, "Mcc": 0, "Mnc": 0, "Brand": "Heyah Poland", "Operator": "Heyah Poland", "CountryCode": "PL", "CallingCode": "", "TransferToCountryId": null, "TransferToOperatorId": null, "FlexiloadCountryId": null, "FlexiloadOperatorId": null, "ReloadlyOperatorId": 381, "SupplierId": 1, "SupplierName": null, "ResellerId": null, "Available": true }, { "Id": 257, "Mccmnc": 0, "Mcc": 0, "Mnc": 0, "Brand": "Orange Poland", "Operator": "Orange Poland", "CountryCode": "PL", "CallingCode": "", "TransferToCountryId": null, "TransferToOperatorId": null, "FlexiloadCountryId": null, "FlexiloadOperatorId": null, "ReloadlyOperatorId": 384, "SupplierId": 1, "SupplierName": null, "ResellerId": null, "Available": true }, { "Id": 265, "Mccmnc": 0, "Mcc": 0, "Mnc": 0, "Brand": "Play Poland", "Operator": "Play Poland", "CountryCode": "PL", "CallingCode": "", "TransferToCountryId": null, "TransferToOperatorId": null, "FlexiloadCountryId": null, "FlexiloadOperatorId": null, "ReloadlyOperatorId": 382, "SupplierId": 1, "SupplierName": null, "ResellerId": null, "Available": true }, { "Id": 266, "Mccmnc": 0, "Mcc": 0, "Mnc": 0, "Brand": "Plus Poland", "Operator": "Plus Poland", "CountryCode": "PL", "CallingCode": "", "TransferToCountryId": null, "TransferToOperatorId": null, "FlexiloadCountryId": null, "FlexiloadOperatorId": null, "ReloadlyOperatorId": 380, "SupplierId": 1, "SupplierName": null, "ResellerId": null, "Available": true }, { "Id": 287, "Mccmnc": 0, "Mcc": 0, "Mnc": 0, "Brand": "Tak Tak Poland", "Operator": "Tak Tak Poland", "CountryCode": "PL", "CallingCode": "", "TransferToCountryId": null, "TransferToOperatorId": null, "FlexiloadCountryId": null, "FlexiloadOperatorId": null, "ReloadlyOperatorId": 383, "SupplierId": 1, "SupplierName": null, "ResellerId": null, "Available": true } ] }

/MtuTopup

  • Description: Invoke the balance transfer of provided amount from authenticated user to the provided phone number

  • Url: /VUP/api/Recharge/MtuTopup

  • HTTP method: POST

{ "number": "", "operatorId": "", "product": "", "openRange": true, "smsText": "" }
{ "error": false, "message": "OK", "balance": 100 }

Related content