TRANXACT.AI Help

Accounting · Bank Connectivity

Bank Aggregators

The subscription that reaches banks on this company’s behalf — Plaid, Tink, TrueLayer or Salt Edge. Put the client id and secret here and the aggregator becomes the default route in Connect a Bank; the secret is sealed on the way in and never comes back out. Without a row here the platform uses its own sandbox and says so on every screen.

Type REST9 operationsBase path /api/accounting/bank-aggregatorsPublished as /api/v1/bank-aggregators

Download specification (OpenAPI 3.1) Screen: Bank Aggregators

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Accounting › Bank Aggregators on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableacct.bank_aggregators · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

9 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/bank-aggregatorsList bank aggregators

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "provider": "plaid",
      "label": "text",
      "environment": "sandbox",
      "base_url": "https://example.com",
      "client_id": "text",
      "client_secret_cipher": "text",
      "products": [],
      "countries": [],
      "is_default": true,
      "is_active": true,
      "created_at": "2026-10-30T09:00:00Z",
      "updated_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/bank-aggregators?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/bank-aggregators/{id}Read one bank aggregators

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider": "plaid",
  "label": "text",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "client_id": "text",
  "client_secret_cipher": "text",
  "products": [],
  "countries": [],
  "is_default": true,
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "updated_at": "2026-10-30T09:00:00Z"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/bank-aggregators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-aggregatorsCreate a bank aggregators

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
providertextYesService — "sandbox" is this platform’s own and needs no account.
Allowed: plaid tink truelayer saltedge sandbox
labeltextYesSubscription name — What to call it here, e.g. "Plaid production".
environmenttextNoEnvironment — Plaid issues a DIFFERENT secret per environment. A sandbox secret sent to production comes back INVALID_API_KEYS, which is worth recognising.
Allowed: sandbox development production
base_urltextNoAPI endpoint — Leave empty to use the service’s own address for the environment above.
client_idtextNoClient id
products_textNoAllowed to read — balances, transactions. Read-only by default and deliberately.
countries_textNoCountries — ISO 3166 alpha-2.
is_defaultbooleanNoUse this one
is_activebooleanNoActive
redirect_uritextNoRedirect URI — Where the bank sends the browser back to, and it must match a URI registered in the service’s own dashboard character for character. Required for Chase, Bank of America, Capital One and every other bank reached over OAuth — without it those banks refuse the link, while a smaller one still connects. This console’s address followed by /accounting/connect-a-bank.

Sample body

{
  "provider": "plaid",
  "label": "text",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "client_id": "text",
  "products": []
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider": "plaid",
  "label": "text",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "client_id": "text",
  "client_secret_cipher": "text",
  "products": [],
  "countries": [],
  "is_default": true,
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "updated_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-aggregators" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"provider":"plaid","label":"text","environment":"sandbox","base_url":"https://example.com","client_id":"text","products":[]}'
PUT/api/accounting/bank-aggregators/{id}Change a bank aggregators

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
providertextYesService — "sandbox" is this platform’s own and needs no account.
Allowed: plaid tink truelayer saltedge sandbox
labeltextYesSubscription name — What to call it here, e.g. "Plaid production".
environmenttextNoEnvironment — Plaid issues a DIFFERENT secret per environment. A sandbox secret sent to production comes back INVALID_API_KEYS, which is worth recognising.
Allowed: sandbox development production
base_urltextNoAPI endpoint — Leave empty to use the service’s own address for the environment above.
client_idtextNoClient id
products_textNoAllowed to read — balances, transactions. Read-only by default and deliberately.
countries_textNoCountries — ISO 3166 alpha-2.
is_defaultbooleanNoUse this one
is_activebooleanNoActive
redirect_uritextNoRedirect URI — Where the bank sends the browser back to, and it must match a URI registered in the service’s own dashboard character for character. Required for Chase, Bank of America, Capital One and every other bank reached over OAuth — without it those banks refuse the link, while a smaller one still connects. This console’s address followed by /accounting/connect-a-bank.

Sample body

{
  "provider": "plaid",
  "label": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider": "plaid",
  "label": "text",
  "environment": "sandbox",
  "base_url": "https://example.com",
  "client_id": "text",
  "client_secret_cipher": "text",
  "products": [],
  "countries": [],
  "is_default": true,
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z",
  "updated_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/bank-aggregators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"provider":"plaid","label":"text"}'
DELETE/api/accounting/bank-aggregators/{id}Delete a bank aggregators

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/accounting/bank-aggregators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-aggregators/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-aggregators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/accounting/bank-aggregators/{id}/secretSecret

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

clientSecret

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/bank-aggregators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"clientSecret":"value"}'
POST/api/accounting/bank-aggregators/{id}/testTest

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-aggregators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-aggregators/{id}/rehearseRehearse

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-aggregators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rehearse" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a bank aggregators, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
providertextread, writeService — "sandbox" is this platform’s own and needs no account.
Allowed: plaid tink truelayer saltedge sandbox
labeltextread, writeSubscription name — What to call it here, e.g. "Plaid production".
environmenttextread, writeEnvironment — Plaid issues a DIFFERENT secret per environment. A sandbox secret sent to production comes back INVALID_API_KEYS, which is worth recognising.
Allowed: sandbox development production
base_urltextread, writeAPI endpoint — Leave empty to use the service’s own address for the environment above.
client_idtextread, writeClient id
client_secret_cipherbytearead onlyClient secret cipher
products_textread, writeAllowed to read — balances, transactions. Read-only by default and deliberately.
countries_textread, writeCountries — ISO 3166 alpha-2.
is_defaultbooleanread, writeUse this one
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
redirect_uritextread, writeRedirect URI — Where the bank sends the browser back to, and it must match a URI registered in the service’s own dashboard character for character. Required for Chase, Bank of America, Capital One and every other bank reached over OAuth — without it those banks refuse the link, while a smaller one still connects. This console’s address followed by /accounting/connect-a-bank.
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Bank Aggregators for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.