Call TopUp API to top-up a prepaid contract. Top-up is done within the validity or after a contract is expired. Using this API, validity of the contract will be extended and also usage will be added if that plan has any usage based services. This API receives TopupXML as input and renders Response XML as output.
TopUp (ByVal TopupXML As String, ByVal ReferenceNo As String) as string
|
Argument Name |
Data Type |
Is Mandatory |
Description |
|
TopupXML |
String |
Yes |
An XML string contains customer information and plan information |
|
ReferenceNo |
String |
Yes |
An unique number provided to identify the request |
|
Element Name |
Data Type |
Length (Bytes) |
Is Mandatory |
Description |
|
CUSTOMERNO |
String |
16 |
Y |
Customer Number |
|
PLANCODE |
String |
16 |
Y |
Plan code to top-up the contract. |
<REQUESTINFO>
<KEY_NAMEVALUE>
<KEY_NAME>CUSTOMERNO</KEY_NAME>
<KEY_VALUE>1015</KEY_VALUE>
</KEY_NAMEVALUE>
<TOPUPINFO>
<PLANCODE>WEBPLAN</PLANCODE>
</TOPUPINFO>
</REQUESTINFO>
|
Parameter Name |
Data Type |
Description |
|
TRANSACTIONNO |
String |
An unique number generated for each request |
|
ERRORNO |
Integer |
Returns Error Number 60059 - Plan does not exists with the code. |
|
ERRORMESSAGE |
String |
Returns "Success" or "Failed" |
<RESPONSEINFO>
<STATUS>
<TRANSACTIONNO>4543</TRANSACTIONNO>
<ERRORNO>0</ERRORNO>
<MESSAGE>SUCCESS</MESSAGE>
</STATUS>
</RESPONSEINFO>
Note: Refer to Error Codes and Description to view errors in detail.