Mobile Top-up

1

Display supported cryptocurrencies

Request:

GET https://gateway.noxxo.com/v1/topup/supported-crypto

Responses:

• 200: OK — List of supported cryptocurrencies - USDT and/or USDC

• 401: Unauthorized

2

Display supported countries

Request:

Request

GET https://gateway.noxxo.com/v1/topup/country-code

Get the list of all countries available for payout via mobile top-up for the user.

Responses:

• 200: OK — List of countries

• 401: Unauthorized

Response data fields:

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

3

Display supported mobile providers based on country

Request:

Request

GET https://gateway.noxxo.com/v1/topup/carriers

Request Body:

Name	Type	Description
countryCode*	String	country code of selected country

Responses:

• 200: OK

Response fields:

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 amount type of top-up

4

Display products / plans for selected provider

Request:

Request

GET https://gateway.noxxo.com/v1/topup/carriers/plans

Request Body:

Name	Type	Description
countryCode*	String	country code of selected country
carrierName*	String	name of selected mobile operator

Responses:

• 200: OK

• 400: Bad Request

5

Submit details for mobile top-up quote

Request:

Request

POST https://gateway.noxxo.com/v1/topup/quote

Request Body:

Name	Type	Description
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

Responses:

• 201: Created — Quote successfully created

• 400: Bad Request

6

Accept quote and submit order

Request:

Request

POST https://gateway.noxxo.com/v1/topup/submit-order

Request Body:

Name	Type	Description
quoteID*	String	ID assigned by the system for the requested quote

Responses:

• 201: Created — Order successfully created

• 400: Bad Request

7

Display details for order

Request:

Request

GET https://gateway.noxxo.com/v1/topup/order/{orderId}

Request Body:

Name	Type	Description
orderID*	String	ID assigned by the system for the order

Responses:

• 200: OK — Order details displayed