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.
/api/accounting/bank-providersPublished as /api/v1/bank-providersOverview
| 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 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. |
| Table | acct.bank_providers · 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-providersList bank channels
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",
"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
| 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",
"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.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Bank code |
name | text | Yes | Legal name |
short_name | text | No | Short name |
country | text | No | Country |
swift_bic | text | No | SWIFT BIC |
routing_number | text | No | Routing number (ABA) — Nine digits, check digit included. |
website | text | No | Website |
docs_url | text | No | Developer documentation |
support_phone | text | No | Support telephone |
integration_types | _text | No | Channels offered — direct_api, host_to_host, aggregator, swift, manual |
auth_methods | _text | No | Authentication offered — oauth2, api_key, mtls, sftp_key, basic |
statement_formats | _text | No | Statement formats — bai2, mt940, camt053, ofx, csv |
payment_formats | _text | No | Payment formats — nacha, iso20022_pain001, fedwire, rtp |
supports_realtime_balance | boolean | No | Real-time balance |
supports_transaction_feed | boolean | No | Transaction feed |
supports_webhooks | boolean | No | Webhook notifications |
supports_ach | boolean | No | ACH origination |
supports_wire | boolean | No | Wire |
supports_rtp | boolean | No | Real-time payments |
supports_positive_pay | boolean | No | Positive pay |
default_api_url | text | No | Default API endpoint |
default_sftp_host | text | No | Default SFTP host |
ach_cutoff | time without time zone | No | ACH cut-off — Local time at the bank, e.g. 20:45 |
wire_cutoff | time without time zone | No | Wire cut-off |
bank_timezone | text | No | Bank time zone |
settlement_days | integer | No | Settlement (days) |
is_active | boolean | No | Active |
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
| 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 |
swift_bic | text | No | SWIFT BIC |
routing_number | text | No | Routing number (ABA) — Nine digits, check digit included. |
website | text | No | Website |
docs_url | text | No | Developer documentation |
support_phone | text | No | Support telephone |
integration_types | _text | No | Channels offered — direct_api, host_to_host, aggregator, swift, manual |
auth_methods | _text | No | Authentication offered — oauth2, api_key, mtls, sftp_key, basic |
statement_formats | _text | No | Statement formats — bai2, mt940, camt053, ofx, csv |
payment_formats | _text | No | Payment formats — nacha, iso20022_pain001, fedwire, rtp |
supports_realtime_balance | boolean | No | Real-time balance |
supports_transaction_feed | boolean | No | Transaction feed |
supports_webhooks | boolean | No | Webhook notifications |
supports_ach | boolean | No | ACH origination |
supports_wire | boolean | No | Wire |
supports_rtp | boolean | No | Real-time payments |
supports_positive_pay | boolean | No | Positive pay |
default_api_url | text | No | Default API endpoint |
default_sftp_host | text | No | Default SFTP host |
ach_cutoff | time without time zone | No | ACH cut-off — Local time at the bank, e.g. 20:45 |
wire_cutoff | time without time zone | No | Wire cut-off |
bank_timezone | text | No | Bank time zone |
settlement_days | integer | No | Settlement (days) |
is_active | boolean | No | Active |
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
| 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-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/bank-providers/{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-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.
| 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 |
swift_bic | text | read, write | SWIFT BIC |
routing_number | text | read, write | Routing number (ABA) — Nine digits, check digit included. |
website | text | read, write | Website |
docs_url | text | read, write | Developer documentation |
support_phone | text | read, write | Support telephone |
integration_types | _text | read, write | Channels offered — direct_api, host_to_host, aggregator, swift, manual |
auth_methods | _text | read, write | Authentication offered — oauth2, api_key, mtls, sftp_key, basic |
statement_formats | _text | read, write | Statement formats — bai2, mt940, camt053, ofx, csv |
payment_formats | _text | read, write | Payment formats — nacha, iso20022_pain001, fedwire, rtp |
supports_realtime_balance | boolean | read, write | Real-time balance |
supports_transaction_feed | boolean | read, write | Transaction feed |
supports_webhooks | boolean | read, write | Webhook notifications |
supports_ach | boolean | read, write | ACH origination |
supports_wire | boolean | read, write | Wire |
supports_rtp | boolean | read, write | Real-time payments |
supports_positive_pay | boolean | read, write | Positive pay |
default_api_url | text | read, write | Default API endpoint |
default_sftp_host | text | read, write | Default SFTP host |
ach_cutoff | time without time zone | read, write | ACH cut-off — Local time at the bank, e.g. 20:45 |
wire_cutoff | time without time zone | read, write | Wire cut-off |
bank_timezone | text | read, write | Bank time zone |
settlement_days | integer | read, write | Settlement (days) |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
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 Channels 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.