Skip to content

Retrieve Top Up Operators

Retrieve Top Up Operators

Retrieve a list of available operators of the phone number.

HTTP Request

GET /cashout/topups/{{fullPhoneNumber}}/operators

Request Headers
{
    "Authorization": "Bearer {{access_token}}"
}
Content-Type: application/json
{
    "statusCode":200,
    "errorMsg": "",
    "operators": [
        {
            "operatorId": "TA",
            "operatorName": "TTelcel"
        },
        {
            "operatorId": "MOV",
            "operatorName": "Movistar"
        },
        {
            "operatorId": "IUS",
            "operatorName": "Iusacell"
        },
        {
            "operatorId": "UNE",
            "operatorName": "Unefon"
        },
        {
            "operatorId": "ATT",
            "operatorName": "AT&T"
        },
        {
            "operatorId": "MAZ",
            "operatorName": "Maz Tiempo"
        },
        {
            "operatorId": "VIR",
            "operatorName": "Virgin Mobile"
        },
        {
            "operatorId": "CIE",
            "operatorName": "Cierto"
        }
    ]
}

HTTP Headers Details

Key Value
Authorization "bearer"+ "" + {{access_token}}
x-api-key {{api_key}}

PATH and Query Parameters

Parameter Required Type Description
fullPhoneNumber String The full phone number

Response Body Details

Parameter Type Description
statusCode int 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error
errorMsg String error message if failed
operators JSON Array The available operator list
JSON Field Type Description
operatorId String The operator Id
operatorName String The operator name
Back to top