General

Balances

Request your available account balance to be paid out to your default banking details, list previous balance payout requests, and inspect the journal entries that make up a specific payout.

Request

Request your available balance to be paid out to you via your default banking details. The platform calculates your available balance (settled payments, less fees and any retention), reserves those funds, schedules the payout for settlement to your bank, and returns the resulting balance payout record.

A balance payout may only be requested once per day. Balance payouts are not available on test accounts.

Path

POST /balances/request

Request Body

No request body is required.

{}

Response Body

{
  "status": true,
  "record": {
    "id": "pou_u1hPyxZ9A2A2Pr9gpH6FF",
    "created_at": "2024-12-28 22:14:47",
    "paid_out_at": null,
    "balance_status": "PENDING",
    "currency": "ZAR",
    "amount": "567.12",
    "fee": "43.00",
    "eft_reference": "KWIK BOK 20260310",
    "retention": "-33.10",
    "total": "3317.56"
  }
}

Response Parameters

Field	Type	Description	Example
status	Boolean	true - response success, false - response error	true
record.id	String(32)	Unique ID of this balance payout	pou_u1hPyxZ9A2A2Pr9gpH6FF
record.created_at	Timestamp(YYYY-MM-DD HH:mm:ss)	When the balance payout was requested	2024-12-28 22:14:47
record.paid_out_at	Date(YYYY-MM-DD)	When the balance payout was paid out; `null` while still pending	2026-03-10
record.balance_status	ENUM	(`PENDING`,`CANCELLED`,`COMPLETED`,`FAILED`)	PENDING
record.currency	ENUM	Currency of the payout	ZAR
record.amount	Decimal	Available balance being paid out (before fees and retention)	567.12
record.fee	Decimal	Total fees deducted from the payout (accumulated fees plus the RTC payout fee)	43.00
record.eft_reference	String(20)	Reference that reflects on the bank statement	KWIK BOK 20260310
record.retention	Decimal	Retention adjustment applied to the payout; a negative value releases previously retained funds	-33.10
record.total	Decimal	Net amount paid out (`amount` + `retention` - `fee`)	3317.56

List

List all the balance payouts that have been requested.

Path

GET /balances/list?{query parameters}

Query Parameters

Field	Required	Description	Example
start_date	N	Filter for balance payouts requested on or after this date	2025-01-01
end_date	N	Filter for balance payouts requested on or before this date	2025-12-31

Response Body

{
  "status": true,
  "records": [{
    "id": "pou_u1hPyxZ9A2A2Pr9gpH6FF",
    "created_at": "2025-12-28 22:14:47",
    "paid_out_at": "2026-03-10",
    "balance_status": "PENDING",
    "currency": "ZAR",
    "amount": "567.12",
    "fee": "43.00",
    "eft_reference": "KWIK BOK 20260310",
    "retention": "-33.10",
    "total": "3317.56"
  }]
}

Response Parameters

Field	Type	Description	Example
status	Boolean	true - response success, false - response error	true
*.id	String(32)	Unique ID of this balance payout	pou_u1hPyxZ9A2A2Pr9gpH6FF
*.created_at	Timestamp(YYYY-MM-DD HH:mm:ss)	When the balance payout was requested	2025-12-28 22:14:47
*.paid_out_at	Date(YYYY-MM-DD)	When the balance payout was paid out; `null` while still pending	2026-03-10
*.balance_status	ENUM	(`PENDING`,`CANCELLED`,`COMPLETED`,`FAILED`)	PENDING
*.currency	ENUM	Currency of the payout	ZAR
*.amount	Decimal	Available balance being paid out (before fees and retention)	567.12
*.fee	Decimal	Total fees deducted from the payout	43.00
*.eft_reference	String(20)	Reference that reflects on the bank statement	KWIK BOK 20260310
*.retention	Decimal	Retention adjustment applied to the payout	-33.10
*.total	Decimal	Net amount paid out	3317.56

Journals

Get the journal entries that make up a specific balance payout.

Path

GET /balances/journals/{id}

Path Parameters

Field	Required	Description	Example
id	Y	ID of the balance payout to inspect	pou_u1hPyxZ9A2A2Pr9gpH6FF

Response Body

{
  "status": true,
  "records": [{
    "id": "jen_logOglxD1N3jL9xfUcYWb",
    "date_payout_effective": "2026-06-28",
    "transactions_id": "tra_abc123",
    "journal_type": "CREDIT",
    "transaction_type": "PAYMENT_SUCCESS",
    "payment_method_id": "pam_YxK0zCtJpVpRzdBYTlxnm",
    "currency": "ZAR",
    "amount": "567.12"
  }]
}

Response Parameters

Field	Type	Description	Example
status	Boolean	true - response success, false - response error	true
*.id	String(32)	Unique ID of this journal entry	jen_logOglxD1N3jL9xfUcYWb
*.date_payout_effective	Date(YYYY-MM-DD)	Date the entry becomes payout effective; `null` when not applicable	2026-06-28
*.transactions_id	String(32)	ID of the related transaction, see transactions; `null` when the entry is not linked to a transaction	tra_VLSEUZK5STgmP4J6yBDlU
*.journal_type	ENUM	(`CREDIT`,`DEBIT`)	CREDIT
*.transaction_type	ENUM	Type of journal entry (e.g. `PAYMENT_SUCCESS`, `RTC_PAYOUT_FEE`)	PAYMENT_SUCCESS
*.payment_method_id	String(32)	ID of the related payment method, see payment methods; `null` when not applicable	pam_YxK0zCtJpVpRzdBYTlxnm
*.currency	ENUM	Currency of the journal entry	ZAR
*.amount	Decimal	Amount of the journal entry in ZAR	567.12

Lookups

Retrieve reference data and validation values used across the API including bank names, account types, countries, provinces, client types, and ID types. Essential for populating dropdown lists and validating form inputs.

Payment Methods

Retrieve available payment methods including EFT Debit Orders, DebiCheck, Registered Mandates, Card payments, and Pay-in methods. Essential for determining supported banks and payment options for your customers.