Skip to content

reward.failed

POST

Sent when a delivery fails. Nothing was charged and the hold was released.

Aura-Event-Id
required
string

The event’s unique ID. The same event delivered twice has the same ID.

Example

evt_01JAC7T2Q4N8M3B6H6K8P1D5QS
Aura-Event-Type
required
string

Example

reward.delivered
Aura-Timestamp
required
string

When this delivery attempt was signed, in Unix seconds.

Example

1792489320
Aura-Signature
required
string

v1= followed by the lowercase hex HMAC-SHA256 of {Aura-Timestamp}.{raw body}, keyed with your webhook secret. During a secret rotation the header carries two signatures separated by a comma.

Example

v1=8c3e0f2b9e8a41b3c6d0e9f2a7b4c1d8e3f6a9b2c5d8e1f4a7b0c3d6e9f2a5b8
Media typeapplication/json
object
id
required

Same as the Aura-Event-Id header.

string
object
required
string
Allowed value: event
type
required
string
created_at
required
string format: date-time
test
required

true for events from test actions and for test events sent from the dashboard.

boolean
type
required
string
Allowed values: reward.delivered reward.failed reward.flagged
data
required
object
object
required
object
id
required
string
object
required
string
Allowed value: reward
campaign_id
required
string
action_id
required

The action that earned it. null for the first week’s data of a plan started by offer, which accepting earns.

string | null
customer_id
required
string
kind
required

plan_delivery: a period’s data. first_action: a one-off reward for starting the plan. referral: a referral reward.

string
Allowed values: plan_delivery first_action referral
amount_gb
required

An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.

number
multiple of 0.01
status
required

waiting_for_customer: earned, waiting for the customer to accept the plan. flagged: waiting for review. waiting_for_balance: your balance doesn’t cover it; it waits up to 24 hours for a top-up, then fails. pending: its price is held and the delivery is on its way. delivered: the network confirmed it and your balance was charged. failed: not delivered, nothing charged. reversed: the network reversed a delivery and you were refunded. rejected: rejected in review, or lapsed because the customer didn’t accept the plan.

string
Allowed values: waiting_for_customer flagged waiting_for_balance pending delivered failed reversed rejected
phone_number
required

The number the data goes to, chosen by the customer when they accepted the plan. null until they accept.

string | null
network_id
required

The number’s network, found by a number lookup before delivery.

string | null
period
required

The plan period this delivery is for. null for referral and first-action rewards.

object
starts_at
required
string format: date-time
ends_at
required
string format: date-time
price
required
One of:
object
amount
required

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

integer
currency
required

ISO 4217 currency code.

string
/^[A-Z]{3}$/
created_at
required
string format: date-time
resolve_by
required

Set when delivery starts. The delivery is final by then, as for purchases.

string | null format: date-time
delivered_at
required
string | null format: date-time
failure
required
object
code
required

Why a delivery failed. The first five match the Data Reselling API. New codes may be added in v1.

string
Allowed values: network_rejected number_not_eligible bundle_unavailable network_timeout internal_error insufficient_balance
message
required
string
reversal
required
object
reversed_at
required
string format: date-time
reason
required
string
rejection

Present when the reward was rejected.

object
reason
required
string
Allowed values: rejected_in_review customer_not_accepted
note

The reviewer’s note, if any.

string | null
test
required
boolean

Return any 2xx status within 10 seconds to acknowledge the event.