Account Information

Endpoint

For getting and updating account information, the base url is:

https://rebuetext.com/api/v1

Check Account Balance

Method URI
GET /account/balance

{info} Remember to always include the Request header. See how HERE

Sample Success Response

StatusCode 200

Content

{
    "status": true,
    "data": {
        "account_units": 993,
        "date": "2024-11-22 23:28:24"
    }
}

Top Up

Method URI
POST /account/top-up

Request Params

Param Type Description
units string(required) Units to top up a new account
account_id string(required) Account Id of sub account to be topped up
topup_reference string(optional) Top up Reference string generated by your system

Sample Request Body

{
    "units": 15,
    "account_id": 4,
    "topup_reference": null
}

Sample Success Response

StatusCode 200

Content

{
    "status": true,
    "data": {
        "topup_id": 2,
        "account_id": 4,
        "topup_units": 15,
        "initial_units": 10,
        "updated_units": 25,
        "parent_id": 1,
        "parent_amount": 978,
        "topup_reference": "6740ea0fe6fcd",
        "created_at": "2024-11-22 23:31:14"
    }
}

Sample Fail Response

StatusCode 403 Reason Forbidden. Access to the resource is prohibited

Content

{
    "status": false,
    "message": "The account is not a subaccount of the parent account."
}
{
    "status": false,
    "message": {
        "account_id": ["The selected account id is invalid."]
    }
}

{info} Official SDKs can be obtained HERE. Also consider having a look at our responses format HERE In order to anticipate all the formats our responses are returned in, and hence a better handling of the same.

Sample Error Response

StatusCode 401

Reason Invalid or Missing Token

Content

{
    "status": false,
    "message": "Unauthenticated."
}

{danger} The Generated Auth Token Gives a person full access to your account. Don't share it under any circumstance️