FINS Thought Machine Accounts System API - Implementation Template

This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.

CommonTools

This module provides utility functions and mappings for Financial Accounts and Transaction transformations

Source: ./src/main/resources/dwl/CommonTools.dwl

Variables

var tmProductIdMap

This Product Id map is used by the conversion functions below.

var CIMProductIdMap

This map is used by the conversion function below.

var tmAccountStatusMap

This Account Status map is used by the conversion functions below.

var CIMAccountStatusMap

This map is used by the conversion function below.

Functions

fun getFormattedDateTime (toFormat)

Formats the date-time to the type accepted by CIM

fun getGlobalId (externalIdsArr)

This function filters ExternalIds with ExternalId Type as MDM and returns the first one

return Global ExternalID

fun tmRecordTypeToCIM (accountType)

Maps TM Product Id to CIM Account Type

return CIM Account Type

fun CIMRecordTypeToTM (accountType)

Map CIM Account Type to TM Product Id

return TM Product Id

fun tmAccountStatusToCIM (accountStatus)

Maps TM Account Status to CIM Account Status

return CIM Account Status

fun CIMAccountStatusToTM (accountStatus)

Map CIM Account Status to TM Account Status

return TM Product Id

fun formatAsDate (dateOrDateTime, defaultDate)

Formats given input date or date-time to a datetime in "yyyy-MM-dd'T'HH:mm:ss.SS'Z'" format

param dateOrDateTime input in either date or date-time format
param defaultDateTime default timestamp to use in case input is null.
return datetime in "yyyy-MM-dd'T'HH:mm:ss.SS'Z'" format

fun getTransactionInstructionDetails (payload)

Maps CIM Transaction fields to Instruction Details in Thought Machine. Instruction Details is a Key Value pair that can be sent to Thought Machine while posting a transaction. Few of the fields from CIM payload are mapped as Key Value pair so that can be tied to the transaction posted for future retrieval.

param Input Transaction request in CIM format
return Instruction Details Object of Thought Machine

fun getInternalAccountIdOfPosting (instructionType)

Identifies Internal Bank Account from Thought Machine Posting Instruction .

param instructionType Posting Instruction as part of Posting Batch of Thought Machine
return internalAccountId Internal Bank Account associated with the Credit AccountId of transaction Object.

fun getCreditAccountId (instructionType, internalAccountId, accountId)

Identifies CreditAccountId from Thought Machine Posting Instruction .

param instructionType Posting Instruction as part of Posting Batch of Thought Machine
param accountId - Account Id involved in the posting
param internalAccountId Internal Account Id of the Bank involved in the posting
return CreditAccountId Credit AccountId of transaction Object.

fun getDebitAccountId (instructionType, internalAccountId, accountId)

Identifies DebitAccountId from Thought Machine Posting Instruction .

param instructionType Posting Instruction as part of Posting Batch of Thought Machine
param accountId - Account Id involved in the posting
param internalAccountId Internal Account Id of the Bank involved in the posting
return DebitAccountId Debit AccountId of transaction Object.

fun getTransactionType (internalAccountId, creditAccountId, debitAccountId)

Identifies Transaction Type associated with Thought Machine Posting Instruction .

param internalAccountId Internal Account Id of the Bank involved in the posting
param creditAccountId Credit AccountId involved in the posting
param debitAccountId - Debit AccountId involved in the posting
return TransactionType CIM Transaction type determined from the Posting Instruction.

fun getDetailsByPostingInstructionType (instructionType, accountId, internalAccountId)

Maps Thought Machine Posting Instruction to CIM Fields. Posting Instruction are used to determine the Amount, Transaction Type and Account IDs associated with the transaction based on posting type.

param instructionType Posting Instruction as part of Posting Batch of Thought Machine
param accountId - Account Id involved in the posting
param internalAccountId Internal Account Id of the Bank involved in the posting
return transaction CIM fields of transaction Object.

fun getAuditInfo (createdDate, createdBy, updatedDate, updatedBy)

Maps Thought Machine Posting Instruction to CIM auditInfo Fields. Posting Instruction are used to determine the Amount, Transaction Type and Account IDs associated with the transaction.

param createdBy Identifies the system or user which created the entity
param createdDate Timestamp of when the entity was created - default as current timestamp
param updatedBy Identifies the system or user which last updated the entity
param updatedDate Timestamp of when the entity was last updated
return auditInfo CIM AuditInfo Object related to Transaction.

fun getExternalIdsForMDM (externalId)

Maps the result of Thought Machine Posting Batch Instruction Details to CIM External IDs object if it contains the MDM Id (globalTransactionId) of the transaction.

param externalId - Global Transaction Id of the transaction
return externalIds - External Ids object that include Global Transaction Id for MDM

fun mapToCIMFinancialTransaction (postingBatch, accountId, userId)

Maps Thought Machine Posting Batch Response to CIM Financial Transaction JSON

param postingBatch - Posting Instruction Batch object response
param accountId - Account Id involved in the posting
param userId - System involved in the transaction
param transaction - CIM Object of the transaction

(back to top)

create-account-tm-request

Create Account in Thought Machine request mapping

Source: ./src/main/resources/dwl/create-account-tm-request.dwl

Mapping Tables

The accounts endpoint of the Core API is used to Create an Account in Thought Machine Maps CIM Account to TM Account

(back to top)

get-account-audit-info-response

Account Action Log response mapping

Source: ./src/main/resources/dwl/get-account-audit-info-response.dwl

Mapping Tables

The action-logs endpoint of the Audit API is used to retrieve the Audit information of an Account in Thought Machine

(back to top)

get-account-by-id-response

Retrieve Account from Thought Machine response mapping

Source: ./src/main/resources/dwl/get-account-by-id-response.dwl

Mapping Tables

The accounts endpoint of the Core API is used to retrieve an Account from Thought Machine Maps TM Account to CIM Account

(back to top)

lookup-accounts-response

Retrieve Account from Thought Machine response mapping

Source: ./src/main/resources/dwl/lookup-accounts-response.dwl

Mapping Tables

The accounts endpoint of the Core API is used to retrieve an Account from Thought Machine Maps TM Account to CIM Account

(back to top)

update-account-details-request

Source: ./src/main/resources/dwl/update-account-details-request.dwl

(back to top)

create-credit-transaction-request

Create Credit Transaction using Posting Instruction Batch Async operation in Thought Machine request mapping

Source: ./src/main/resources/dwl/create-credit-transaction-request.dwl

Mapping Tables

The transaction end point is used to Create Posting Instruction Batch Async in Thought Machine with a posting instruction of type inbound_hard_settlement. Maps TM Transaction from CIM

(back to top)

create-transfer-transaction-request

Create Transfer Transaction using Posting Instruction Batch Async operation in Thought Machine request mapping

Source: ./src/main/resources/dwl/create-transfer-transaction-request.dwl

Mapping Tables

The transaction end point is used to Create Posting Instruction Batch Async in Thought Machine with a posting instruction of type transfer.

(back to top)

create-debit-transaction-request

Create Debit Transaction using Posting Instruction Batch Async operation in Thought Machine request mapping

Source: ./src/main/resources/dwl/create-debit-transaction-request.dwl

Mapping Tables

The transaction end point is used to Create Posting Instruction Batch Async in Thought Machine with a posting instruction of type outbound_hard_settlement.

(back to top)

get-transaction-list-response

Get Transaction from Thought Machine using the List Posting Instruction Batch operation.
Maps the response to CIM using the mapToCIMFinancialTransaction function.

Source: ./src/main/resources/dwl/get-transaction-list-response.dwl

Mapping Tables

Maps Thought Machine Posting Batch Response to CIM Financial Transaction JSON

(back to top)

ping-check-dependency-sys-api-response

Source: ./src/main/resources/dwl/ping-check-dependency-sys-api-response.dwl

(back to top)