FLEXBridge API Services Info/Available Fields

System Management System Management FLEXBridge API Services Info/Available Fields

This document provides a technical overview of the FLEXBridge API Services, detailing the available services, their functions, and the key data fields associated with each. This documentation is intended to assist users in understanding and leveraging the FLEX system’s API capabilities.

Current API Services

The FLEXBridge system offers a comprehensive suite of API services designed to facilitate various financial operations. The currently available services include:

  • Account Inquiry: For retrieving member account information.
  • Account Management: For opening and managing new member accounts.
  • ATM: For processing ATM transactions (used with ITM integrations).
  • Card Processing: For managing member debit/credit card information.
  • Certificate: For adding and managing certificates of deposit.
  • Document: For storing, searching, and retrieving documents.
  • Internet Banking: For retrieving and updating Internet Banking profiles.
  • Share (secondary suffixes): For opening and closing secondary share suffixes.
  • Stop Payment: For retrieving or creating stop payments on member accounts.
  • Loan Processing: For creating and funding new loans.
  • Transactions: For facilitating member account transfers and check withdrawals.

API Service Information

1. Account Inquiry API Service

The Account Inquiry API Service enables the retrieval of member account information.

Search Capabilities:

Member/account information can be searched using the following criteria:

  • Name
  • Tax ID
  • Account Number
  • Partial Name
  • Last four-digits of Tax ID
  • Last Name and First Initial

Additional Functions:

  • Review member account information by Tax ID or account and suffix.
  • Display all share, certificate, and loan suffix information.
  • List all Authorized Signers, Beneficiaries, Co-Borrowers, and Joint Owners.
  • Review Member Account Holds.
  • Review Member Share Overdraft Information.
  • Review Member Account Notes.
  • View Member Transaction History by Account/Suffix.
  • Retrieve All New Account Numbers Opened.
  • Reset Member Audio PIN.

Key Data Fields (Account Search Result):

  • Entity Key
  • Account Number
  • Associate Type
  • Opened Date
  • Dormancy Date
  • First Name
  • Middle Name
  • Last Name
  • Generation Code
  • Tax ID
  • Tax ID Format Code
  • Birth Date
  • Account Type
  • Sub Account Type
  • Key Word
  • Deceased Code
  • Deceased Date
  • Driver’s License Number
  • Driver’s License State
  • Mother’s Maiden Name
  • Frozen Flag
  • Do Not Allow List
  • Branch Code
  • Home Phone
  • Work Phone
  • Cell Phone
  • Primary Address
  • Emails

Key Data Fields (Account Overview Result):

  • Account Number
  • Account Status Code
  • Account Type
  • Account Description
  • Sub Account Type
  • Branch Code
  • Dormancy Date
  • Last Correspondence Date
  • Frozen Account
  • Dividend Eligible
  • Backup Withholding
  • Member Eligibility
  • Force Notes
  • Allow Purge
  • Statement Code
  • Federal Withholding Rate
  • Privacy Protected
  • Risk Level
  • Member ID Number
  • Related Member Code
  • ATM Debit Opt-In Reason
  • Current Receipt Address
  • Current Statement Address
  • Current Tax Form Address
  • Current CC Issue Address
  • Current CD Issue Address
  • Current Physical Address
  • Entity
  • Emails
  • Shares
  • Loans
  • Certificates
  • Joint Owners
  • Authorized Signers
  • Co-Borrowers
  • Credit Scores
  • Non-Sufficient Funds

Key Data Fields (Entity – Primary Member):

  • Entity Key
  • Entity Type
  • First Name
  • Middle Name
  • Last Name
  • Name Suffix
  • Name 1
  • Title
  • Nickname
  • Additional Mailing Line
  • Tax Name
  • Tax ID
  • Tax ID Format Code
  • Tax ID Certified
  • State Tax ID
  • Birth Date
  • Gender
  • Driver’s License Number
  • Driver’s License State
  • Mother’s Maiden Name
  • Security Question Answer
  • Deceased
  • Deceased Date
  • Disabled
  • Bankruptcy
  • Foreign Citizen
  • Living in Foreign Country
  • Caused Loss
  • Insurance Eligible
  • Credit Union Employee
  • Credit Union Employee Code
  • Employer Code
  • Lending Limit
  • Last Update
  • Phones
  • Address
  • Active Military

Key Data Fields (Joint Owner, Authorized Signer, Co-Borrower, Beneficiary):

These entities share many common fields with the Primary Member, including Entity Key, Tax ID, First Name, Last Name, Birth Date, Address, Phones, etc., with specific additions like Relationship to Primary for Joint Owners and Beneficiaries, and Suffix List for Authorized Signers and Co-Borrowers.

Key Data Fields (Address):

  • City
  • Country
  • Address Line 1
  • Address Line 2
  • State
  • Zip Code
  • Zip Code 4
  • Bad Address Date
  • Address Change Date
  • Last Update Date

Key Data Fields (Phone):

  • Area Code
  • Phone Number
  • Extension
  • Country Code
  • Type

Key Data Fields (Email):

  • Account Number
  • Sequence Number
  • Address
  • Statements
  • Receipts
  • Notices
  • Credit Card Statements
  • Mailings
  • Alerts
  • HELOC Statements
  • Bad Address

Key Data Fields (Share Suffix Info, Loan Suffix Info, Certificate Suffix Info):

These sections provide detailed information about specific suffix types, including balance, dates, rates, and various flags.

Key Data Fields (Holds, Credit Score List, Non-Sufficient Funds, Notes, Suffix History):

These sections provide specific data related to account holds, credit scores, NSF records, internal notes, and detailed transaction history for suffixes.

2. Account Management API Service

The Account Management API Service is used to open new member accounts. It includes objects and attributes for defining information regarding the Primary Account Holder, Joint Owner, Authorized Signer, and Beneficiaries. This service also creates the account’s primary or base share suffix.

Available Functions:

  • Open Pending Account: Creates a pending member account that the credit union will finalize via FLEX.
  • Open New Member Account: Automatically creates a new member account and base share for the credit union within their database.

Key Data Fields (New Account Info):

  • Account Type
  • Branch Code
  • Statement Code
  • Member Eligibility
  • Account Source Code
  • Forced Notes
  • Account Description
  • Risk Level
  • New Account UDFs (1-17)

Key Data Fields (Entity – Primary Member, Joint Owner, Authorized Signer, Beneficiary):

These structures are similar to those in the Account Inquiry service, with additional fields relevant to new account creation (e.g., Mobile Access for Joint Owners).

Key Data Fields (Base Share Info):

  • Account Number
  • Suffix Number
  • Share Type
  • Opened Date
  • Closed Date
  • Courtesy Pay Allowed
  • Last Transaction Date
  • Insurance Eligible
  • Number of Draft Transfers
  • Default Overdraft Code
  • Default Overdraft Share Suffix
  • Last Dividend Paid Date
  • Cross Reference Number
  • Excess Withdrawal Fee
  • Dividends Disburse Option
  • Where to Pay Dividend Account
  • Where to Pay Dividend Suffix
  • Federal Withholding Code
  • Dormancy Date
  • Last Correspondence Date
  • Charge Off Code
  • Charged Off Amount
  • Frozen
  • Opening Teller
  • Allow Daily Negative Fees
  • Reg E Opt-In
  • Reg E Notice Date
  • Closed Reason
  • CP Enrollment Date
  • Dividend YTD
  • Dividend Last Year
  • Available Balance
  • Available Courtesy Pay
  • Available Overdraft
  • Required Minimum Distribution
  • Accrued Amount
  • Accrued Through Date
  • Last Statement APY
  • Share UDFs (1-17)

Key Data Fields (Credit Scores, Notes, Employment Information, Employer Info):

These sections provide relevant information for new account setup, including credit scores, notes, and employment details for the primary member.

3. ATM API Service

The ATM API Service processes transactions to member accounts using an account or card number.

Available Functions:

  • Transactions:
    • Account Number – deposit, withdrawal, transfer, or loan payment.
    • Card Number – deposit, withdrawal, transfer, or loan payment.
  • Reversals: Each transaction option has a reversing transaction option for both account and card numbers.
  • Modifying Transactions: Used for partial transaction reversals for both account and card numbers.

Key Data Fields (Account/Card Transactions):

  • Card Number
  • Account Number
  • Suffix
  • Plastic Number
  • Account Type
  • Amount
  • Trace Number
  • Terminal Timestamp
  • Settlement Date
  • Transaction Fee
  • Institution ID
  • Track 2 Data
  • Retrieval Reference Number
  • Terminal ID
  • Location
  • Merchant
  • Network
  • Denial Code
  • D1 Processing Code
  • Cash Amount
  • Check Amount
  • From Account Type
  • To Account Type
  • From Suffix
  • To Suffix

4. Card Processing API Service

The Card Processing API Service manages all data elements regarding member debit/credit card information, allowing for adding, maintaining, or reissuing cards.

Available Functions:

  • Search for card by account or card number.
  • Add new card.
  • Update existing card.
  • Reissue.
  • Block Card.
  • Change PIN.

Key Data Fields (Retrieve Card Information):

  • Account Number
  • Card Number
  • Plastic Number
  • Card Type
  • Open Date
  • Block Information
  • Card Limits
  • Last Issue Information
  • Pending Issue Information
  • Current Expiration Date
  • Activation Code

Key Data Fields (Card Holder Information):

  • First Name
  • Middle Initial
  • Last Name
  • Association Code
  • PIN Offset
  • Card Funding Suffix Info
  • Fees Active
  • Cross Reference Number
  • Participation Code
  • Card Notes Information
  • Card Teller

Key Data Fields (Add New Card Information):

  • Account Number
  • Card Number
  • Plastic Number
  • Card Type
  • Open Date
  • Last Issue Information
  • Current Expiration Date

5. Certificate API Service

The Certificate API Service contains all data elements for adding a new certificate of deposit to an existing member’s account.

Available Functions:

  • Retrieve next available suffix for a certificate of deposit.
  • Retrieve certificate type default information from the credit union database.
  • Open certificate of deposit.

Key Data Fields (Retrieve Certificate Type Defaults):

  • Liability or Capital GL
  • Dividend Offset GL
  • Dividend Payable GL
  • Penalty Revenue GL
  • Backup Withholding GL
  • Rate
  • Days in Calculating Year
  • Dividend Frequency
  • Compound Daily
  • Renewal Code 1-4
  • Term
  • Term Code
  • Penalty Days
  • Penalty Grace Days
  • Penalty Cut into Balance
  • Penalty Rate
  • Penalty From Original or Current Balance Code
  • Federal Withholding GL
  • Federal Withholding Rate
  • Federal Withholding Code
  • Dividend or Interest
  • Annual Percentage Yield
  • State Withholding GL
  • State Withholding Rate
  • State Withholding Code
  • Penalty Basis for Partial Withdrawal
  • Active
  • Minimum Balance
  • Minimum Add-on Amount
  • Maximum Balance Amount
  • Where to Pay Interest Code
  • Variable Rate Code
  • Required to Withdraw Interest
  • Adjust Rate on Initial Deposit
  • Backup Withholding Rate
  • Step Up Frequency
  • Step Up Max Allowed
  • Step Up Date Reference
  • Renew as Type
  • Type
  • Description (4, 6, 10, 16 Characters)
  • Group
  • Certificate UDFs (1-17)

Key Data Fields (Create Certificate):

  • Certificate Type
  • Account Number
  • Suffix Number
  • Description
  • Agreed Monthly Deposit
  • Original Balance
  • Rate
  • Dividend Frequency
  • Compound Interest Daily
  • Variable Rate Code
  • Account Receiving Dividend
  • Suffix Receiving Dividend
  • Step Up Frequency
  • Step Up Count
  • Step Up Date
  • Next Dividend Pay Date
  • Last Dividend Calculation Date
  • Opened Date
  • Renewal Code 1-4
  • Certificate Number
  • Renew Type
  • Transfer Suffix
  • Penalty Days
  • Penalty Grace Period
  • Penalty Cut into Balance
  • Referral Code
  • Federal Withholding Code
  • State Withholding Code
  • Sep IRA

Key Data Fields (Joint Owner, Beneficiary):

These structures are similar to those in the Account Inquiry service, providing details about associated joint owners and beneficiaries for the certificate.

6. Document API Service

The Document API Service facilitates the storage, search, and retrieval of documents from the document database. All documents stored within the FLEX system are in PDF format, and all file retrieval/storing is in Binary data format.

Available Functions:

  • Store Document
  • Search Document
  • Retrieve Document

7. Internet Banking API Service

The Internet Banking API Service allows for the retrieval and update of an Internet Banking profile.

Available Functions:

  • Retrieve Profile by Tax ID Only.
  • Displays list of all Internet Banking profiles tied to individual Tax ID.
  • Retrieve Profile by Tax ID and Account Number.
  • Retrieve Profile by Username.
  • Create Internet Banking Profile.
  • Reactivate Disabled Account (requires member to re-enroll upon next login).
  • Clear Member High-Risk Security Options.
  • Reactivate Profile and Reset High-Risk Security (forces member to re-enroll in high-risk security upon next login).
  • Add New Security Contact to Profile (existing contacts can be retrieved before adding new contacts).
  • Reset Account Authentication when Username/Password has been Forgotten (requires member to re-enroll upon next login).
  • Replace Internet Banking Profile Password (resets password for Internet Banking profile).

Key Data Fields (FT User):

  • Record Code
  • Social Security Number
  • Username
  • First Account Number
  • Active User
  • Date Activated
  • Disable
  • Reason Disabled
  • Date Disabled
  • Mobile User
  • Label
  • Address

8. Loan Processing API Service

The Loan Processing API Service supports the creation and funding of new loans. While refinancing or add-on loans are not currently supported, the service can create and fund various loan types.

Supported Loan Types:

  • Consumer
  • HELOC
  • Mortgage
  • Credit Card
  • Auto
  • Lines of Credit
  • Share Secured
  • Other Types as Represented in Documentation

Additional Features:

  • Distributions to member(s) share accounts.
  • Loan Payoffs currently in service on FLEX System.
  • Distribution checks.
  • Transfers made directly to credit union FLEX accounting system.

Collateral Features:

  • Co-Borrowers
  • Shares
  • Vehicles
  • Real Estate
  • Other Miscellaneous Forms of Collateral

Origination Service Provider Options:

  • Variable Rate Information
  • Amortized Fees
  • Automatic Transfers
  • Payroll Deduction for Loan Payments

Available Functions:

  • Retrieval of Next Available Loan Suffix: Used before funding to query for a member’s next available loan type suffix.
  • Create Loan: Writes loan data into the loan processing database as a pending (or in-process) loan, requiring the credit union to complete funding, collect additional data, and print loan forms in the FLEX system before funding.
  • Post Loan: Writes the loan directly into the credit union database.

Key Data Fields (Loan Information):

  • Loan Group
  • Loan Type
  • Loan Account Number
  • Disbursement Date
  • Loan Suffix
  • First Payment Date
  • Due Date
  • Estimated Maturity Date
  • Date Interest Calculated Through
  • Note Number
  • Loan Description
  • Original Balance
  • Scheduled Payment Amount
  • Interest Rate
  • Open or Close Ended Code
  • Interest Rebate Code
  • Payment Method
  • Insurance Source Suffix
  • Payment Frequency
  • Charged Late Fee
  • Late Charge Calc Method
  • Variable Rate Group
  • Active Military
  • Reporting 1098
  • Security Code
  • Purpose Code
  • Pool ID
  • Credit Limit
  • Loan Officer Code
  • Number of Payments
  • Payment Coupons
  • Late Charge Fixed Amount
  • Escrow Amount
  • Escrow Suffix
  • Collection Call Back Date
  • Balloon Payment Rollover Term
  • Collection Officer
  • Skip Payment Begin Date
  • Insurance Certificate Number
  • Skip Payment End Date
  • Disability Insurance Type
  • Disability Insurance Plan Code
  • Credit Disability Election Date
  • Credit Disability Employee Code
  • Credit Disability Balloon Coverage Flag
  • Life Insurance Type
  • Life Insurance Code
  • Credit Life Election Date
  • Credit Life Employee Code
  • Credit Life Balloon Coverage Flag
  • Joint Insured Last Name
  • Joint Insured First Name
  • Joint Insured Middle Name
  • Joint Owner Birthday
  • Delinquency Notice Code
  • Credit Bureau Account Type
  • Cross Reference Number
  • Compliance Condition Code
  • Compliance Condition Code Reporting Date
  • Consumer Information Indicator
  • Indicator Reporting Date
  • Credit Grade
  • Census Tract
  • Credit Score
  • Freeze Credit Limit
  • Frozen Flag
  • Special Comment Flag
  • Credit Bureau Code
  • Debt Cancellation Type
  • Debt Cancellation Plan Code
  • Debt Cancellation Election Date
  • Debt Cancellation Election Code
  • Debt Cancellation Balloon
  • Suffix Included in Bankruptcy
  • Memo Interest
  • Additional Payment Amount
  • Application Teller
  • Application Date
  • Approval Teller
  • Approval Date
  • Consumer Information Indicator
  • Loan Disbursement Teller
  • Dealer Key
  • Loan Disbursement Date
  • Dealer Payout Rate
  • Single Premium Credit Disability Amount
  • Single Premium Life Amount
  • Loan Amount to Disburse
  • Payoff for Refinance
  • Financed Prepaid Finance Charge
  • Cash Prepaid Finance Charge
  • Finance Filing Fee
  • Cash Filing Fee
  • Prepaid Interest
  • Review Teller
  • Review Date
  • Current Debt to Income Ratio
  • New Debt to Income Ratio
  • Unsecured Credit
  • Available Credit
  • Loan Source
  • Insurance Selling Teller
  • Draw Expiration Date
  • Branch Code
  • Workstation ID
  • Insurance Eligible

Key Data Fields (Disbursement Lists – Check, Loan, Share, GL):

These lists detail the various ways loan funds can be disbursed, including amounts, account numbers, suffixes, and descriptions.

Key Data Fields (Co-Borrower Information List):

  • Original Liability Amount
  • Current Liability Amount
  • Current Liability Last Update
  • Scheduled Release Date
  • Description
  • Liability Percentage
  • Loan Balance Deduction
  • Liability Maximum
  • Association Code
  • Active Military

Key Data Fields (Vehicle Collateral List, Title Information, Insurance Information, Gap Coverage, VSI Coverage, Service Contract Coverage, Miscellaneous Collateral List, Real Estate Collateral List):

These sections provide extensive details about various types of collateral, including their values, dates, descriptions, and associated insurance information.

Key Data Fields (Variable Rate Extension):

  • Original Rate
  • Max Life Increase
  • Max Life Decrease
  • Max Incremental Increase
  • Max Incremental Decrease
  • Rate Floor
  • Rate Ceiling
  • Rate Sent on Pre-Notice
  • Payment Sent on Pre-Notice
  • Last Pre-Notice Send Date
  • Pre-Notice Term
  • Pre-Notice Date to be Paid
  • Pre-Notice New Remaining Term
  • Pre-Notice Old Remaining Term
  • Pre-Notice Balance Used
  • Rate Change Frequency
  • Change Option
  • Days Before Change to Notify
  • Next Rate Change Date
  • Anniversary Date
  • Original Rate This Year
  • Max Increase Year
  • Max Decrease Year
  • Prime Change Plus/Minus
  • Prime Change Amount
  • Index Rate Based Upon
  • Rate Group

Key Data Fields (Amortized Fees):

  • Fee Code
  • Amortized Type
  • Start Date
  • Original Amount
  • Remaining Amount
  • Forced Amount
  • Term
  • Frequency Monthly or Quarterly Only
  • GL Payable Account
  • GL Expense Account
  • GL Depreciation Account

Key Data Fields (Automatic Transfer List):

  • Taken From Account Number
  • Taken From Suffix
  • Given To Account
  • Given To Suffix
  • Next Run Date
  • Amount of Transfer
  • Frequency
  • Description for History
  • Start Date
  • Stop Date
  • Allow Partial Transfers
  • Partial Transfer Amount
  • Consider Loan Due Date
  • Override Available Funds
  • Use Loan Payment Amount
  • User Maintenance
  • Posting Group Number

Key Data Fields (Credit Card Category List, Credit Card Loan, HELOC Information, Payroll Information List, ACH Distribution List, User Defined Fields, Temporary Modification List, Loan Type Conversion):

These sections provide detailed data structures for credit card specific settings, HELOC conversions, payroll deductions, ACH distributions, user-defined fields for loans, temporary loan modifications, and loan type conversions.

9. Share API Service

The Share API Service enables the opening of new secondary share suffixes or the closing of existing suffixes.

Available Functions:

  • Open Share Suffix
  • Close Share Suffix

Key Data Fields (Share Information):

  • Account Number
  • Suffix Number
  • Share Type
  • Opened Date
  • Closed Date
  • Courtesy Pay Allowed
  • Last Transaction Date
  • Insurance Eligible
  • Number of Draft Transfers
  • Default Overdraft Code
  • Default Overdraft Share Suffix
  • Default Overdraft Loan Suffix
  • Last Dividend Paid Date
  • Cross Reference Number
  • Excess Withdrawal Fee
  • Dividends Disburse Option
  • Where to Pay Dividend Account
  • Where to Pay Dividend Suffix
  • Federal Withholding Code
  • Dormancy Date
  • Last Correspondence Date
  • Charge Off Code
  • Charged Off Amount
  • Frozen
  • Opening Teller
  • Allow Daily Negative Fees
  • Reg E Opt-in
  • Reg E Notice Date
  • Closed Reason
  • CP Enrollment Date
  • Dividend YTD
  • Dividend Last Year
  • Available Balance
  • Available Courtesy Pay
  • Available Overdraft
  • Required Minimum Distribution
  • Accrued Amount
  • Accrued Through Date
  • Last Statement APY
  • Shared UDFs (1-17)

Key Data Fields (Joint Owner, Authorized Signer, Beneficiary):

These structures are similar to those in the Account Inquiry service, providing details about associated joint owners, authorized signers, and beneficiaries for the share suffix.

10. Stop Payment API Service

The Stop Payment API Service allows for retrieving or creating stop payments on member accounts.

Available Functions:

  • Retrieve Stop Payment for Account
  • Create Stop Payment for Account

Key Data Fields (Create Stop Payment):

  • Account Number
  • Suffix
  • Draft Number
  • From Draft Number
  • To Draft Number
  • Sequence Number
  • Amount
  • Release Date
  • Entered Date
  • Reason
  • Charge Fee
  • Setup Fee
  • Fee Suffix
  • Print Notice

Key Data Fields (Retrieve Stop Payment):

  • Account Number
  • Suffix
  • Draft Number
  • Sequence Number
  • Amount
  • Release Date
  • Entered Date
  • Reason
  • Member Name

11. Transactions API Service

The Transaction API Service facilitates member account transfers and check withdrawals. It also includes loan payments, savings funds transfers, and member cross-account transfers. This process does not allow for transfers from/to a general ledger to a member account, transfers between general ledgers, or sending transfers to locations outside the FLEX core system.

Available Functions:

  • Post Account Transfers
  • Payments
  • Transfer funds between member accounts or share suffixes
  • Check Withdrawals

Key Data Fields (Check Withdrawal):

  • From Account
  • From Suffix
  • From Tran Description
  • Transaction Amount
  • Accept Fees
  • Accept Warnings
  • Calculate Fee

Key Data Fields (Account Transfer):

  • From Account
  • From Suffix
  • From Tran Description
  • To Account
  • To Suffix
  • To Tran Description
  • Accept Fees
  • Accept Warnings
  • Calculate Fee
  • Principal Only Payment
  • Reg D Transfer
  • Allow Suffix Balance to go Negative
  • Credit Card Adjustment

Key Data Fields (Transaction Fee List):

  • Amount
  • Description
  • GL Account Number