Appearance
Account and methods
GET /api/v1/account
Requires payouts:read. Returns your prefunded gateway account inside the success envelope. available must cover the payout amount plus the effective fee from /methods. reserved is held for unfinished payouts. All amounts are ZAR decimal strings.
GET /api/v1/methods
Requires payouts:read. Returns a data array of methods available to your vendor, including limits, amount increments and whether bank details are required. Read these values before submitting; limits can change.
Supported contract slugs: standard_bank_instant_money, nedbank_cardless, rtc_eft, voucher_1voucher, voucher_ott, voucher_blu, voucher_easyload. Send the method slug in method.
Cash payouts require R10 multiples. RTC EFT accepts cents and requires recipient.bank_account. See payout rules.
Voucher methods
All voucher purchases use the Flash gateway. These limits come from the Flash catalogue dated 2026-09-15. Operations can tighten provider and vendor limits.
| Method | Source | Product code | Name | Increment | Minimum | Maximum |
|---|---|---|---|---|---|---|
voucher_1voucher | flash | 311 | 1Voucher | 0.01 | 1.00 | 4000.00 |
voucher_ott | flash | 1393 | OTT Voucher | 0.01 | 2.00 | 3000.00 |
voucher_blu | flash | 1652 | Blu Voucher | 0.01 | 2.00 | 2000.00 |
voucher_easyload | flash | 1651 | EasyLoad | 0.01 | 2.00 | 2500.00 |
GET /methods returns kind (cash, bank, or voucher), delivery (pin or null for bank transfers), and the effective fee in ZAR for each method. Voucher fees default to zero; explicit per-method vendor fees override this. Cash and bank methods fall back to the account's fee_per_payout. Fees are snapshotted and reserved with the face value when a payout is created.
Recipients still provide the identity block for our records. No recipient identity or phone is sent to Flash. Only the merchant reference, amount, product, vendor slug and configured account alias are submitted. The returned provider_reference is the Flash gateway transaction UUID, distinct from the merchant reference. PINs and serials are encrypted and excluded from ordinary responses unless the token has delivery access.
The Flash operational float and vendor prefund are separate balances. The current Flash gateway exposes transaction balance evidence but no standalone balance endpoint. Operations can record a dated snapshot using a gateway transaction UUID; this is its balance after that transaction, not a live balance.
Account fields
| Field | Type | Values |
|---|---|---|
id | string | — |
name | string | — |
available | string | — |
reserved | string | — |
fee_per_payout | string | — |
currency | string | — |
Method fields
| Field | Type | Values |
|---|---|---|
method | string | standard_bank_instant_money, nedbank_cardless, rtc_eft, voucher_1voucher, voucher_ott, voucher_blu, voucher_easyload |
name | string | — |
minimum | string | — |
maximum | string | — |
increment | string | — |
available | boolean | — |
requires_bank_account | boolean | — |
kind | string | cash, bank, voucher |
delivery | string or null | pin, `` |
fee | string | — |

