Mobile Top-Up
Display supported cryptocurrencies
GET https://sandbox.encryptus.co/v1/topup/supported-crypto
Display supported countries
GET https://sandbox.encryptus.co/v1/topup/country-code
Get the list of all countries available for payout via mobile top-up for the user
Name
Type
Description
countryCode
string
supported country identified by country code
countryName
string
supported country identified by full name
internationalCountryCode
number
international country calling code
numberLength
number
expected length of mobile number without calling code
Display supported mobile providers based on country
GET https://sandbox.encryptus.co/v1/topup/carriers
Request Body
countryCode*
String
country code of selected country
Name
Type
Description
carrierId
number
unique ID of mobile operator/carrier
carrierName
string
name of mobile operator/carrier
category
string
"Rtr" specific for mobile top-up
countryCode
string
supported country identified by country code
productId
number
unique ID for product group
operator
string
shorter name of mobile operator/carrier
denominationType
string
options "variable" or "fixed" - future reference for variable or fixed amount of mobile top-up
Display products / plans for selected provider
GET https://sandbox.encryptus.co/v1/topup/carriers/plans
Request Body
countryCode*
String
country code of selected country
carrierName*
String
name of selected mobile operator/carrier
Submit details for mobile top-up quote
POST https://sandbox.encryptus.co/v1/topup/quote
Request Body
skuId*
Number
unique product ID
amount*
Number
mobile top-up amount in USD (base currency)
mobile*
String
selected mobile number for mobile top-up
cryptoCoin*
String
selected cryptocurrency from list of supported crypto
fiatCurrency*
String
fiat currency for quote amount, only USD is supported
operator*
String
mobile provider / carrier for selected mobile number
partner_userID*
String
partner's API clientID to reference order to partner
encryptus_userID
String
unique user ID referencing to user onboarded for QuickRemit
country_code*
String
country code
Accept quote and submit order
POST https://sandbox.encryptus.co/v1/topup/submit-order
Request Body
quoteID*
String
ID assigned by the system for the requested quote
Display details for order
GET https://sandbox.encryptus.co/v1/topup/order/{orderId}
Request Body
orderID*
String
ID assigned by the system for the order
Last updated