TRANXACT.AI Help

Accounting · Banks & Accounts

Bank Connections

One configured integration with one bank — endpoint, credentials, file transfer, the identifiers the bank assigned, and how often to collect. Credentials are encrypted on the way in and never come back out.

Type REST16 operationsBase path /api/accounting/bank-connectionsPublished as /api/v1/bank-connections

Download specification (OpenAPI 3.1) Screen: Bank Connections

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 Connections 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_connections · 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

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

GET/api/accounting/bank-connectionsList bank connections

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",
      "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "environment": "sandbox",
      "integration_type": "text",
      "auth_method": "text",
      "base_url": "https://example.com",
      "token_url": "https://example.com",
      "client_id": "text",
      "client_secret_cipher": "text",
      "api_key_cipher": "text",
      "scopes": [],
      "certificate_cipher": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "environment": "sandbox",
  "integration_type": "text",
  "auth_method": "text",
  "base_url": "https://example.com",
  "token_url": "https://example.com",
  "client_id": "text",
  "client_secret_cipher": "text",
  "api_key_cipher": "text",
  "scopes": [],
  "certificate_cipher": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
provider_iduuidYesBank
codetextYesConnection code — e.g. BANK-CHASE-01
nametextYesName
environmenttextNoEnvironment — Production is real money. Nothing else about the configuration changes.
Allowed: sandbox uat production
integration_typetextNoChannel — The test refuses a channel the bank does not offer.
auth_methodtextNoAuthentication
base_urltextNoAPI endpoint — HTTPS only.
token_urltextNoOAuth token endpoint
client_idtextNoClient ID
scopes_textNoScopes — e.g. balances:read, transactions:read, payments:write
certificate_expiresdateNoCertificate expires — The test warns thirty days out and fails once it has passed.
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usernametextNoSFTP username
inbound_dirtextNoInbound directory — Where the bank leaves statements.
outbound_dirtextNoOutbound directory — Where payment files are collected from.
pgp_key_idtextNoPGP key id
company_idtextNoBank-assigned company id
ach_company_idtextNoACH company id — The immediate origin on a NACHA file. Without it no ACH file can be built.
ach_company_nametextNoACH company name
originator_idtextNoOriginator id
division_codetextNoDivision code
webhook_urltextNoWebhook URL — Where the bank posts real-time notifications. Store a signing secret alongside it.
notification_emailtextNoNotification email
poll_interval_minutesintegerNoCollect every (minutes)
statement_formattextNoStatement format
payment_formattextNoPayment file format
auto_reconcilebooleanNoMatch the feed automatically
auto_postbooleanNoAuto post
match_tolerancenumericNoAmount tolerance — How far two amounts may differ and still be the same payment.
match_window_daysintegerNoDate window (days)
platform_connection_iduuidNoPlatform connection — Links this to the cross-application integration record.
statustextNoStatus
owner_iduuidNoOwner
notestextNoNotes

Sample body

{
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "environment": "sandbox",
  "integration_type": "text",
  "auth_method": "text",
  "base_url": "https://example.com"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "environment": "sandbox",
  "integration_type": "text",
  "auth_method": "text",
  "base_url": "https://example.com",
  "token_url": "https://example.com",
  "client_id": "text",
  "client_secret_cipher": "text",
  "api_key_cipher": "text",
  "scopes": [],
  "certificate_cipher": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-connections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"provider_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","environment":"sandbox","integration_type":"text","auth_method":"text","base_url":"https://example.com"}'
PUT/api/accounting/bank-connections/{id}Change a bank connections

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
provider_iduuidYesBank
codetextYesConnection code — e.g. BANK-CHASE-01
nametextYesName
environmenttextNoEnvironment — Production is real money. Nothing else about the configuration changes.
Allowed: sandbox uat production
integration_typetextNoChannel — The test refuses a channel the bank does not offer.
auth_methodtextNoAuthentication
base_urltextNoAPI endpoint — HTTPS only.
token_urltextNoOAuth token endpoint
client_idtextNoClient ID
scopes_textNoScopes — e.g. balances:read, transactions:read, payments:write
certificate_expiresdateNoCertificate expires — The test warns thirty days out and fails once it has passed.
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usernametextNoSFTP username
inbound_dirtextNoInbound directory — Where the bank leaves statements.
outbound_dirtextNoOutbound directory — Where payment files are collected from.
pgp_key_idtextNoPGP key id
company_idtextNoBank-assigned company id
ach_company_idtextNoACH company id — The immediate origin on a NACHA file. Without it no ACH file can be built.
ach_company_nametextNoACH company name
originator_idtextNoOriginator id
division_codetextNoDivision code
webhook_urltextNoWebhook URL — Where the bank posts real-time notifications. Store a signing secret alongside it.
notification_emailtextNoNotification email
poll_interval_minutesintegerNoCollect every (minutes)
statement_formattextNoStatement format
payment_formattextNoPayment file format
auto_reconcilebooleanNoMatch the feed automatically
auto_postbooleanNoAuto post
match_tolerancenumericNoAmount tolerance — How far two amounts may differ and still be the same payment.
match_window_daysintegerNoDate window (days)
platform_connection_iduuidNoPlatform connection — Links this to the cross-application integration record.
statustextNoStatus
owner_iduuidNoOwner
notestextNoNotes

Sample body

{
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "environment": "sandbox",
  "integration_type": "text",
  "auth_method": "text",
  "base_url": "https://example.com",
  "token_url": "https://example.com",
  "client_id": "text",
  "client_secret_cipher": "text",
  "api_key_cipher": "text",
  "scopes": [],
  "certificate_cipher": "text"
}

Sample request

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

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-connections/{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-connections/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-connections/{id}/credentialsCredentials

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 PUT "https://demo.tranxact.ai/api/accounting/bank-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credentials" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-connections/{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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-connections/{id}/transactionsTransactions

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):

accountId, externalAccountId, transactions*

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transactions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accountId":"value","externalAccountId":"value","transactions":"value"}'
POST/api/accounting/bank-connections/{id}/webhookWebhook

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):

signature, payload

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/webhook" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"signature":"value","payload":"value"}'
POST/api/accounting/bank-connections/{id}/syncSync

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sync" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/bank-connections/{id}/direct-connectDirect connect

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):

userId, credential, ofxUrl, ofxOrg, ofxFid, ofxVersion

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/direct-connect" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId":"value","credential":"value","ofxUrl":"value","ofxOrg":"value","ofxFid":"value","ofxVersion":"value"}'
POST/api/accounting/bank-connections/{id}/pullPull

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):

from, overlapDays

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pull" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from":"value","overlapDays":"value"}'
GET/api/accounting/bank-connections/{id}/direct-accountsDirect accounts

Path parameters

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

Response

200 with the data as JSON.

Sample request

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

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):

accounts

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/direct-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accounts":"value"}'
POST/api/accounting/bank-connections/{id}/oauth/refreshOauth refresh

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-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/oauth/refresh" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a bank connections, 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
provider_iduuidread, writeBank
codetextread, writeConnection code — e.g. BANK-CHASE-01
nametextread, writeName
environmenttextread, writeEnvironment — Production is real money. Nothing else about the configuration changes.
Allowed: sandbox uat production
integration_typetextread, writeChannel — The test refuses a channel the bank does not offer.
auth_methodtextread, writeAuthentication
base_urltextread, writeAPI endpoint — HTTPS only.
token_urltextread, writeOAuth token endpoint
client_idtextread, writeClient ID
client_secret_cipherbytearead onlyClient secret cipher
api_key_cipherbytearead onlyApi key cipher
scopes_textread, writeScopes — e.g. balances:read, transactions:read, payments:write
certificate_cipherbytearead onlyCertificate cipher
certificate_expiresdateread, writeCertificate expires — The test warns thirty days out and fails once it has passed.
sftp_hosttextread, writeSFTP host
sftp_portintegerread, writeSFTP port
sftp_usernametextread, writeSFTP username
sftp_key_cipherbytearead onlySftp key cipher
inbound_dirtextread, writeInbound directory — Where the bank leaves statements.
outbound_dirtextread, writeOutbound directory — Where payment files are collected from.
pgp_key_idtextread, writePGP key id
company_idtextread, writeBank-assigned company id
ach_company_idtextread, writeACH company id — The immediate origin on a NACHA file. Without it no ACH file can be built.
ach_company_nametextread, writeACH company name
originator_idtextread, writeOriginator id
division_codetextread, writeDivision code
webhook_urltextread, writeWebhook URL — Where the bank posts real-time notifications. Store a signing secret alongside it.
webhook_secret_cipherbytearead onlyWebhook secret cipher
notification_emailtextread, writeNotification email
poll_interval_minutesintegerread, writeCollect every (minutes)
statement_formattextread, writeStatement format
payment_formattextread, writePayment file format
auto_reconcilebooleanread, writeMatch the feed automatically
auto_postbooleanread, writeAuto post
match_tolerancenumericread, writeAmount tolerance — How far two amounts may differ and still be the same payment.
match_window_daysintegerread, writeDate window (days)
platform_connection_iduuidread, writePlatform connection — Links this to the cross-application integration record.
statustextread, writeStatus
last_tested_attimestamp with time zoneread onlyLast tested at
last_test_okbooleanread onlyLast test ok
last_test_messagetextread onlyLast test message
last_sync_attimestamp with time zoneread onlyLast sync at
owner_iduuidread, writeOwner
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
link_session_iduuidread onlyLink session id
aggregator_iduuidread onlyAggregator id
external_item_idtextread onlyExternal item id
ofx_urltextread onlyOfx url
ofx_orgtextread onlyOfx org
ofx_fidtextread onlyOfx fid
ofx_versionintegerread onlyOfx version
ofx_app_idtextread onlyOfx app id
ofx_app_vertextread onlyOfx app ver
ofx_user_idtextread onlyOfx user id
ofx_password_cipherbytearead onlyOfx password cipher
ofx_client_uidtextread onlyOfx client uid
credential_stored_attimestamp with time zoneread onlyCredential stored at
credential_last_ok_attimestamp with time zoneread onlyCredential last ok at
credential_expires_attimestamp with time zoneread onlyCredential expires at
credential_statustextread onlyCredential status
credential_messagetextread onlyCredential message
pulled_throughdateread onlyPulled through
oauth_client_iduuidread onlyOauth client id
oauth_access_cipherbytearead onlyOauth access cipher
oauth_refresh_cipherbytearead onlyOauth refresh cipher
oauth_expires_attimestamp with time zoneread onlyOauth expires at
consent_expires_attimestamp with time zoneread onlyConsent expires at
data_api_basetextread onlyData api base
data_api_standardtextread onlyData api standard
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 Connections 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.