API overview

Send payouts automatically from a prefunded vendor account. Use methods to discover the options available to your vendor. Single payouts return their verdict synchronously; batches return 202 and process in the background.

Base URL and auth

• https://payout.fluxr.co.za
• Authorization: Bearer <vendor token>; Accept: application/json.
• Token scopes: payouts:read, payouts:write, payouts:delivery (opt-in, audited — grants collection PINs).
• All records are scoped to the authenticated vendor; {reference} in paths is the vendor's own reference.

Endpoints

Method	Path	Scope	Result
GET	/api/v1/account	read	balance and fee
GET	/api/v1/methods	read	enabled methods with limits
POST	/api/v1/payouts	write	synchronous payout — 200 with the provider verdict
GET	/api/v1/payouts/{reference}	read	current state
POST	/api/v1/batches	write	202, reserved and queued
GET	/api/v1/batches/{reference}	read	batch with items
GET	/api/v1/payouts/{reference}/delivery	delivery	collection PIN/serial (paid only)
POST	/api/v1/payouts/{reference}/resend-sms	write	provider SMS resend

Envelope

Success: { "success": true, "data": { ... } }

Failure: { "success": false, "code": "PROVIDER_REJECTED", "message": "<user-safe>", "errors": { "recipient.id_number": ["..."] } }

message is fixed per code and may be shown verbatim to end users.

First request

curl https://payout.fluxr.co.za/api/v1/account \
  -H 'Authorization: Bearer YOUR_VENDOR_TOKEN' \
  -H 'Accept: application/json'

Send Content-Type: application/json for JSON request bodies. Keep vendor tokens on your server.

A 200 response may still be pending. Complete a withdrawal only when its status is paid; see statuses and accounting.

Download OpenAPI. All example identities and payment references in this site are synthetic.