Skip to main content
POST
Simulate a failed top-up

Authorizations

Authorization
string
header
required

Your fleet API key, e.g. Authorization: Bearer cxk_live_…. Create keys in the fleet portal under Developers.

Path Parameters

fundingId
string
required

Response

Success

object
enum<string>
required
Available options:
funding
id
string
required
status
enum<string>
required
Available options:
pending,
success,
failed,
expired
amount
string
required

GHS

Example:

"125.50"

currency
enum<string>
required
Available options:
GHS
unit_price
string
required

GHS per kWh

Example:

"125.50"

kwh
string
required

kWh this amount buys

Example:

"12.5000"

credited_kwh
string | null
required

kWh credited once paid

Example:

"12.5000"

debt_repaid
string | null
required

GHS of credit repaid first

Example:

"125.50"

invoice_number
string | null
required
checkout_url
string | null
required

ExpressPay page where a person completes payment. Null in the sandbox.

credited_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
sandbox
enum<boolean>

Present on sandbox top-ups

Available options:
true