Trigger sync

POST

/accounts/{id}/sync

curl --request POST \
  --url https://api.banklink.co.za/v1/accounts/3fa85f64-5717-4562-b3fc-2c963f66afa6/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "credentials": { "additionalProperty": "example" } }'

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

Triggers an immediate bank sync for the specified account. Rate-limited to prevent abuse. Returns the number of new transactions ingested and the number of duplicates skipped.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

UUID of the bank account (bank profile)

Example

3fa85f64-5717-4562-b3fc-2c963f66afa6

Request Body

Media typeapplication/json

object

credentials

Fresh bank-specific credentials. Required when no credentials are saved; used only for this request and never stored.

object

key

additional properties

string

Example ^generated

{
  "credentials": {
    "additionalProperty": "example"
  }
}

Responses

200

Sync result

Media typeapplication/json

object

data

required

object

synced

required

Number of new transactions inserted

integer

skipped

required

Number of transactions skipped because they already exist

integer

Example

{
  "data": {
    "synced": 14,
    "skipped": 3
  }
}

400

Fresh credentials required or invalid

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

429

Too many requests — try again later

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

Human-readable error description

string

Example

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests"
  }
}