Finxact

https://finxact.io/
Admin
Finxact is a financial technology platform that allows users to streamline complexity into...
Tokens:1,378,888
Snippets:15,806
Trust Score:6.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get an account and positions using a customer's information

Source: https://finxact.io/docs/tutorials

This tutorial guides you through a three-step process to find a customer using their available information (name, TIN, email, or phone number), retrieve their accounts, and access the details of a specific account and its positions.

```APIDOC
## GET /core/v1/customer

### Description
Retrieves customer information based on provided query parameters.

### Method
GET

### Endpoint
/core/v1/customer

### Parameters
#### Query Parameters
- **customerGroup** (string) - Required - The ID of the customer group.
- **customerId** (string) - Required - The ID of the customer.

## POST /core/v1/customer/find

### Description
Finds a customer based on available information.

### Method
POST

### Endpoint
/core/v1/customer/find

## POST /core/v1/customer/organization/find

### Description
Finds an organization customer based on available information.

### Method
POST

### Endpoint
/core/v1/customer/organization/find

## GET /core/v2/acct_bk/{acctId}

### Description
Retrieves account and position details for a given account ID.

### Method
GET

### Endpoint
/core/v2/acct_bk/{acctId}

### Parameters
#### Path Parameters
- **acctId** (string) - Required - The ID of the account.
```

--------------------------------

### Example .txt Batch Transactions

Source: https://finxact.io/docs/document-detail/document/batch-transaction-processing

This example demonstrates the structure for a .txt file containing multiple transactions with different transaction codes.

```json
[
{
"trnCode": "146",
"mode": 2,
"network": "CORE",
"entries": [
{
"acctGroup": 1,
"posnAcctNbr": "000000000013",
"trnAmt": 3000.00
},
{
"trnAmt": 3000.00
}
]
},
{
"trnCode": "145",
"mode": 2,
"network": "CORE",
"entries": [
{
"acctGroup": 1,
"posnAcctNbr": "000000000027",
"trnAmt": 33.00
},
{
"trnAmt": 33.00
}
]
}
]
```

--------------------------------

### Example Script Initialization Information

Source: https://finxact.io/docs/document-detail/document/node.js-websocket-connection-script

Displays key connection parameters upon script startup, providing transparency into the host, token, topic, and the constructed subscription URI.

```text
Host: example-host
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Topic: model.v1.party_person.create
Subscription URI: wss://example-host/websocket?authtoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&topicBindings=model.v1.party_person.create
```

--------------------------------

### Filter Component Names by Minimum Value

Source: https://finxact.io/docs/document-detail/document/queries

Specify the start of a range to get all component names equal to or greater than the starting value. This example includes all components starting with M or greater.

```http
GET {{.path_root}}/model/v1/componentInt/M~/1
```

--------------------------------

### Create Account/Position

Source: https://finxact.io/docs/tutorials/detail-page/override-configuration-values-with-the-transaction-code-trncode-injection-point

Sets up a new account or position, specifying product details and accounting segments. Ensure 'prodName' and 'acctGroup' are correctly set.

```json
{
"prodName": "P2001",
"acct_bk": {
"name": "Personal Savings Account",
"openDtm": "2019-09-20T16:21:00.584Z",
"acctGroup": 1,
"acctTitle": "Katie Smith",
"acctType": "Single",
"isBrokered": false,
"tmZoneCode": "usnyc",
"signedDocs": [
{
"version": "1.0.0",
"signedDtm": "2019-08-02T23:00:00Z",
"signedBy": {
"name": "Katie Smith"
}
}
]
},
"posn_depDtl": [
{
"posn_dep": {
"ccyCode": "USD",
"acctgSeg": {
"deptId": "350",
"vertical": "01"
}
}
}
]
}
```

--------------------------------

### Get Order Details

Source: https://finxact.io/docs/tutorials/detail-page/set-up-orders

Example of a GET request to retrieve details for a specific order using its ID. This is useful for verifying order information after creation.

```json
GET core/v1/order/{{.lnDisbOrderId}}
```

--------------------------------

### Get Check Register Response

Source: https://finxact.io/docs/document-detail/document/direct-checksend-a-check

Example response when retrieving check details from the check register using a GET request. Includes status, dates, and associated IDs.

```json
GET model/v1/chkRegister

{
"chkAmt": 200.00,
"chkDate": "2022-10-25",
"chkNbr": 1001,
"chkStatus": [
{
"status": 1,
"statusDtm": "2022-10-25T06:25:10.627Z"
}
],
"drawnOn": {
"drawnPosnId": "4K7qx_kbTgc------81Fk---”
},
"expireDtm": "2023-10-25T03:59:59Z",
"isStopped": false,
"orderId": "4m4cp2Gp7-v1Jk---1uF-8w-",
"posnId": "4lRp1X44EU9MIk---YLF-Co-",
"_uLog": "4m4dVK3avjwpcV---1TF-2V-",
"_cDtm": "2022-10-25T20:22:21.236997887Z",
"_uDtm": "2022-10-25T20:22:21.236997887Z",
"_vn": 0,
"_flags": 0,
"_schVn": 0,
"_cLogRef": "4m4dVK2821l6A----1TF----",
"_cLog": "4m4dVK3avjwpcV---1TF-2V-"
}
```

--------------------------------

### Initial Savings Position Debit Example

Source: https://finxact.io/docs/tutorials/detail-page/configure-a-high-yield-savings-interest-component-using-the-actualactual-calculation-method

This example shows how to post an initial debit to a savings position. It's a simplified method for demonstration purposes.

```JSON
{
"mode": 2,
"trnCode": "139",
"entries": [
{
"acctGroup": "{{.CBCCAccountGroup}}",
"acctNbr": "{{.CBCCAccountNumber}}",
"trnAmt": 8000.00,
"isDr": false
},
{
"trnAmt": 8000.00,
"isDr": true
}
]
}
```

--------------------------------

### Example Prior Check Range Response

Source: https://finxact.io/docs/tutorials/detail-page/order-a-checkbook

This is an example of the expected JSON response when querying the check assignment endpoint. It shows the start and end numbers of a previous check order.

```json
{
"_Id": "57aFE7dHg47zvjyYgZiDI2Ss",
"endNbr": 150,
"posnId": "4yZiJP2REUCHPcneFiYuqRMq",
"startNbr": 100,
"_uLog": "57aFE7dHg47zvjyYgZj0n6LD",
"_cDtm": "2026-04-22T03:41:58.412742738Z",
"_uDtm": "2026-04-22T03:41:58.412742738Z",
"_vn": 0,
"_flags": 0,
"_schVn": 1,
"_cLogRef": "57aFE7RJwa2GAC_UnLBtfBvp"
}
```

--------------------------------

### Filter Component Names by Starting Letter

Source: https://finxact.io/docs/document-detail/document/queries

Filter component names by a range starting with a specific letter. This example returns component names beginning with A, B, or C (letters before D).

```http
GET {{.path_root}}/model/v1/componentInt/A~D/1
```

--------------------------------

### Create Multi-Position Account

Source: https://finxact.io/docs/document-detail?docId=the-finxact-api&docType=document

This example demonstrates creating a multi-position account using the core API. If any position creation fails, the entire request fails, ensuring atomicity.

```bash
POST /core/v1/acct_bk
```

--------------------------------

### Create Account and Position

Source: https://finxact.io/docs/tutorials/detail-page/correct-an-overlooked-rate-change-and-adjust-accruals

Link a new account and position to an existing customer and product. This setup allows for initial interest accrual based on the current rate matrix.

```JSON
{
"customer": {
"customerId": "{{.violetSchmidtCustomerId}}",
"customerGroup": "{{.violetSchmidtCustomerGroup}}"
},
"newAccounts": [
{
"Acct": {
"acct_bk": {
"desc": "Personal Accts",
"openDtm": "{{.openDtm}}",
"acctGroup": 1,
"acctType": "Single",
"acctTitle": "Violet Schmidt Personal Accounts",
"isBrokered": false,
"tmZoneCode": "usnyc",
"stmtFreq": "0MAE"
},
"posn_depDtl": [
{
"prodName": "{{.prodName}}",
"posn_dep": {
"ccyCode": "USD",
"acctgSeg": {
"deptId": "350",
"vertical": "01"
}
}
}
]
},
"acctPartyRel": {
"relType": "1",
"partyRelDesc": "Primary"
}
}
]
}
```

--------------------------------

### Get Transaction Status

Source: https://finxact.io/docs/tutorials/detail-page/monitor-for-regulation-d-violation-events

This is an example of an endpoint to retrieve the status of transactions. It is used in the process of monitoring financial activities.

```HTTP
GET
model/v1/trnStat
```

--------------------------------

### Check for Open Batch using Finxact API

Source: https://finxact.io/docs/document-detail/document/finxact-pro-starter-prompts

Use the GET /model/v1/batch endpoint with a filter to find batches that have started but not ended.

```http
GET /model/v1/batch?filter.q=endDtm IS NULL
```

--------------------------------

### API Request Body for Batch Onboarding

Source: https://finxact.io/docs/document-detail/document/batchonboardingfile-process-an-onboarding-file

The POST /core/v1/batchOnboarding/postBatchOnboardingFile API requires the 'fileName' property. Use 'isSync' for immediate processing or 'runDtm' for scheduled execution. Both properties are mandatory.

```json
{
  "fileName": "batch/in/batchOnboardingExample.json",
  "isSync": true,
  "runDtm": "2026-05-27T10:00:00Z"
}
```

--------------------------------

### API Request to Retrieve Tax-Benefit Plan

Source: https://finxact.io/docs/tutorials/detail-page/set-up-processing-for-tax-benefit-plan-inherited-iras

Example GET request to retrieve details of a specific tax-benefit plan using its ID.

```http
GET /core/v1/usTbp?_Id=52Wjirshp9bh5Pproo9JUlR8
```

--------------------------------

### Get Recent Position Transaction History

Source: https://finxact.io/docs/document-detail/document/account-and-position-history

Retrieve recent monetary transaction history for a specific position, starting from the position's opening date.

```http
GET /core/v2/trnHistRecent/{posnId}
```

--------------------------------

### Report Configuration Response Example

Source: https://finxact.io/docs/tutorials/detail-page/add-a-report-to-the-system-event-calendar-using-api

This JSON response shows the configuration for the 'sda1' report, detailing its parameters, types, and whether they are required. Use this to identify necessary arguments for scheduling.

```json
{
"name": "sda1",
"id": "1",
"description": "New SDA Accounts by Opening Date and Product",
"params": [
{
"name": "fropendate",
"valueType": "timestamp",
"order": 1,
"isRequired": true
},
{
"name": "toopendate",
"valueType": "timestamp",
"order": 2,
"isRequired": true
},
{
"name": "procdate",
"valueType": "timestamp",
"order": 3,
"isRequired": true
}
}

```

--------------------------------

### Customer Creation Request with Addresses

Source: https://finxact.io/docs/document-detail/document/customer-onboarding-overview

This example demonstrates how to include an addresses array in a customer creation request, specifying details for a primary residence and a vacation home.

```json
{
"addresses": [
{
"addrType": 2,
"label": "Home",
"street": "847 Whispering Pines Drive",
"city": "Branson",
"region": "MO",
"postCode": "65616",
"cntry": "US",
"isTaxAddr": true,
"isPreferred": true,
"verifyDtm": "2025-09-25T17:09:00Z",
"yrsAddr": 4,
"geoLoc": {
"lat": 36.6435,
"lon": -93.2185
}
},
{
"addrType": 5,
"label": "Vacation home",
"city": "Fort Walton Beach",
"cntry": "US",
"postCode": "32548",
"region": "FL",
"street": "229 Pelican Bay Drive",
"validFromDtm": "2025-10-01T04:00:00Z",
"validToDtm": "2026-03-01T04:59:59Z"
}
]
}
```

--------------------------------

### List Incoming Batch Files API Call

Source: https://finxact.io/docs/document-detail/document/batch-transaction-processing

Example of an HTTP GET request to list files in the incoming batch directory. This helps verify successful upload.

```http
GET /core/v1/file/list/batch/in HTTP/1.1
Host: localhost:8080
```

--------------------------------

### Example Request Body (Report and Additional Extracts)

Source: https://finxact.io/docs/document-detail/document/generate-the-gl-set-position-loan-balancing-report-on-demand

Use this request body to generate the GL Set Position Loan Balancing report along with specified extract files. Ensure 'isGenerateFile' is set to true and 'fileFmt' lists the desired formats.

```json
{
"glJrnlDate": "2026-03-15",
"runDtm": "2026-03-23T16:30:00Z"
"isGenerateFile": true,
"fileFmt": "POSNSETBALLNSUM+POSNSETBALLNDTL"
}
```

--------------------------------

### Get All Events in Date-Time Range API Query

Source: https://finxact.io/docs/document-detail/document/system-health-check-apis

Retrieve all events that fall within a specified date and time range. The range is inclusive of the start time and exclusive of the end time.

```http
GET {{.path_root}}/model/v1/eventCtxt?filter.q=createDtm >= '2022-01-18T00:00:00Z' and createDtm <='2022-01-18T01:00:00Z'/code>
```

--------------------------------

### Example Transaction Code Configuration

Source: https://finxact.io/docs/document-detail/document/dispute-provisional-debit

Configuration for the dispute-provDr process, specifying the process name, type, and transaction code. This setup is crucial for distinguishing provisional credit reversals from standard disputes.

```json
{
"procName": "dispute-provDr",
"procType": 1,
"trnCode": "310"
  
}
```

--------------------------------

### Create Customer

Source: https://finxact.io/docs/tutorials/detail-page/configure-a-high-yield-savings-interest-component-using-the-actual365-calculation-method

Creates a new customer record. This example includes details for setting customer variables from the response, which are used in subsequent calls.

```JSON
{
"party_person": {
"ageBracket": "6",
"birthDate": "1958-01-01",
"citizenCntry": "US",
"contactPref": "4",
"cntry": "US",
"education": "5",
"employmentStatus": "1",
"ethnicity": "0",
"firstName": "Louise",
"gender": "2",
"govtIds": [
{
"cntry": "US",
"docType": "3",
"verifyDtm": "2020-02-20T21:45:33.444Z"
}
],
"incBracket": "0",
"lastName": "Payne",
"maritalStatus": "1",
"nbrInHhold": 1,
"occupation": "0",
"preferredLanguage": "en-US",
"tin": "111-22-3335",
"tinType": "0",
"emails": [
{
"emailType": 1,
"data": "louisepayne@gmail.com"
}
],
"phones": [
{
"data": "123-123-2345"
}
]
}
}
```

--------------------------------

### Confirm SCRA Start Event

Source: https://finxact.io/docs/tutorials/detail-page/update-customers-us-service-member-status-to-active-duty-status-using-api

This GET request retrieves calendar events for a specific position ID. It's used to confirm the creation of the 'startSCRA' event after updating active duty dates.

```bash
GET/model/v1/posnCalendar?posnId={_Id}
```

--------------------------------

### Process Onboarding File

Source: https://finxact.io/docs/document-detail/document/batchonboardingfile-process-an-onboarding-file

This API endpoint processes an onboarding file, onboarding customer and account records from a JSON batch file. It requires both `fileName` and `runDtm` properties in the request body. `isSync` can be set to true for immediate processing.

```APIDOC
## POST /core/v1/batchOnboarding/postBatchOnboardingFile

### Description
Processes an onboarding file to onboard customer and account records from a JSON batch file. Supports immediate processing or scheduling for a future date-time.

### Method
POST

### Endpoint
/core/v1/batchOnboarding/postBatchOnboardingFile

### Parameters
#### Request Body
- **fileName** (string) - Required - The name and path to the designated repository location of the batch file.
- **isSync** (boolean) - Optional - If true, the batch is processed immediately. Defaults to false.
- **runDtm** (string) - Required - The specific future date-time for processing the batch. This property is required even when `isSync` is true.

### Request Example
```json
{
  "fileName": "batch/in/batchOnboardingExample.json",
  "isSync": true,
  "runDtm": "2026-05-27T10:00:00Z"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the batch processing.
- **message** (string) - A message providing details about the batch processing result.

#### Response Example
```json
{
  "status": "success",
  "message": "Batch onboarding initiated successfully."
}
```
```

--------------------------------

### HTTP Header Information Example

Source: https://finxact.io/docs/document-detail/document/message-request-msgrq

Demonstrates how all HTTP header information is stored within a single string. This is useful for inspecting raw request headers.

```text
"http": "X-Request-Id: 169e0a523aa561190fe866b72a52401d\r\nX-Forwarded-For: 52.4.165.99\r\nX-Forwarded-Port: 443\r\nContent-Length: 604\r\nClient_id: b11194ddf7608b7a91fa4e327ef27d76c918e16e20262b7d4458d05da34ca440\r\nContent-Type: application/json\r\nX-Amzn-Trace-Id: Root=1-61bc23e7-4236374f103527855d146b9b\r\nX-Real-Ip: 52.4.165.99\r\nX-Forwarded-Host: 211616.dev-10.finxact.io\r\nX-Scheme: https\r\nX-Original-Forwarded-For: 34.198.218.200, 10.0.3.212\r\nAccept: application/json\r\nX-Forwarded-Proto: https\r\nAccept-Encoding: gzip"
```

--------------------------------

### Set Custom Page Limit

Source: https://finxact.io/docs/document-detail/document/pagination-ordering-and-limits-filters

Override the default 1,000 record limit per page by adding the `filter.limit` parameter to your GET request. This example retrieves only the first 100 transaction records.

```http
GET {{.path_root}}/model/v1/trn?filter.limit=100
```

--------------------------------

### Validate Commercial Loan Account Setup

Source: https://finxact.io/docs/tutorials/detail-page/set-up-a-commercial-loan

Retrieve the booked loan account details to verify all setup parameters, including product configuration, credit limit, collateral linkage, and borrower details. This confirms the account is ready for servicing.

```http
GET /core/v2/acct_bk/{{commercialLoanAcctId}}
```

--------------------------------

### Filter Service Information Messages by Date

Source: https://finxact.io/docs/document-detail/document/fedwireext-broadcast-messagesreports-andstatements

Use a date filter in the GET /model/v1/svcInfoMsg request to limit the number of service information messages returned. This example retrieves messages created on or after September 13, 2023.

```http
GET/model/v1/svcInfoMsg?filter.q=createDtm>='2023-09-13T00:00:00Z'
```

--------------------------------

### Response for Listing Batch Files

Source: https://finxact.io/docs/document-detail/document/batch-transaction-processing

Example JSON response when listing files in the incoming batch directory, confirming the uploaded file's presence and details.

```json
{
    "data": [
        {
            "uri": "batch/in/batch_post_json_sample.txt",
            "name": "batch_post_json_sample.txt",
            "modDt": "2022-10-23T01:21:06.69958Z",
            "size": 564,
            "isDir": false,
            "meta": {
                "name": "batch_post_json_sample.txt",
                "props": {
                    "createDate": "2022-10-22T21:21:06-04:00",
                    "user": ""
                }
            }
        }
    ]
}
```

--------------------------------

### Account Group Expression Example

Source: https://finxact.io/docs/document-detail/document/multi-bank-transaction-code-related-configurations

This expression dynamically determines the appropriate GL account group based on the presence of the 'finInst' accounting segment. Use this when transitioning to a multi-bank setup with multiple GL account groups.

```json
"acctGroupExpr": "if(posn[0].acctgSeg.finInst!= null){4} else {2}"
```

--------------------------------

### Create Test Loan Position and Link Account

Source: https://finxact.io/docs/tutorials/detail-page/set-up-a-deferred-cost-for-a-loan-product

Use this request body to onboard a customer and link their installment loan under a specific product. Ensure the `customerId` is correctly substituted.

```json
{
"customer": {
"customerId": "{{customerId}}",
"customerGroup": "2"
},
"newAccounts": [
{
"acct": {
"prodName": "LN_Personal",
"acct_bk": {
"name": "12M Personal Loan",
"acctGroup": 1,
"acctTitle": "Austin Payne - Personal Loan",
"isBrokered": false,
"tmZoneCode": "usnyc"
},
"posn_lnDtl": [
{
"posn_ln": {
"ccyCode": "USD",
"glCat": 1,
"crLimit": 50000,
"acctgSeg": {
"deptId": "350",
"vertical": "01"
}
}
}
]
},
"acctPartyRel": {
"relType": "1"
}
}
]
}
```

--------------------------------

### Example Transaction Code Configuration

Source: https://finxact.io/docs/document-detail/document/dispute-provisional-credit

Configure the dispute-provCr process name, type, and transaction code in the EFT network transaction code setup. Ensure the process type matches 'Customer Credit to GL Debit'.

```json
{
"procName": "dispute-provCr",
"procType": 2,
"trnCode": "309"
}
```

--------------------------------

### Get Loan Amortization Schedule

Source: https://finxact.io/docs/document-detail/document/the-core-uses-loan-amortization-inputs-and-factors

Calculates an installment loan's amortization schedule and cash flow using provided inputs and factors. The calculation is iterative and relies on payment periods defined by the payment offset.

```APIDOC
## GET core/v1/amortize

### Description
Retrieves the amortization schedule and cash flow for an installment loan.

### Method
GET

### Endpoint
/core/v1/amortize

### Parameters
#### Query Parameters
- **pmtOffset** (integer) - Required - The payment offset defining the loan's payment periods.

### Response
#### Success Response (200)
- **amortizationSchedule** (object) - The calculated amortization schedule.
- **cashFlows** (object) - The calculated lifetime cash flows.
```

--------------------------------

### Example Request Body (Report and Additional Extracts)

Source: https://finxact.io/docs/document-detail/document/generate-the-gl-set-position-deposit-balancing-report-on-demand

Use this request body to generate the GL Set Position Deposit Balancing report along with associated extract files. Specify the desired file formats using the 'fileFmt' property.

```json
{
"glJrnlDate": "2026-03-15",
"runDtm": "2026-03-23T16:30:00Z"
"isGenerateFile": true,
"fileFmt": "POSNSETBALDEPSUM+POSNSETBALDEPDTL"
}
```

--------------------------------

### Create Loan Product

Source: https://finxact.io/docs/tutorials/detail-page/configure-a-late-charge-for-a-loan-product

Use this POST request to create the loan product. This configuration links the fee and repayment components, and specifies GL set usage. Ensure component names and versions match your setup.

```json
{
"name": "standard_loan_product",
"version": 1,
"desc": "Standard Loan Product",
"posnClass": "posn_ln",
"prodType": "Loan",
"prodSubType": "Personal",
"prodGroup": "Instalment",
"glCat": 1,
"glSetCode": "loansGlSet",
"ccyCode": "USD",
"ifxAcctType": "ILA",
"avlStartDtm": "2024-01-01T00:00:00Z",
"components": [
{
"componentClass": "componentFee",
"componentName": "LN_Fees",
"version": 1
},
{
"componentClass": "componentInt",
"componentName": "Installment_Interest_Variable",
"version": 1
},
{
"componentClass": "componentRepay",
"componentName": "InstallLoan_Repay",
"version": 1
}
]
}
```
Tokens:
Raw