v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB

Balance

Retrieve your balance and last transaction date

Ensure that you have enough available balance before executing a create payout request.

For more information, see the documentation, and for sample calls, see the public Postman collection.

get/merchants/{merchantId}/balance

merchantIdstring required

A unique merchant ID provided by Peach Payments in hexadecimal format.

Example:d0bf5a6a909111f0aabf02d14af18cff

A unique merchant ID provided by Peach Payments.

The 200 response returns an object containing the current balance, the last recognised transaction date, and the currency.

currency'ZAR'

A three-letter currency code (ISO 4217). ZAR is supported for Tyme payouts.

availableBalancenumber

The available balance represented in the minor currency (that is, cents) where 32123 is 321.23 in the major currency.

lastTransactionDatestring date-time

The ISO-8601 timestamp of your last transaction.

{
  "currency": "ZAR",
  "availableBalance": 32123,
  "lastTransactionDate": "2024-03-14T22:00:00.000Z"
}