TRANXACT.AI Help

Accounting · Bank Connectivity

Bank Channels

The institutions that can be integrated, and what each of them actually supports. A bank that does not offer a channel cannot be configured for it.

Type REST6 operationsBase path /api/accounting/bank-providersPublished as /api/v1/bank-providers

Download specification (OpenAPI 3.1) Screen: Bank Channels

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 Channels 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_providers · 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-providersList bank channels

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",
      "swift_bic": "text",
      "routing_number": "ROU-000001",
      "website": "https://example.com",
      "docs_url": "https://example.com",
      "support_phone": "+1 555 0100",
      "integration_types": [],
      "auth_methods": [],
      "statement_formats": [],
      "payment_formats": []
    }
  ],
  "count": 1
}

Sample request

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

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",
  "swift_bic": "text",
  "routing_number": "ROU-000001",
  "website": "https://example.com",
  "docs_url": "https://example.com",
  "support_phone": "+1 555 0100",
  "integration_types": [],
  "auth_methods": [],
  "statement_formats": [],
  "payment_formats": []
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesBank code
nametextYesLegal name
short_nametextNoShort name
countrytextNoCountry
swift_bictextNoSWIFT BIC
routing_numbertextNoRouting number (ABA) — Nine digits, check digit included.
websitetextNoWebsite
docs_urltextNoDeveloper documentation
support_phonetextNoSupport telephone
integration_types_textNoChannels offered — direct_api, host_to_host, aggregator, swift, manual
auth_methods_textNoAuthentication offered — oauth2, api_key, mtls, sftp_key, basic
statement_formats_textNoStatement formats — bai2, mt940, camt053, ofx, csv
payment_formats_textNoPayment formats — nacha, iso20022_pain001, fedwire, rtp
supports_realtime_balancebooleanNoReal-time balance
supports_transaction_feedbooleanNoTransaction feed
supports_webhooksbooleanNoWebhook notifications
supports_achbooleanNoACH origination
supports_wirebooleanNoWire
supports_rtpbooleanNoReal-time payments
supports_positive_paybooleanNoPositive pay
default_api_urltextNoDefault API endpoint
default_sftp_hosttextNoDefault SFTP host
ach_cutofftime without time zoneNoACH cut-off — Local time at the bank, e.g. 20:45
wire_cutofftime without time zoneNoWire cut-off
bank_timezonetextNoBank time zone
settlement_daysintegerNoSettlement (days)
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "short_name": "Example",
  "country": "US",
  "swift_bic": "text",
  "routing_number": "ROU-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "short_name": "Example",
  "country": "US",
  "swift_bic": "text",
  "routing_number": "ROU-000001",
  "website": "https://example.com",
  "docs_url": "https://example.com",
  "support_phone": "+1 555 0100",
  "integration_types": [],
  "auth_methods": [],
  "statement_formats": [],
  "payment_formats": []
}

Sample request

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

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
swift_bictextNoSWIFT BIC
routing_numbertextNoRouting number (ABA) — Nine digits, check digit included.
websitetextNoWebsite
docs_urltextNoDeveloper documentation
support_phonetextNoSupport telephone
integration_types_textNoChannels offered — direct_api, host_to_host, aggregator, swift, manual
auth_methods_textNoAuthentication offered — oauth2, api_key, mtls, sftp_key, basic
statement_formats_textNoStatement formats — bai2, mt940, camt053, ofx, csv
payment_formats_textNoPayment formats — nacha, iso20022_pain001, fedwire, rtp
supports_realtime_balancebooleanNoReal-time balance
supports_transaction_feedbooleanNoTransaction feed
supports_webhooksbooleanNoWebhook notifications
supports_achbooleanNoACH origination
supports_wirebooleanNoWire
supports_rtpbooleanNoReal-time payments
supports_positive_paybooleanNoPositive pay
default_api_urltextNoDefault API endpoint
default_sftp_hosttextNoDefault SFTP host
ach_cutofftime without time zoneNoACH cut-off — Local time at the bank, e.g. 20:45
wire_cutofftime without time zoneNoWire cut-off
bank_timezonetextNoBank time zone
settlement_daysintegerNoSettlement (days)
is_activebooleanNoActive

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",
  "swift_bic": "text",
  "routing_number": "ROU-000001",
  "website": "https://example.com",
  "docs_url": "https://example.com",
  "support_phone": "+1 555 0100",
  "integration_types": [],
  "auth_methods": [],
  "statement_formats": [],
  "payment_formats": []
}

Sample request

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

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-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-providers/{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-providers/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 providers, 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
swift_bictextread, writeSWIFT BIC
routing_numbertextread, writeRouting number (ABA) — Nine digits, check digit included.
websitetextread, writeWebsite
docs_urltextread, writeDeveloper documentation
support_phonetextread, writeSupport telephone
integration_types_textread, writeChannels offered — direct_api, host_to_host, aggregator, swift, manual
auth_methods_textread, writeAuthentication offered — oauth2, api_key, mtls, sftp_key, basic
statement_formats_textread, writeStatement formats — bai2, mt940, camt053, ofx, csv
payment_formats_textread, writePayment formats — nacha, iso20022_pain001, fedwire, rtp
supports_realtime_balancebooleanread, writeReal-time balance
supports_transaction_feedbooleanread, writeTransaction feed
supports_webhooksbooleanread, writeWebhook notifications
supports_achbooleanread, writeACH origination
supports_wirebooleanread, writeWire
supports_rtpbooleanread, writeReal-time payments
supports_positive_paybooleanread, writePositive pay
default_api_urltextread, writeDefault API endpoint
default_sftp_hosttextread, writeDefault SFTP host
ach_cutofftime without time zoneread, writeACH cut-off — Local time at the bank, e.g. 20:45
wire_cutofftime without time zoneread, writeWire cut-off
bank_timezonetextread, writeBank time zone
settlement_daysintegerread, writeSettlement (days)
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
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 Channels 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.