Get account balance

GET

/accounts/{id}/balance

curl --request GET \
  --url https://api.banklink.co.za/v1/accounts/3fa85f64-5717-4562-b3fc-2c963f66afa6/balance \
  --header 'Authorization: Bearer <token>'

• Production (use an sk_live_ key)
• Sandbox (same URL — use an sk_test_ key)

Returns the latest known balance for the account, derived from the most recent stored transaction. Returns null balance if no transactions have been ingested yet.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

UUID of the bank account (bank profile)

Example

3fa85f64-5717-4562-b3fc-2c963f66afa6

Responses

200

Latest balance

Media typeapplication/json

object

data

required

object

account_id

required

ID of the bank account

string format: uuid

balance

required

Latest known balance. Null if no transactions have been ingested yet.

number | null

currency

required

ISO 4217 currency code (defaults to ZAR when no transactions exist)

string

last_synced_at

required

ISO 8601 timestamp of the last sync. Null if never synced.

string | null format: date-time

Example

{
  "data": {
    "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "balance": 12500,
    "currency": "ZAR",
    "last_synced_at": "2026-06-08T10:00:00.000Z"
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

404

Resource not found

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

Example

{
  "error": {
    "code": "not_found",
    "message": "Account not found"
  }
}