A faculty is a capability flag that controls what a ledger app can do or show in the UI(e.g., allow payments, show IBAN, issue cards).
There are two types of faculties:
- Fixed faculties: built-in behaviours that are not configurable. They are determined by the ledger type and are always on/off by design.
- Custom (configurable) faculties: flags you can enable/disable via configuration. These apply the same way across ledger types (Regular, POS, …).
📋 Fixed Faculties by Ledger App Type
The table below shows the fixed faculties and how they apply to each ledger type (they are always on/off by design):
| Faculty | Regular Accounts | PoS |
|---|---|---|
CAN_MAKE_PAYMENTS | ✅ | ❌ |
CAN_ISSUE_CARD | ✅ | ❌ |
CAN_SHOW_TOTAL_BALANCE | ✅ | ❌ |
CAN_SHOW_IBAN | ✅ | ❌ |
CAN_SEE_ACCOUNT_FILTER_MODAL | ✅ | ❌ |
CAN_SHOW_ACCOUNT_DETAILS | ✅ | ❌ |
📋 Custom Faculties Available by Ledger App Type
Customisable features allow you to tailor the app behaviour to your specific business requirements.
To retrieve the list of custom faculties that are available for your app you can use the Get Custom Faculties endpoint.
To set the required custom faculties as true or false you can use the Update Custom Faculties endpoint.
To work with the endpoints ensure you have the following information:
- customerId: A unique identifier for the customer this app belongs to.
- marketplaceKey: A unique identifier for the ledger app.
To avoid overwriting existing custom faculties for other features for your app, ensure you have the current list of custom faculties for the app before making any modifications.
The table below lists the custom faculties and their default behaviour across ledger types. Unlike fixed faculties, you can enable or disable these to match the behaviour you want.
| Faculty | Regular Accounts | PoS |
|---|---|---|
CAN_SHOW_TRANSACTION_DETAILS | ✅ | ✅ |
SHOW_AVAILABLE_BALANCE | ✅ | ✅ |
CAN_SHOW_DYNAMIC_BALANCE (coming soon) | ❌ | ❌ |
ALLOW_ACCOUNT_CREATION* | ✅ | ✅ |
ALLOW_ACCOUNT_CANCELLATION** | ✅ | ✅ |
CAN_DOWNLOAD_ACCOUNT_STATEMENT | ✅ | ✅ |
*To have multi accounts you need to have it enabled as a feature in the admin portal of your solution.
** Before enabling, confirm your banking provider supports account cancellation in your integration.
