This method requests that a subscriber be topped up and may also be used to poll the Virtual Top-up Provider service with dummy values.
Request Fields
Field | M/O | Length | Format | Description |
DestAccount | M | 10 | Alphanumeric | Destination account – the service number to be topped up i.e., 2348052247125 |
Amount | M | N/A | Numeric | Integer value amount to Top-up the subscriber |
Msg | O | N/A | Alphanumeric | Free form message that will be used as part of the SMS notification |
SequenceNo | M | N/A | Numeric | VTUCare generated reference for this transaction. NB: This reference should be used to track duplicate transactions. |
DealerNo | M | N/A | Alphanumeric | Dealer with Virtual Top-up Provider whose stock would be used to fulfil this order |
Password | M | N/A | Alphanumeric | Password of Dealer with Virtual Top-up Provider whose stock will be used to fulfil this order |
ProductCode | O | N/A | Alphanumeric | A unique code that refers to the product that is to be topped up |
PIN | O | N/A | Alphanumeric | A value for the host to validate as prerequisite for ValueToken vending |
SOAPAction:urn:anonOutInOp
[(Namespace = “http://webservices.ems.momas.com/”)]
Sample Request
NB: Do not copy Sample Request below.Please click view to download Sample Vend Request file |
Response Field
Field | Description |
StatusId | The status of the Vend when executed on the VTU Server e.g. 00 = Successful Vend. The Client will have reference to the VTU Status’s and their descriptions |
StatusMessage | The status message of the vend executed on VTU |
TxRefId | The Unique Transaction Reference on the Virtual Topup service provider’s platform. NB: This transaction reference is generated at the customer’s end. |
ValueToken | Optional Field for returning Value to the customer (Not Required for Virtual Top Up integrations but necessary where the customer depends on value response from the organization upstream as Token i.e., Electricity meter token) |
DealerNo | Dealer with Virtual Topup Provider whose stock would be used to fulfil this order |
DestAccount | The subscriber’s account e.g. 2348052247125 |
ResponseCode | This value should be the same as StatusId value. |
ResponseMessage | The Service’s status message corresponding to the ResponseCode e.g.“Success” |
Note: There may be exception scenarios (no response was received/processed for a request) which will cause the request to be retried at intervals till a definite response is received and processed; in such a case, the “StatusId” in the response from the host should indicate that the transaction is a repeated transaction and the specific response (value of “StatusId”/”StatusMessage” in the response) should depend on the success/failure status of the initial transaction. Kindly, see Appendix for a list of standard responses. This list is in no way exhaustive.
Sample Response
Response Header
NB: Do not copy the sample response body belowPlease click to view Sample Response Body Response Body |