Delete all saved bank credentials and their accounts

DELETE

/credentials

curl --request DELETE \
  --url https://api.banklink.co.za/v1/credentials \
  --header 'Authorization: Bearer <token>'

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

Requires credentials:delete. Scoped to the authenticated organisation. Removes every linked account: its encrypted credentials, stored transactions and sync history are permanently deleted, and pulses that used it are switched off. deleted is the number of accounts removed; repeating the call returns deleted: 0. Does not bill a credit. Requests already running may finish. Existing backup retention applies.

Authorizations

• bearerAuth

Responses

200

Accounts removed

Media typeapplication/json

object

data

object

success

boolean

deleted

integer

Example ^generated

{
  "data": {
    "success": true,
    "deleted": 1
  }
}

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

403

Missing credentials:delete scope

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