TRANXACT.AI Help

Accounting · Bank Connectivity

Bank Data Recipients

What a bank, or an aggregator network, issued this company so it can be signed in to: a client id, a client secret and the redirect URI it declared. The secret is sealed on the way in and never comes back out. Without a row here a bank can still be reached by download credential or through the aggregator.

Type REST7 operationsBase path /api/accounting/bank-data-recipientsPublished as /api/v1/bank-data-recipients

Download specification (OpenAPI 3.1) Screen: Bank Data Recipients

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 Data Recipients 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_oauth_clients · 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

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

GET/api/accounting/bank-data-recipientsList bank data recipients

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "network": "bank",
      "institution_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "label": "text",
      "environment": "sandbox",
      "client_id": "text",
      "client_secret_cipher": "text",
      "redirect_uri": "text",
      "authorize_url": "https://example.com",
      "token_url": "https://example.com",
      "data_api_base": "text",
      "scopes": [],
      "is_active": true
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "network": "bank",
  "institution_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "label": "text",
  "environment": "sandbox",
  "client_id": "text",
  "client_secret_cipher": "text",
  "redirect_uri": "text",
  "authorize_url": "https://example.com",
  "token_url": "https://example.com",
  "data_api_base": "text",
  "scopes": [],
  "is_active": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
networktextYesIssued by — The bank itself, or the network that fronts it. It decides which banks this one registration reaches.
Allowed: bank akoya plaid finicity mx tink truelayer sandbox
institution_iduuidNoOne bank only — Leave empty for a network registration, which reaches every bank on it.
labeltextYesRegistration name — What to call it here, e.g. "Chase production" or "Akoya pilot".
environmenttextNoEnvironment
Allowed: sandbox development production
client_idtextNoClient id
redirect_uritextNoRedirect URI — It must match what was registered character for character — a trailing slash is a different URI to a bank, and it is the commonest reason a first attempt fails.
authorize_urltextNoAuthorization endpoint — From the developer portal. A guess sends the customer to a page that does not exist on their own bank.
token_urltextNoToken endpoint
data_api_basetextNoData API base — Where accounts and transactions are read from once there is a token.
scopes_textNoScopes — Leave empty to use what the bank catalogue says this bank wants.
is_activebooleanNoActive

Sample body

{
  "network": "bank",
  "label": "text",
  "institution_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "environment": "sandbox",
  "client_id": "text",
  "redirect_uri": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "network": "bank",
  "institution_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "label": "text",
  "environment": "sandbox",
  "client_id": "text",
  "client_secret_cipher": "text",
  "redirect_uri": "text",
  "authorize_url": "https://example.com",
  "token_url": "https://example.com",
  "data_api_base": "text",
  "scopes": [],
  "is_active": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-data-recipients" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"network":"bank","label":"text","institution_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","environment":"sandbox","client_id":"text","redirect_uri":"text"}'
PUT/api/accounting/bank-data-recipients/{id}Change a bank data recipients

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
networktextYesIssued by — The bank itself, or the network that fronts it. It decides which banks this one registration reaches.
Allowed: bank akoya plaid finicity mx tink truelayer sandbox
institution_iduuidNoOne bank only — Leave empty for a network registration, which reaches every bank on it.
labeltextYesRegistration name — What to call it here, e.g. "Chase production" or "Akoya pilot".
environmenttextNoEnvironment
Allowed: sandbox development production
client_idtextNoClient id
redirect_uritextNoRedirect URI — It must match what was registered character for character — a trailing slash is a different URI to a bank, and it is the commonest reason a first attempt fails.
authorize_urltextNoAuthorization endpoint — From the developer portal. A guess sends the customer to a page that does not exist on their own bank.
token_urltextNoToken endpoint
data_api_basetextNoData API base — Where accounts and transactions are read from once there is a token.
scopes_textNoScopes — Leave empty to use what the bank catalogue says this bank wants.
is_activebooleanNoActive

Sample body

{
  "network": "bank",
  "label": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "network": "bank",
  "institution_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "label": "text",
  "environment": "sandbox",
  "client_id": "text",
  "client_secret_cipher": "text",
  "redirect_uri": "text",
  "authorize_url": "https://example.com",
  "token_url": "https://example.com",
  "data_api_base": "text",
  "scopes": [],
  "is_active": true
}

Sample request

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

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

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

clientSecret

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-data-recipients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"clientSecret":"value"}'

Data model

Every field of a bank data recipients, 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
org_unit_iduuidread onlyOrg unit id
networktextread, writeIssued by — The bank itself, or the network that fronts it. It decides which banks this one registration reaches.
Allowed: bank akoya plaid finicity mx tink truelayer sandbox
institution_iduuidread, writeOne bank only — Leave empty for a network registration, which reaches every bank on it.
labeltextread, writeRegistration name — What to call it here, e.g. "Chase production" or "Akoya pilot".
environmenttextread, writeEnvironment
Allowed: sandbox development production
client_idtextread, writeClient id
client_secret_cipherbytearead onlyClient secret cipher
redirect_uritextread, writeRedirect URI — It must match what was registered character for character — a trailing slash is a different URI to a bank, and it is the commonest reason a first attempt fails.
authorize_urltextread, writeAuthorization endpoint — From the developer portal. A guess sends the customer to a page that does not exist on their own bank.
token_urltextread, writeToken endpoint
data_api_basetextread, writeData API base — Where accounts and transactions are read from once there is a token.
scopes_textread, writeScopes — Leave empty to use what the bank catalogue says this bank wants.
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
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_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 Data Recipients 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.