Get your balance

GET

/balance

const url = 'https://api.poweredbyaura.com/v1/balance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.poweredbyaura.com/v1/balance \
  --header 'Authorization: Bearer <token>'

Returns your prepaid balance. available is what you can spend now. held covers purchases that are still pending: it is charged if they succeed and released if they fail.

Authorizations

apiKey

Responses

200

Your balance.

application/json

object

object

required

string

Allowed value: balance

available

required

object

amount

required

Amount in the currency’s minor unit (kobo for NGN).

integer

currency

required

ISO 4217 currency code.

string

/^[A-Z]{3}$/

held

required

object

amount

required

Amount in the currency’s minor unit (kobo for NGN).

integer

currency

required

ISO 4217 currency code.

string

/^[A-Z]{3}$/

updated_at

required

string format: date-time

Examples

balance

Balance with purchases pending

{
  "object": "balance",
  "available": {
    "amount": 12395000,
    "currency": "NGN"
  },
  "held": {
    "amount": 70000,
    "currency": "NGN"
  },
  "updated_at": "2026-10-12T09:15:02Z"
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.

401

The API key is missing, wrong or revoked.

application/json

object

error

required

object

code

required

A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP status and retryable flag.

string

Allowed values: invalid_request invalid_phone_number invalid_api_key ip_not_allowed not_found insufficient_balance reference_conflict bundle_unavailable network_mismatch unsupported_network rate_limited internal_error network_unavailable

message

required

A human-readable explanation. Do not parse it; use code.

string

param

The request field the error is about, when there is one.

string

retryable

required

Whether the same request can succeed if you retry it later.

boolean

request_id

required

string

details

Extra facts about the error, such as the existing purchase or the network’s status.

object

key

additional properties

any

Examples

invalidKey

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is not valid.",
    "retryable": false,
    "request_id": "req_2Mz6Rt8KcW1p"
  }
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.