Skip to content

Rewards and your balance

A reward is one delivery of data to one customer’s number. Each earned action creates one, or two for a referral, and accepting an offer creates the first week’s.

kind What it is
plan_delivery A week’s data on the plan.
first_action A one-off reward for the action that starts the plan, when the plan has one.
referral A referral reward, one for the customer and one for the friend.
status What it means
waiting_for_customer Earned, and waiting for the customer to accept the plan.
flagged Waiting for your review. See Flagged rewards.
waiting_for_balance Your available balance doesn’t cover it. It waits up to 24 hours for a top-up.
pending Its price is held from your balance and the delivery is on its way.
delivered The network confirmed the data was credited, and your balance was charged.
failed Not delivered. Nothing was charged.
reversed The network reversed a delivery it had confirmed, and you were refunded.
rejected Rejected in review, or lapsed because the customer didn’t accept the plan in time.

delivered, failed, reversed and rejected are final. A reward only moves forward.

Rewards are paid from your prepaid balance, in naira. Each reward’s price is the network’s price for that delivery, in kobo: { "amount": 100000, "currency": "NGN" } is ₦1,000.

  1. When delivery starts, the price is held and resolve_by is set. The delivery is final by then, within 30 minutes.
  2. When the network confirms the credit, the reward is delivered and the held amount is charged.
  3. If the delivery fails, the hold is released and nothing is charged.
  4. If the network later reverses it, you are refunded.

Your balance and daily statements use the same endpoints as the Data Reselling API: Get your balance and statements.

When your available balance falls below its warning level, Aura sends balance.low and emails your admins and billing contacts a ready invoice that tops it back up. The warning level is two weeks’ spend unless you change it in the dashboard. days_left in the event says how long the balance lasts at the current rate.

A reward your balance can’t cover waits as waiting_for_balance for up to 24 hours. If a top-up arrives in that time, it is delivered. If not, it fails with insufficient_balance.

Aura’s bonus-hunter checks can hold a reward for review before it is delivered. Aura sends reward.flagged, and the reward waits in the dashboard’s review queue:

  • Approve it, and it is delivered.
  • Reject it, and Aura sends reward.rejected. The reward’s rejection.reason is rejected_in_review, with the reviewer’s note if there is one, and the action’s earned becomes false.

A failed reward carries a failure.code:

failure.code What it means
network_rejected The network refused the credit.
number_not_eligible The network won’t credit this data to this number. The customer can choose another number.
bundle_unavailable The network couldn’t supply this amount of data at the time.
network_timeout The network didn’t confirm the credit by resolve_by.
internal_error Aura couldn’t complete the delivery.
insufficient_balance Your balance didn’t cover it within 24 hours.

New failure codes may be added within v1. A failed reward is never charged.

GET /rewards lists rewards, newest first, and filters by campaign, customer, status and time. GET /rewards/{reward_id} returns one reward as it is now, with the number it went to, its network, the week it was for and its price.