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.
/api/accounting/bank-cataloguePublished as /api/v1/bank-catalogueOverview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | acct.bank_institutions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Bank code |
name | text | Yes | Legal name |
short_name | text | No | Short name |
country | text | No | Country |
external_id | text | No | External id |
aggregator | text | No | Aggregator |
brand_color | text | No | Brand colour |
initials | text | No | Initials — Two letters, drawn on the brand colour. |
provider_id | uuid | No | Provider id |
auth_flow | text | No | Aggregator sign-in Allowed: credentials oauth |
needs_mfa | boolean | No | Asks a second question |
products | _text | No | Products |
popularity | integer | No | Rank on the front page |
is_active | boolean | No | Offered |
supports_direct_connect | boolean | No | Runs its own download service |
ofx_url | text | No | OFX endpoint |
ofx_org | text | No | OFX organization |
ofx_fid | text | No | OFX financial institution id |
ofx_version | integer | No | OFX version |
credential_label | text | No | What the bank calls the credential |
credential_help | text | No | How to get one |
enrolment_url | text | No | Where to enrol |
credential_ttl_days | integer | No | Credential lasts (days) |
supports_oauth | boolean | No | Offers a sign-in on its own site |
oauth_network | text | No | Reached through — Who a company has to register with to reach this bank. Allowed: bank akoya plaid finicity mx tink truelayer sandbox |
oauth_authorize_url | text | No | Authorization endpoint |
oauth_token_url | text | No | Token endpoint |
oauth_scopes | _text | No | Scopes |
data_api_base | text | No | Data API base |
data_api_standard | text | No | Data API dialect Allowed: fdx plaid custom |
oauth_uses_pkce | boolean | No | Uses PKCE |
developer_url | text | No | Where to register |
consent_ttl_days | integer | No | Consent 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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Bank code |
name | text | Yes | Legal name |
short_name | text | No | Short name |
country | text | No | Country |
external_id | text | No | External id |
aggregator | text | No | Aggregator |
brand_color | text | No | Brand colour |
initials | text | No | Initials — Two letters, drawn on the brand colour. |
provider_id | uuid | No | Provider id |
auth_flow | text | No | Aggregator sign-in Allowed: credentials oauth |
needs_mfa | boolean | No | Asks a second question |
products | _text | No | Products |
popularity | integer | No | Rank on the front page |
is_active | boolean | No | Offered |
supports_direct_connect | boolean | No | Runs its own download service |
ofx_url | text | No | OFX endpoint |
ofx_org | text | No | OFX organization |
ofx_fid | text | No | OFX financial institution id |
ofx_version | integer | No | OFX version |
credential_label | text | No | What the bank calls the credential |
credential_help | text | No | How to get one |
enrolment_url | text | No | Where to enrol |
credential_ttl_days | integer | No | Credential lasts (days) |
supports_oauth | boolean | No | Offers a sign-in on its own site |
oauth_network | text | No | Reached through — Who a company has to register with to reach this bank. Allowed: bank akoya plaid finicity mx tink truelayer sandbox |
oauth_authorize_url | text | No | Authorization endpoint |
oauth_token_url | text | No | Token endpoint |
oauth_scopes | _text | No | Scopes |
data_api_base | text | No | Data API base |
data_api_standard | text | No | Data API dialect Allowed: fdx plaid custom |
oauth_uses_pkce | boolean | No | Uses PKCE |
developer_url | text | No | Where to register |
consent_ttl_days | integer | No | Consent 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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Bank code |
name | text | read, write | Legal name |
short_name | text | read, write | Short name |
country | text | read, write | Country |
external_id | text | read, write | External id |
aggregator | text | read, write | Aggregator |
brand_color | text | read, write | Brand colour |
initials | text | read, write | Initials — Two letters, drawn on the brand colour. |
provider_id | uuid | read, write | Provider id |
auth_flow | text | read, write | Aggregator sign-in Allowed: credentials oauth |
needs_mfa | boolean | read, write | Asks a second question |
products | _text | read, write | Products |
popularity | integer | read, write | Rank on the front page |
is_active | boolean | read, write | Offered |
created_at | timestamp with time zone | read only | Created at |
supports_direct_connect | boolean | read, write | Runs its own download service |
ofx_url | text | read, write | OFX endpoint |
ofx_org | text | read, write | OFX organization |
ofx_fid | text | read, write | OFX financial institution id |
ofx_version | integer | read, write | OFX version |
ofx_app_id | text | read only | Ofx app id |
ofx_app_ver | text | read only | Ofx app ver |
credential_label | text | read, write | What the bank calls the credential |
credential_help | text | read, write | How to get one |
enrolment_url | text | read, write | Where to enrol |
credential_ttl_days | integer | read, write | Credential lasts (days) |
supports_oauth | boolean | read, write | Offers a sign-in on its own site |
oauth_network | text | read, write | Reached through — Who a company has to register with to reach this bank. Allowed: bank akoya plaid finicity mx tink truelayer sandbox |
oauth_authorize_url | text | read, write | Authorization endpoint |
oauth_token_url | text | read, write | Token endpoint |
oauth_scopes | _text | read, write | Scopes |
data_api_base | text | read, write | Data API base |
data_api_standard | text | read, write | Data API dialect Allowed: fdx plaid custom |
oauth_uses_pkce | boolean | read, write | Uses PKCE |
developer_url | text | read, write | Where to register |
consent_ttl_days | integer | read, write | Consent lasts (days) |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Bank Catalogue for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.