Supported use cases
Party management
Search and retrieve parties, create personal customers, and list accounts by party
Deposit accounts
Create current accounts and savings accounts, retrieve deposit details by ID, and fetch balances for one or more deposit IDs
Account origination
Create parties and deposit accounts when write journeys are enabled
Loans
Create loans, retrieve loan details and balances, and list transactions for one or more loans
Connector artifacts
The following table lists the connector artifacts in this family.Supported operations
The Finastra Essence connector family supports the following operations from the Banking OS Unified API specification. Vendor calls usefinastra.base.url plus the path properties in Reference.
Party
The following table lists the party operations.
Search party takes the search criteria in the request body and the
partyType in a request header. The connector sends the party name, party ID, birth date, phone number, email, and onboarding date range to the Finastra party search.
For account-list calls, the connector sends the Banking OS
partyId to Finastra as the customerId, so treat the two identifiers as the same value when you troubleshoot. If Finastra doesn’t recognize the party, the connector returns GC055. If the party exists but has no accounts, the connector returns HTTP 200 with empty deposits and loans lists. The connector also maps the Banking OS partyType (PERSON or ORGANISATION) to the matching Essence party type code.Deposit account
The following table lists the deposit account operations.
The connector handles each deposit operation as follows:
- Create a deposit account creates current accounts and savings accounts. The
finastra.casa.deposit-typesproperty indeposit-v0.values.yamllists the Banking OS deposit types that the connector routes to Finastra. The default values areCURRENT_ACCOUNTandSAVINGS_ACCOUNT. The connector returns HTTP400for any other deposit type, and rejects aholderTypeofORGANISATIONin the create deposit request. This operation doesn’t create term deposits. - Get deposit account details looks up the deposit as a current or savings account first, then enriches the result with account details. When that probe returns vendor code
40311807, the connector retrieves the deposit as a fixed deposit. Other vendor errors on that probe follow the connector error path and do not fall through to a fixed deposit. The connector includes a balance for current and savings deposits when the balance lookup succeeds. Fixed-deposit lookups omit that enrichment. The response returns the account IBAN and BBAN inaccountIdentification. - Get deposit account balances retrieves a balance for each ID in the
depositIdsrequest header.
Deposit transactions come from the
gc-finastra-deposit-transaction-connector artifact, not gc-finastra-deposit-connector. That artifact serves GET /deposits/{depositId}/transactions.Loan
The following table lists the loan operations.
The connectors handle the multi-loan operations as follows:
- Get loan balances retrieves the loan details from Finastra for each ID in
loanIdsand returns the principal, principal due, interest, and scheduled charge for each loan. Finastra has no dedicated loan balance API. If the lookup fails for one loan, the whole request fails. - Get transactions for multiple loans accepts a list of
loanIdvalues, each with an optionalfromDateandtoDate. The connector retrieves the transactions for each loan and returns them in one list, with theloanIdon each transaction. If the lookup fails for one loan, the whole request fails.
Loan operations come from two artifacts.
gc-finastra-loan-connector serves create loan, get loan details, and get loan balances. gc-finastra-loan-transaction-connector serves the loan transaction operations.API features
FFDC integration
OAuth2 client credentials and subscription key access to FusionFabric.cloud retail banking APIs
Data mapping
JOLT transformations between the Banking OS Unified API and Finastra payloads
Parallel processing
Concurrent vendor calls for party account aggregation
Correlation
X-Request-ID on outbound calls for traceability. The party connector sets it from the inbound traceId.Related topics
- Get started with connectors for environment setup and your first connector.
- Reference for configuration properties and vendor error mapping.
- Get started for the environment details you send to Backbase.
- Error codes for the full list of Banking OS error codes and their descriptions.