Initiate a Free Basic Electricity sale

SALE-direction Free Basic Electricity (FBE) flow. FBE is zero-priced, so the seller merchant account is not debited. Partner callers infer the seller from the JWT. MVNO callers omit sellingPartnerUuid to sell from the MVNO default merchant account, or supply sellingPartnerUuid to sell on behalf of a partner. Meter number is supplied inline.

Access: Auth methods: JWT bearer or API key. Allowed user types: PARTNER, MVNO. Requires permissions: purchase:admin.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Selected selling partner UUID. Partner callers infer this from the JWT. MVNO callers omit it to sell from the MVNO default merchant account, or supply it to sell on behalf of a partner.

string

Agent record UUID for partner commission attribution. Requires sellingPartnerUuid for MVNO callers and must belong to the selling partner.

string
required

Customer's app_user UUID. The sold token is allocated to this customer.

string
required

Electricity product UUID (electricity or Free Basic Electricity).

string
required

SA prepaid electricity meter number (11 digits).

Headers
string
required

Client-generated UUID v4. Reuse the same key only when retrying the exact same request.

Responses

201

FBE sale initiated

400

Invalid input

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json