register_simcloud_user
Register a SIMcloud user
Create a normal SIMcloud account under the authenticated account for a client application user. Confirm that the person consents to account creation and that their cell number, email and password are correct before calling. The response contains the child account API token, which must be stored securely and used only for that child account.
Parameterscellrequiredemailrequiredvatnoaddresspasswordrequiredid_numberlast_namerequiredfirst_namerequiredbusiness_regbusiness_name
get_wallet_balance
Get wallet balance
Use this before a wallet-funded SIMcloud transaction or when the user asks for their available SIMcloud balance. Returns the authenticated account wallet balance and does not spend funds.
Takes no parameters.
get_transaction_history
Get transaction history
Use this to retrieve read-only transaction history for the authenticated SIMcloud account across web, CSV, recurring and API airtime, data, SMS, VAS and electricity activity. Require a date range; optionally filter one or more services with a comma-separated type value. SMS is successful only after a delivery receipt.
Parameterstypelimitcursordate_torequireddate_fromrequired
lookup_network
Look up mobile network
Use this when the user needs to identify the South African mobile network for a number before sending airtime, data or SMS. The lookup is recorded in the authenticated account history.
Parametersmsisdnrequired
Use this when an authenticated SIMcloud user asks to send a confirmed SMS to a South African recipient. Confirm the final recipient and message before calling. Sending is an irreversible external action and may spend wallet funds; do not automatically retry an ambiguous result.
Parametersmessagerequiredrecipientrequired
get_sms_status
Get SMS status
Use this after send_sms to fetch the delivery status of an authenticated account SMS by sms_id.
Parameterssms_idrequired
create_airtime_order
Send South African airtime
Use this when an authenticated SIMcloud user asks to send or recharge prepaid airtime to a South African mobile number on MTN, Vodacom, Cell C or Telkom. Confirm the MSISDN, network, rand amount and reference before calling. This spends wallet funds and queues an irreversible external transaction. Never automatically retry an ambiguous result. Duplicate same-MSISDN-and-amount requests inside 5 minutes return HTTP 409.
Parametersamountrequiredmsisdnrequirednetworkrequiredreferencerequired
get_airtime_order
Get airtime order
Use this after create_airtime_order, or after an ambiguous create result, to fetch the authenticated account airtime order by request_id or orderno.
Parametersordernorequest_id
create_data_order
Create data order
Use this when an authenticated SIMcloud user asks to send a confirmed South African mobile data bundle. Call list_data_products first and use an available network and sell value. This spends wallet funds and queues an irreversible external transaction. Never automatically retry an ambiguous result. Duplicate same-MSISDN-and-amount requests inside 5 minutes return HTTP 409.
Parametersamountrequiredmsisdnrequirednetworkrequiredreferencerequired
list_data_products
List data products
Use this before create_data_order to list the current SIMcloud data bundle products and exact sell values available for API ordering, optionally filtered by South African network.
Parametersnetwork
get_data_order
Get data order
Use this after create_data_order, or after an ambiguous create result, to fetch the authenticated account data order by request_id or orderno.
Parametersordernorequest_id
list_vas_products
List VAS products
Use this before create_vas_order to list active SIMcloud VAS voucher products and their available denominations.
Takes no parameters.
create_vas_order
Create VAS order
Use this when an authenticated SIMcloud user asks to buy a confirmed VAS voucher. Call list_vas_products first and use an available product and denomination. This spends wallet funds and queues an irreversible external transaction; do not automatically retry an ambiguous result.
Parametersamountrequiredreferencerequiredproduct_idvoucher_type
get_vas_order
Get VAS order
Use this after create_vas_order, or after an ambiguous create result, to fetch an authenticated account VAS order by order_id or transaction_id.
Parametersorder_idtransaction_id
create_electricity_order
Create electricity order
Use this when an authenticated SIMcloud user asks to buy prepaid electricity for a meter already confirmed with check_electricity_meter. Confirm the meter, rand amount, reference and SMS recipient before calling. This spends wallet funds and submits an irreversible external transaction; do not automatically retry an ambiguous result.
Parametersamountrequiredrecipientrequiredmeter_numberrequiredclient_referencerequired
check_electricity_meter
Check electricity meter
Use this before create_electricity_order to check whether a prepaid electricity meter is supported. This does not buy electricity or spend wallet funds.
Parametersmeter_numberrequired
get_electricity_order
Get electricity order
Use this after create_electricity_order, or after an ambiguous create result, to fetch an authenticated account electricity order by order_id, client_reference or order_reference_id.
Parametersorder_idclient_referenceorder_reference_id