Prepaid endpoint

This topic provides a quick reference for the method signatures of prepaid API methods.

Location: http://smile.example.com:port/stage/smile/ws/v2/prepaid

WSDL: http://smile.example.com:port/stage/smile/ws/v2/prepaid?wsdl

Table 1. Prepaid API methods
Method Method signature Purpose
addPrepaid()
void addPrepaid(
 string usn, 
 string prepaidCode,
 AddPrepaidRequestOverride 
 addPrepaidRequestOverride)
Adds a prepaid block to a subscription, but does not charge for the prepaid or raise an invoice.
addSelfServePrepaid()
void addSelfServePrepaid(
 string usn, 
 string prepaidCode,
 PaymentRequest paymentRequest)
Adds a self-serve prepaid block to a subscription and charges for the block.
getPrepaidPaymentTypes()
PaymentTypes getPrepaidPaymentTypes(
 string usn, 
 string prepaidCode)
Returns a list of payment methods that can be used to buy self-serve prepaid blocks.
getPrepaidState()
SubscriptionPrepaidState getPrepaidState(
 string usn)
Returns a list of prepaid blocks and their current state by USN.
getQuote()
ItemisedTransactionDetail getQuote(
 string usn, 
 string prepaidCode,
 string paymentTypeCode)
Returns the cost to buy a self-serve prepaid block with a specific payment method.
getSelfServePrepaidList()
SelfServePrepaidList getSelfServePrepaidList(
 string usn)
Returns a list of self-serve prepaid blocks available to purchase.
redeemVoucher()
void redeemVoucher(
 string usn, 
 string voucherNumber,
 string voucherCode)
Consumes a voucher and adds prepaid to a subscription.
updatePrepaid()
void updatePrepaid(
 string usn,
 PrepaidUpdate prepaidUpdate)
Updates a purchased prepaid block on a subscription.
validateVoucher()
VoucherValidationResponse 
 validateVoucher(
 int company, 
 string voucherNumber,
 string voucherCode)
Verifies that a voucher is valid.