FLEXBridge Transmission Service API

FLEXBridge 2025 FLEXBridge API Documents FLEXBridge Transmission Service API

This document provides comprehensive technical documentation for the FlexBridge Transmission Service API, a RESTful API designed for retrieving Credit Union member ACH (Automated Clearing House) information within the Flex system (www.flexcutech.com). This API is essential for third-party applications and internal systems needing access to ACH transaction details.

1. Introduction to FlexBridge Transmission Service API

The Transmission Service API allows for the retrieval of member ACH information. The service response includes details about recent and pending ACH transactions, as well as any configured origination disbursements.

  • Available FLEX Releases: 8.05 and above

2. General API Information

  • RESTful API: Follows RESTful principles for communication.
  • Authentication: Requires built-in authentication via HTTPS request headers. Refer to the FLEX Authentication Protocols and Other Information documentation for details on authentication processes for requests.
  • Data Format: All data is sent and returned in JSON format.

3. FLEXBridge Functions

The Transmission Service API currently offers the following function:

  • Retrieve ACH Information for an Account.

4. Retrieve ACH Account Information

This function is used to retrieve comprehensive ACH account information for a member, including lists of recent, pending, and origination disbursements.

  • GET Method:
    • URL: https://{BASE_URL}/api/ach/account/{ACCOUNT_NUMBER}
    • Parameters:
      • {ACCOUNT_NUMBER} (Required, Number): The member’s account number.
  • Response Object (FBAchAccountInformationDTO):
    {
      “achAccountList”: [],
      “achPendingList”: [],
      “achOriginationList”: []
    }

    • FBAchAccountInformationDTO (List): A list containing member ACH information, including recent and pending transactions and any set origination disbursements.

5. Object References

The API response for retrieving ACH account information is structured into three main lists: achAccountList, achPendingList, and achOriginationList.

5.1. achAccountList (ACH Account List)

This list contains details of recent ACH transactions.

  • Attributes:
    • companyId (Number): ACH company ID. Max 10 chars.
    • achAccountNumber (String): ACH account number. Max 17 chars.
    • accountType (String): Account type (D=Draft, S=Share, L=Loan). Max 1 char.
    • companyName (String): ACH company name. Max 16 chars.
    • accountNumber (Number): Member account number. Max 9 chars.
    • suffixNumber (Number): Suffix or subaccount value for ACH posting. Max 3 chars.
    • nameFromACHEntry (String): Name received from ACH posting entry. Max 22 chars.
    • authorizationAmount (Number): Authorization amount (negative for debits). Max 9 chars.
    • lastRunDate (Date): Last posting date (MM/DD/CCYY).
    • stopPayment (Boolean): Was payment stopped.
    • achDistributionsList (List): List of distributions tied to ACH posting.

5.2. achDistributionsList (ACH Distributions List)

This list details ACH distributions connected with ACH posting entries or configured by the Credit Union. It will be blank if no distributions exist.

  • Attributes:
    • achGroup (String): Credit union defined ACH group ID. Max 4 chars.
    • fromAccountNumber (Number): Account debited for distribution posting. Max 9 chars.
    • fromSuffixNumber (Number): Subaccount debited for distribution posting. Max 3 chars.
    • priority (String): Sequence priority of multiple distribution postings (1-9). Max 1 char.
    • sequenceNumber (Number): Distribution sequence number. Max 7 chars.
    • nameFromACHEntry (String): Name received with ACH distribution. Max 22 chars.
    • toAccountNumber (Number): Account credited with distribution posting. Max 9 chars.
    • toSuffixNumber (Number): Subaccount credited with distribution posting. Max 3 chars.
    • amount (Number): Distribution amount. Max 9 chars.
    • usePaymentAmount (Boolean): Use loan payment amount for distribution amount.
    • useDueDate (Boolean): Use loan due date as distribution posting date.
    • stopPaymentDate (Date): Date distribution payment was stopped (MM/DD/CCYY).
    • transactionDescription (String): Distribution transaction description. Max 16 chars.
    • frequency (String): Distribution frequency (refer to Appendix for values). Max 1 char.
    • dueDateGraceDays (Number): Number of days before loan due date a distribution can occur. Max 2 chars.
    • allowPartial (String): Allow a partial distribution (refer to Appendix for values). Max 1 char.
    • iraHsaCode (String): IRA HSA code (refer to Appendix for values). Max 1 char.
    • lastRunDate (Date): Last distribution posting (MM/DD/CCYY).
    • nextRunDate (Date): Next distribution posting (MM/DD/CCYY).
    • restartPaymentDate (Date): Date a stopped distribution starts posting again (MM/DD/CCYY).
    • stopPayment (Boolean): Is distribution payment stopped.
    • alternatePayeeSequenceNumber (Number): Alternate distribution payee sequence number. Max 9 chars.

5.3. achPendingList (ACH Pending List)

This list contains details of pending ACH transactions.

  • Attributes:
    • recordCode (String): FLEX record code entry. Max 1 char.
    • sequenceNumber (Number): Assigned ACH pending sequence number. Max 7 chars.
    • companySequence (Number): ACH group company sequence number. Max 7 chars.
    • achAccountNumber (String): Received ACH entry account number. Max 17 chars.
    • transactionCode (String): ACH Transaction Code (refer to Appendix for values). Max 2 chars.
    • transactionAmount (Number): Pending ACH transaction amount. Max 9 chars.
    • memberName (String): Member name. Max 22 chars.
    • transactionEffectiveDate (Date): Effective date for ACH posting (MM/DD/CCYY).
    • traceNumber (String): ACH posting trace number. Max 15 chars.
    • exceptionReason (String): ACH exception posting reason. Max 20 chars.
    • individualId (String): ACH posting individual ID. Max 15 chars.
    • routeNumber (String): Route number. Max 8 chars.
    • terminalLocation (String): Terminal Location. Max 27 chars.
    • terminalCity (String): Terminal city. Max 15 chars.
    • terminalState (String): Terminal state. Max 2 chars.
    • terminalDate (Date): Terminal date for transaction (MM/DD/CCYY).
    • description (String): Posting description. Max 10 chars.
    • companyName (String): Company name. Max 16 chars.
    • chargeFee (Boolean): Was a fee charged during posting.
    • entryClass (String): ACH posting entry class (ARC, CCD, CTX, IAT, PPD, TEL, WEB). Max 3 chars.
    • returnCode (String): ACH posting return code (refer to Appendix for values). Max 2 chars.
    • stopTableSequence (Number): Stop table sequence. Max 2 chars.
    • stopOrRevoke (String): Stop or revoke posting (S=Stop, R=Revoke). Max 1 char.
    • deceasedDateOrR69Reason (String): Deceased date or R69 reason. Max 9 chars.
    • secondaryEntryClass (String): Secondary entry class. Max 3 chars.
    • flagOfacSuspect (Boolean): Flagged for suspect OFAC match.
    • iatCheckNumber (Number): IAT check number. Max 9 chars.
    • overdraftSequenceNumber (String): Overdraft sequence number. Max 9 chars.
    • settlementDate (Date): Settlement date (MM/DD/CCYY).
    • open (String): Open space for additional information. Max 14 chars.

5.4. achOriginationList (ACH Origination List)

This list contains details of ACH originations.

  • Attributes:
    • companySequenceNumber (Number): Company sequence number. Max 5 chars.
    • detailSequenceNumber (Number): Detail sequence number. Max 5 chars.
    • recordCode (String): Record code. Max 1 char.
    • frequency (Number): Origination frequency (refer to Appendix for values). Max 1 char.
    • lastSendDate (Date): Last date origination sent (MM/DD/CCYY).
    • processingDate (Date): Last origination processing date (MM/DD/CCYY).
    • effectiveDate (Date): Effective origination date (MM/DD/CCYY).
    • preNoteDate (Date): Pre-notice origination date (MM/DD/CCYY).
    • memberAccountNumber (Number): Member account number. Max 9 chars.
    • memberAccountSuffix (Number): Member suffix number. Max 3 chars.
    • verifyFundsAvailable (Boolean): Available funds verified.
    • transactionDescription (String): Origination description. Max 16 chars.
    • feeAmount (Number): Origination fee amount. Max 9 chars.
    • feeAccountNumber (Number): Account used for origination fee. Max 9 chars.
    • feeSuffixNumber (Number): Subaccount used for origination fee. Max 3 chars.
    • considerLoanDueDate (Boolean): Use loan due date as origination posting date.
    • useLoanPaymentAmount (String): Use loan payment amount for origination amount (Y or N). Max 1 char.
    • iraCode (String): IRA code (refer to Appendix for values). Max 1 char.
    • transactionCode (Number): ACH Transaction Code (refer to Appendix for values). Max 2 chars.
    • receivingDfi (Number): Identifies receiving company ID. Max 8 chars.
    • receivingDfiCheckDigit (Number): Received DFI check digit. Max 1 char.
    • dfiAccountNumber (String): DFI account number. Max 17 chars.
    • amount (Number): Origination amount. Max 10 chars.
    • individualIdNumber (String): Individual ID number. Max 15 chars.
    • individualName (String): Individual name. Max 22 chars.
    • discretionaryData (String): Optional field used by the DFI. Max 2 chars.
    • addendaInformation (String): Optional field generated by originating DFI. Max 80 chars.
    • nextProcessingDate (Date): Origination next processing date (MM/DD/CCYY).
    • effectiveDateAdjust (Number): Number of business days after processing date the transaction is posted. Max 1 char.
    • startDate (Date): Origination start date (MM/DD/CCYY).
    • companyName (String): Origination company name. Max 16 chars.

6. Appendix

The document includes comprehensive appendices with various code lists for reference:

  • Allow Partial Payment Options: Options for partial distribution (Y, N, O, P, R).
  • Frequency Values: Codes for various distribution and origination frequencies (e.g., W=Weekly, M=Monthly).
  • HSA Codes: Codes for Health Savings Account contributions.
  • IRA Codes: Codes for various IRA contributions and distributions.
  • ACH Transaction Codes: Codes identifying different types of ACH credit and debit entries.
  • ACH Return Codes: Codes for ACH return reasons.