Get bank account

GET

/accounts/{id}

const url = 'https://api.banklink.co.za/v1/accounts/3fa85f64-5717-4562-b3fc-2c963f66afa6';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns a single linked bank account by ID.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

UUID of the bank account (bank profile)

Example

3fa85f64-5717-4562-b3fc-2c963f66afa6

Responses

200

Account details

application/json

object

data

required

object

required

Unique identifier for the bank profile

string format: uuid

bank

required

Bank identifier (e.g. “fnb”, “absa”)

string

account_number

required

Bank account number. Null until first sync completes.

string | null

has_credentials

Whether credentials are saved for unattended access

boolean

nickname

required

Display name for the account

string

last_synced_at

required

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

string | null format: date-time

created_at

required

ISO 8601 timestamp when the account was linked

string format: date-time

Example

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bank": "fnb",
    "account_number": "62012345678",
    "nickname": "FNB Business Account",
    "last_synced_at": "2026-06-08T10:00:00.000Z",
    "created_at": "2026-06-01T08:00:00.000Z"
  }
}

401

Missing or invalid API key

application/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

application/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"
  }
}