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.
Where to find it
- Module: Accounting
- Group: Working Capital
- Section: Bank Connectivity
- Screen: Bank Data Recipients
Address in the console: /accounting/bank-data-recipients
List · 9 columns · 11 fields on its form · 5 of them required · 1 action
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Registration | Text | label |
| Network | Status | network |
| Bank | Text | bank |
| Environment | Status | environment |
| Client id | Code | client_id |
| Secret held | Yes or no | has_secret |
| Redirect URI | Code | redirect_uri |
| In use | Number | connections |
| Active | Yes or no | is_active |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Registration name required | Text | What to call it here, e.g. "Chase production" or "Akoya pilot". | |
| Issued by required | Choice | bank, akoya, plaid, finicity, mx, tink, truelayer, sandbox | The bank itself, or the network that fronts it. It decides which banks this one registration reaches. |
| One bank only | Choice | Looked up from existing records | Leave empty for a network registration, which reaches every bank on it. |
| Environment required | Choice | sandbox, development, production | |
| Client id required | Text | ||
| Redirect URI required | Text | 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. | |
| Authorization endpoint | Text | From the developer portal. A guess sends the customer to a page that does not exist on their own bank. | |
| Token endpoint | Text | ||
| Data API base | Text | Where accounts and transactions are read from once there is a token. | |
| Scopes | Text | Leave empty to use what the bank catalogue says this bank wants. | |
| Active | Yes or no |
What you can do here
Set the client secret
Asks for confirmation: The secret is sealed and cannot be read back afterwards.
Asks for: Client secret*
* required
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.