Skip to content

Retrieve Top Up Packages

Retrieve Top Up Packages

Retrieve the packages and its values from a specific operator.

HTTP Request

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

Request Headers
{
    "Authorization": "Bearer {{access_token}}"
}
Content-Type: application/json
{
    "statusCode":200,
    "errorMsg": "",
    "packages": [
        {
            "operatorId": "ATT",
            "packageSku": "ATT020",
            "amount": "20",
            "currency": "MXN"
        },
        {
            "operatorId": "ATT",
            "packageSku": "ATT030",
            "amount": "30",
            "currency": "MXN"
        },
        {
            "operatorId": "ATT",
            "packageSku": "ATT050",
            "amount": "50",
            "currency": "MXN"
        },
        {
            "operatorId": "ATT",
            "packageSku": "ATT070",
            "amount": "70",
            "currency": "MXN"
        },
        {
            "operatorId": "ATT",
            "packageSku": "ATT100",
            "amount": "100",
            "currency": "MXN"
        },
        {
            "operatorId": "ATT",
            "packageSku": "ATT150",
            "amount": "150",
            "currency": "MXN"
        },
        {
            "operatorId": "ATT",
            "packageSku": "ATT200",
            "amount": "200",
            "currency": "MXN"
        },
        {
            "operatorId": "ATT",
            "packageSku": "ATT300",
            "amount": "300",
            "currency": "MXN"
        }
    ]
}

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
operatorId String The operator Id

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
packages JSON Array packages and its values
JSON Field Type Description
amount String The transfer amount
currency String The currency of the transferred fund
operatorId String Identifier of an operator
packageSku String The SKU of package
Back to top