TRANXACT.AI Help

Accounting · Bank Connectivity

Bank Catalogue

Which banks can be connected and how: a sign-in on the bank’s own site, the bank’s own download service, or through the aggregator. Where a bank offers a sign-in, its authorization and token endpoints belong here — they come from the developer portal with the client credentials.

Type REST6 operationsBase path /api/accounting/bank-cataloguePublished as /api/v1/bank-catalogue

Download specification (OpenAPI 3.1) Screen: Bank Catalogue

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 Catalogue 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_institutions · 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

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

GET/api/accounting/bank-catalogueList bank catalogue

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",
      "code": "COD-000001",
      "name": "Example",
      "short_name": "Example",
      "country": "US",
      "external_id": "text",
      "aggregator": "text",
      "brand_color": "text",
      "initials": "text",
      "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "auth_flow": "credentials",
      "needs_mfa": true,
      "products": [],
      "popularity": 10
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "short_name": "Example",
  "country": "US",
  "external_id": "text",
  "aggregator": "text",
  "brand_color": "text",
  "initials": "text",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "auth_flow": "credentials",
  "needs_mfa": true,
  "products": [],
  "popularity": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesBank code
nametextYesLegal name
short_nametextNoShort name
countrytextNoCountry
external_idtextNoExternal id
aggregatortextNoAggregator
brand_colortextNoBrand colour
initialstextNoInitials — Two letters, drawn on the brand colour.
provider_iduuidNoProvider id
auth_flowtextNoAggregator sign-in
Allowed: credentials oauth
needs_mfabooleanNoAsks a second question
products_textNoProducts
popularityintegerNoRank on the front page
is_activebooleanNoOffered
supports_direct_connectbooleanNoRuns its own download service
ofx_urltextNoOFX endpoint
ofx_orgtextNoOFX organization
ofx_fidtextNoOFX financial institution id
ofx_versionintegerNoOFX version
credential_labeltextNoWhat the bank calls the credential
credential_helptextNoHow to get one
enrolment_urltextNoWhere to enrol
credential_ttl_daysintegerNoCredential lasts (days)
supports_oauthbooleanNoOffers a sign-in on its own site
oauth_networktextNoReached through — Who a company has to register with to reach this bank.
Allowed: bank akoya plaid finicity mx tink truelayer sandbox
oauth_authorize_urltextNoAuthorization endpoint
oauth_token_urltextNoToken endpoint
oauth_scopes_textNoScopes
data_api_basetextNoData API base
data_api_standardtextNoData API dialect
Allowed: fdx plaid custom
oauth_uses_pkcebooleanNoUses PKCE
developer_urltextNoWhere to register
consent_ttl_daysintegerNoConsent lasts (days)

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "short_name": "Example",
  "country": "US",
  "external_id": "text",
  "aggregator": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "short_name": "Example",
  "country": "US",
  "external_id": "text",
  "aggregator": "text",
  "brand_color": "text",
  "initials": "text",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "auth_flow": "credentials",
  "needs_mfa": true,
  "products": [],
  "popularity": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-catalogue" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","short_name":"Example","country":"US","external_id":"text","aggregator":"text"}'
PUT/api/accounting/bank-catalogue/{id}Change a bank catalogue

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
codetextYesBank code
nametextYesLegal name
short_nametextNoShort name
countrytextNoCountry
external_idtextNoExternal id
aggregatortextNoAggregator
brand_colortextNoBrand colour
initialstextNoInitials — Two letters, drawn on the brand colour.
provider_iduuidNoProvider id
auth_flowtextNoAggregator sign-in
Allowed: credentials oauth
needs_mfabooleanNoAsks a second question
products_textNoProducts
popularityintegerNoRank on the front page
is_activebooleanNoOffered
supports_direct_connectbooleanNoRuns its own download service
ofx_urltextNoOFX endpoint
ofx_orgtextNoOFX organization
ofx_fidtextNoOFX financial institution id
ofx_versionintegerNoOFX version
credential_labeltextNoWhat the bank calls the credential
credential_helptextNoHow to get one
enrolment_urltextNoWhere to enrol
credential_ttl_daysintegerNoCredential lasts (days)
supports_oauthbooleanNoOffers a sign-in on its own site
oauth_networktextNoReached through — Who a company has to register with to reach this bank.
Allowed: bank akoya plaid finicity mx tink truelayer sandbox
oauth_authorize_urltextNoAuthorization endpoint
oauth_token_urltextNoToken endpoint
oauth_scopes_textNoScopes
data_api_basetextNoData API base
data_api_standardtextNoData API dialect
Allowed: fdx plaid custom
oauth_uses_pkcebooleanNoUses PKCE
developer_urltextNoWhere to register
consent_ttl_daysintegerNoConsent lasts (days)

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "short_name": "Example",
  "country": "US",
  "external_id": "text",
  "aggregator": "text",
  "brand_color": "text",
  "initials": "text",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "auth_flow": "credentials",
  "needs_mfa": true,
  "products": [],
  "popularity": 10
}

Sample request

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

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-catalogue/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-catalogue/{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-catalogue/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a bank catalogue, 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
codetextread, writeBank code
nametextread, writeLegal name
short_nametextread, writeShort name
countrytextread, writeCountry
external_idtextread, writeExternal id
aggregatortextread, writeAggregator
brand_colortextread, writeBrand colour
initialstextread, writeInitials — Two letters, drawn on the brand colour.
provider_iduuidread, writeProvider id
auth_flowtextread, writeAggregator sign-in
Allowed: credentials oauth
needs_mfabooleanread, writeAsks a second question
products_textread, writeProducts
popularityintegerread, writeRank on the front page
is_activebooleanread, writeOffered
created_attimestamp with time zoneread onlyCreated at
supports_direct_connectbooleanread, writeRuns its own download service
ofx_urltextread, writeOFX endpoint
ofx_orgtextread, writeOFX organization
ofx_fidtextread, writeOFX financial institution id
ofx_versionintegerread, writeOFX version
ofx_app_idtextread onlyOfx app id
ofx_app_vertextread onlyOfx app ver
credential_labeltextread, writeWhat the bank calls the credential
credential_helptextread, writeHow to get one
enrolment_urltextread, writeWhere to enrol
credential_ttl_daysintegerread, writeCredential lasts (days)
supports_oauthbooleanread, writeOffers a sign-in on its own site
oauth_networktextread, writeReached through — Who a company has to register with to reach this bank.
Allowed: bank akoya plaid finicity mx tink truelayer sandbox
oauth_authorize_urltextread, writeAuthorization endpoint
oauth_token_urltextread, writeToken endpoint
oauth_scopes_textread, writeScopes
data_api_basetextread, writeData API base
data_api_standardtextread, writeData API dialect
Allowed: fdx plaid custom
oauth_uses_pkcebooleanread, writeUses PKCE
developer_urltextread, writeWhere to register
consent_ttl_daysintegerread, writeConsent lasts (days)
org_unit_iduuidread onlyOrg unit id
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_attimestamp with time zoneread onlyUpdated at
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 Catalogue 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.