Introduction to FLEXBridge Service APIs Quick Reference

FLEXBridge FLEXBridge Introduction to FLEXBridge Service APIs Quick Reference

The FLEXBridge Service APIs serve as the programmatic interface for external systems to interact with the core Flex system. These APIs enable secure and efficient data exchange, allowing third-party applications to leverage various Flex functionalities, from account management to transaction processing.

General API Structure and Data Handling

The FLEXBridge system supports specific data formats for document management and communication:

  • All documents stored within the FLEX system are in PDF format.
  • All file retrieval and storing through the Document API Service occurs in Binary data format.
  • Third-party systems establish an API interface by connecting to the Public IP of the FLEXBridge/Web Server [FLEXBridge Integration Flow Chart].

Overview of Current FLEXBridge Service APIs

The FLEXBridge system offers a suite of distinct API services, each designed for specific operational areas:

  • Account Inquiry
  • Account Management
  • ATM
  • Card Processing
  • Certificate
  • Document
  • Share (secondary suffixes)
  • Stop Payment
  • Loan Processing
  • Transactions
  • Transmission
  • Internet Banking

Detailed FLEXBridge Service API Information

1. Account Inquiry API Service

Description: The Account Inquiry API service provides processes for retrieving comprehensive member account information.

Available Search Methods: This service allows searching for member and account information using various criteria:

  • Name
  • Tax ID
  • Account number
  • Partial name
  • Last four digits of Tax ID
  • Last name and first initial

Other Key Functions: The Account Inquiry API service enables users to:

  • Review member account information by Tax ID or account and suffix.
    • This includes displaying all share, certificate, and loan suffix information.
    • It also lists all Authorized Signers, Beneficiaries, Co-Borrowers, and Joint Owners associated with the account.
  • Review Member Account Holds.
  • Review Member Share Overdraft Information.
  • Review Member Account Notes.
  • View Member Transaction History by account and suffix.
  • Retrieve Member Data Records.
  • Retrieve all New Account Numbers Opened.
  • Reset a Member Audio Pin.
  • Perform Audio Pin Validation.

Key Data Elements Accessible: This API provides extensive detail across various entities, including but not limited to:

  • Account Search Results: General account details like Account Number, Opened/Dormancy Dates, Member Names, Tax ID, Birth Date, and various flags (e.g., Frozen Flag, Do Not Allow List).
  • Account Overview: Account Status, Type, Description, Branch Code, and financial indicators like Dividend Eligibility, Backup Withholding, and Risk Level.
  • Member Entities: Detailed personal information for Primary Members, Joint Owners, Authorized Signers, and Co-Borrowers, including names, Tax IDs, birth dates, addresses, phone numbers, and security question answers.
  • Financial Suffix Information:
    • Share Suffix Info: Current Balance, Opened/Closed Dates, Courtesy Pay details, Overdraft Information, Dividend history, and Available Balances.
    • Loan Suffix Info: Loan Type, Status, Interest Rate, Payment Method, Payment Frequency, Late Charge details, Credit Limit, Delinquency status, and Payoff Amount.
    • Certificate Suffix Info: Current Balance, Interest YTD/Last Year, Maturity Date, Rate, and Accrued Amount.
  • Holds: Details on account holds, including Amount, Reason, Location, and Date/Time of Hold.
  • Credit Scores: Credit Bureau Name, Score Type, Score Date, Grade, and Score.
  • Non-Sufficient Funds (NSF): Amount, Draft Number, Description, Return Date, and Fees.
  • Notes: Account-specific notes, including creation/modification dates, subject, text, and priority.
  • Transaction History: Detailed transaction records including Actual Date, Amount, Balance Before/After, Description, Transaction Type, and Check Number.

2. Account Management API Service

Description: The Account Management API service is used primarily for opening new Member accounts. It includes objects and attributes necessary for defining information about 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: This function creates a pending member account, which requires the credit union to finalize the opening process via the Flex system.
  • Open New Member Account: This automatically creates a new member account and its base share for the credit union directly within their database.

Key Data Elements for New Account Creation: The API handles extensive data for new accounts, including:

  • New Account Information: Account Type, Branch Code, Statement Code, Member Eligibility, Account Source Code, and Risk Level.
  • Entity Information: Comprehensive details for the Primary Member, Joint Owners, Authorized Signers, and Beneficiaries, covering personal data (names, Tax ID, birth date), contact information (emails, addresses, phones), employment details, and security questions.
  • Base Share Information: Details for the primary share suffix including share type, open/closed dates, courtesy pay, overdraft settings, dividend information, and available balances.
  • Credit Scores & Notes: Allows for capturing initial credit scores and adding notes during account creation.
  • Employment Information: Start Date, End Date, Title Position, Pay details, and Employer Information (Name, Contact, Address).

3. ATM API Service

Description: The ATM API service is designed to process transactions to Member accounts using either an account number or a card number. This API is specifically used with ITM (Interactive Teller Machine) integrations.

Available Functions:

  • Transactions: Allows for various transaction types using an Account number or Card number:
    • Deposit
    • Withdrawal
    • Transfer
    • Loan payment
  • Reversals: Each transaction option above has a corresponding reversing transaction option for both Account number and Card number.
  • Modifying Transactions: Used for situations where a transaction requires modification, such as a partial transaction reversal. This applies to:
    • Account number transaction modification (for deposit, withdrawal, transfer, or loan payment).
    • Card number transaction modification (for deposit, withdrawal, transfer, or loan payment).

Key Data Elements Accessible: Transactions contain information like Card Number, Account Number, Suffix, Amount, Trace Number, Terminal Timestamp, Settlement Date, Transaction Fee, Institution ID, and details about the source and destination accounts/suffixes.

4. Card Processing API Service

Description: The Card Processing API service manages all data elements related to member debit and credit card information. It facilitates adding (both debit and credit), maintaining, or reissuing cards.

Available Functions:

  • Search for a card by account or card number.
  • Add a new card.
  • Update an existing card, including options to:
    • Reissue a card.
    • Block a card.
    • Change a PIN.

Key Data Elements Accessible: This API handles details such as Account Number, Card Number, Plastic Number, Card Type, Open Date, Block Information, Card Limits, Last/Pending Issue Information, Expiration Date, Activation Code, Card Holder Information (Name, Association Code), PIN Offset, Card Funding Suffix Info, Fees, and Card Notes.

5. Certificate API Service

Description: The Certificate API service contains all the necessary data elements for adding a new Certificate of Deposit to an existing member’s account.

Available Functions:

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

Key Data Elements Accessible: The API provides fields for retrieving default certificate types (e.g., GL accounts, rates, renewal codes, terms, penalty details, withholding information, minimum/maximum balances). For creating a certificate, it includes Certificate Type, Account/Suffix Numbers, Description, Original Balance, Rate, Maturity Date, and details about Joint Owners and Beneficiaries.

6. Document API Service

Description: The Document API Service allows users to store, search, and retrieve documents from the document database within the Flex system. As previously noted, all documents are stored in PDF format, and all file retrieval and storing are in Binary data format.

Available Functions:

  • Store document.
  • Search document.
  • Retrieve document.

7. Internet Banking API Service

Description: The Internet Banking API service manages processes for retrieving and updating an Internet Banking profile within the FLEXBridge System.

Available Functions:

  • Retrieve profile by Tax ID only.
    • This function displays a list of all Internet Banking profiles tied to an individual Tax ID.
  • Retrieve profile by Tax ID and account number.
  • Retrieve profile by username.
  • Create an Internet Banking profile.
  • Reactivate disabled account.
  • Clear Member high-risk security options, which requires the Member to re-enroll upon their next login.
  • Reactivate profile and reset high-risk security, forcing the Member to re-enroll in high-risk security upon their next login.
  • Add new security contact to profile (existing contacts can be retrieved before adding new ones).
  • Reset account authentication when a username or password has been forgotten, requiring the Member to re-enroll upon next login.
  • Replace an Internet Banking profile password, which resets the password for that profile.

Key Data Elements Accessible: The Internet Banking API provides user profile details such as Record Code, SSN, Username, First Account Number, Active/Disabled status, and contact information.

8. Loan Processing API Service

Description: The Loan Processing API service enables the creation and funding of new loans. Refinancing or add-on loans are not currently supported by this service.

Supported Loan Types: The API can handle various types of loans, including:

  • Consumer
  • HELOC (Home Equity Line of Credit)
  • Mortgage
  • Credit Card
  • Auto
  • Lines of Credit
  • Shared Secured
  • Other types as specified in the documentation.

Additional Supported Features: The Loan Processing API supports several features beyond basic loan creation:

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

Collateral Features: This API service supports various forms of collateral, including:

  • Co-Borrowers
  • Shares
  • Vehicles
  • Real Estate
  • Other miscellaneous forms of collateral.

Origination Service Provider Options: The API supplies origination service providers with options for:

  • Variable rate information.
  • Amortized fees.
  • Automatic transfers.
  • Payroll deduction for loan payments.

Available Functions:

  • Retrieval of the next available loan suffix: Used before loan funding to query for a member’s next available loan type suffix.
  • Create Loan: This writes loan data into the credit union’s Loan Processing database as a pending (or in-process) loan that requires the credit union to complete funding. This allows the credit union to collect additional data and print loan forms in the FLEX system before the loan is funded to a Member account.
  • Post Loan: This function writes a loan directly into the credit union’s database.

Key Data Elements Accessible: This API covers extensive loan-related information:

  • Loan Information: Loan Type, Account/Suffix, Disbursement/Payment/Maturity Dates, Interest Rate, Payment Method, Original Balance, Credit Limit, and details about insurance, collateral, and delinquency.
  • Disbursement Lists: Includes details for Check, Loan, Share, and GL disbursements, specifying amounts and accounts.
  • Collateral Information: Detailed sections for Vehicle, Miscellaneous, Share, and Real Estate collateral, including values, dates, descriptions, and insurance information.
  • Financial Details: Amortized Fees, Automatic Transfers, Payroll Information, ACH Distributions, and User Defined Fields.
  • Temporary Modifications: Allows for adjustments to loan sequences, payments, grace days, and interest rates for specific periods.

9. Share API Service

Description: The Share API service allows for opening new secondary share suffixes or closing existing suffixes.

Available Functions:

  • Open share suffix.
  • Close share suffix.

Key Data Elements Accessible: The API manages Share Info such as Account/Suffix Number, Share Type, Open/Closed Dates, Current Balance, Courtesy Pay settings, Overdraft details, Dividend information, and Available Balance. It also handles Joint Owner, Authorized Signer, and Beneficiary details associated with shares.

10. Stop Payment API Service

Description: The Stop Payment API service enables the retrieval or creation of stop payments on member accounts.

Available Functions:

  • Retrieve stop payment for an account.
  • Create stop payment for an account.

Key Data Elements Accessible: This API allows specifying Account Number, Suffix, Draft Number (or From/To Draft Number range), Amount, Release Date, Reason, and Fee details for stop payments.

11. Transaction API Service

Description: The Transaction API service facilitates member account transfers and check withdrawals. It also supports transfers to pay loans, moving funds between member subaccounts, and member across-account transfers.

Important Limitation: This process does not allow transfers from/to a general ledger to a member account, between general ledgers, or sending a transfer 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 Elements Accessible: For check withdrawals and account transfers, the API uses From Account/Suffix, Description, Transaction Amount, and options to accept fees or warnings. It also supports Principle Only Payment, Reg D Transfer, and Credit Card Adjustment.

12. Transmission API Service

Description: The Transmission Service API allows for the retrieval of credit union member ACH (Automated Clearing House) information. The service response includes information about recent and pending transactions and any set origination disbursements.

Available Functions:

  • Retrieve ACH Information for an Account.

Key Data Elements Accessible: The API provides lists for ACH Account Information (Company ID, Account Type, Name, Authorization Amount, Last Run Date), ACH Distribution List (From/To Account, Amount, Frequency, Due Date Grace Days), ACH Pending List (Record Code, Transaction Code/Amount, Member Name, Effective Date), and ACH Origination List (Frequency, Send Date, Member Account/Subaccount, Transaction Code, Amount).

Confidentiality Notice: This document is published by Computer Marketing Corporation/FLEX and is intended solely for its contracted clients. It may contain information that is privileged, confidential or otherwise protected from disclosure. Dissemination, distribution or copying of this document and any accompanying attached information by someone other than the intended recipient(s), or an employee or agent acting on behalf of the intended recipient, is strictly prohibited.