Skip to content

Overview

Tell Aura what your customers did. Aura decides what they earn, delivers it and tells you every plan moment.

You build each data plan in the Aura dashboard. Your systems then report what your customers do, such as a savings deposit each week, and Aura checks the plan’s rules, delivers the data on the customer’s own network and sends you a webhook for every moment of the plan, so you can message customers in your own app.

A plan starts in one of two ways, set for each campaign: after an action, such as a first deposit, or by an offer you send to customers you pick, with no action needed first. Either way the customer accepts the plan on the plan card, and the first week’s data arrives straight away. After that, the plan’s action keeps it.

Conventions (the same as the Data Reselling API)

  • Requests and responses are JSON, encoded as UTF-8.
  • Phone numbers use E.164 format, such as +2348000000001.
  • Money is in naira: an integer in kobo, with the currency code NGN.
  • Data is measured in gigabytes (GB) of mobile data, as you set it in the plan, such as 1.5 for 1.5GB. You never see network bundles.
  • Timestamps are ISO 8601. Aura returns UTC. Days and weeks are counted in Lagos time.
  • Every response carries an Aura-Request-Id header.
  • Lists are paginated with limit and cursor.

Sandbox. Test keys work only on the sandbox server. The Data Reselling test numbers +2348000000001 to …005 and …007 give the same delivery outcomes here, +2348000000008 always gets a flagged reward, and POST /sandbox/plans/{plan_id}/advance moves a test plan forward in time so you can receive every plan webhook without waiting a week.

All example values, including customer IDs, plan names, networks, prices and times, are illustrative.

Information

  • License: Proprietary
  • OpenAPI version: 3.1.0

Send your secret key as Authorization: Bearer <key>. Live keys start aura_live_ and test keys start aura_test_. Developers and admins create and rotate keys in the dashboard. Live keys need a verified business.

Security scheme type: http