FLEXBridge Stop Payment Service API

FLEXBridge 2025 FLEXBridge API Documents FLEXBridge Stop Payment Service API

This document provides comprehensive technical documentation for the FlexBridge Stop Payment Service API, a RESTful API designed for managing draft stop payments and account holds within the Flex system (www.flexcutech.com). This API is essential for Credit Union staff and integrated systems needing to programmatically retrieve, create, and delete stop payments and holds.

1. Introduction to FlexBridge Stop Payment Service API

The Stopped Payment Service API is a component of the FLEXBridge System that facilitates processes for retrieving or creating draft stop payments for a member account, along with adding and removing holds.

  • Available FLEX Releases: 8.04 and up

2. General API Information

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

3. FLEXBridge Functions

The Stop Payment Service API offers the following functions:

  • Draft Stop Payments:
    • Retrieve all draft stopped payments by account and subaccount/suffix.
    • Create a draft stop payment by account and subaccount/suffix.
  • Holds:
    • Create an account hold by an account and a subaccount.
    • Delete an account hold using a unique ID.
    • Retrieve account holds.

4. API Endpoints and Methods

4.1. Retrieving Stopped Payments

Retrieves a list of stopped payments for a member account. This request requires a member account and suffix/subaccount number.

  • GET Method:
    • URL: https://{BASE_URL}/account/{ACCOUNT_NUMBER}/stoppedpayments/{SUFFIX_NUMBER}
    • Parameters:
      • {ACCOUNT_NUMBER} (Required, Number): Member account number.
      • {SUFFIX_NUMBER} (Required, Number): Member suffix/subaccount.
  • Response Object (stoppedPayments):
    {
      “stoppedPayments”: [] // List of all available check payments stopped for the account.
    }

4.2. Create a Stop Payment

Creates a draft stop payment to a member’s account.

  • POST Method:
    • URL: https://{BASE_URL}/createstoppayment
    • JSON Body Attributes (Stop Payment Request object):
      • accountNumber (Required, Number): Account number. Max 9 chars.
      • suffix (Required, Number): Suffix or Subaccount. Max 3 chars.
      • draftNumberFrom (Optional, Number): Starting draft number. Max 9 chars. (At least one of draftNumberFrom or draftNumberTo is required).
      • draftNumberTo (Optional, Number): Ending draft number. Max 9 chars. (At least one of draftNumberFrom or draftNumberTo is required).
      • amount (Required, Number): Draft amount. Max 9 chars.
      • sequenceNumber (Optional, Number): Sequence number assigned to Stop Payment items. Default 0. Max 2 chars.
      • enteredDate (Required, Date – MM/DD/CCYY): Starting date for Stop Payment.
      • releaseDate (Optional, Date – MM/DD/CCYY): Expiration date for Stop Payment.
      • reason (Required, String): Reason for Stop Payment. Max 20 chars.
      • chargeFee (Optional, Boolean): Will a Stop Payment fee be charged.
      • setupFee (Optional, Number): Fee for creating Stop Payment. Max 6 chars.
      • feeSuffix (Optional/Required, Number): Suffix charged for Stop Payment fee. Required if chargeFee is true. Max 3 chars.
      • printNotice (Optional, Boolean): Was a Stop Payment notice printed. Default false.
  • Response Attribute (success):
    {
      “success”: true // Indicates if the request was successful.
    }

4.3. Creating an Account Hold

Adds a deposit hold amount following a transaction.

  • POST Method:
    • URL: https://{URL_ADDRESS}/api/check/hold/save
    • JSON Body Attributes:
      • accountNumber (Required, Number): Member account number. Max 9 chars.
      • suffixNumber (Required, Number): Account subaccount value. Max 3 chars.
      • holdAmount (Required, Number): Hold amount. Max 9 chars.
      • reason (Optional, String): Reason for the hold. Max 16 chars.
      • draftNumber (Optional, Number): Draft Number for the hold. Max 7 chars.
      • holdCode (Optional, String): Hold code. Max 2 chars.
  • Response Attribute (success):
    {
      “success”: true // Indicates if the request was successful.
    }

4.4. Deleting Account Holds

Deletes a placed hold amount from an account.

  • POST Method:
    • URL: https://{URL_ADDRESS}/api/check/hold/delete
    • JSON Body Attribute:
      • id (Required, Number): Unique Hold ID to be deleted.
  • Response Attribute (success):
    {
      “success”: true // Indicates if the request was successful.
    }

4.5. Retrieving Holds

4.5.1. Retrieving Holds by Account Number

Provides a list of all holds for an account.

  • POST Method:
    • URL: https://{URL_ADDRESS}/api/account/holds/info
    • JSON Body Attribute:
      • accountNumber (Required, Number): Member account number.
  • Response Object (holds):
    {
      “success”: true,
      “holds”: [] // Lists current holds on an individual’s account.
    }

4.5.2. Retrieve Holds by Account and Subaccount/Suffix

Provides a list of all holds for a specific subaccount.

  • POST Method:
    • URL: https://{URL_ADDRESS}/api/suffix/holds/info
    • JSON Body Attributes:
      • accountNumber (Required, Number): Member account number.
      • suffixNumber (Required, Number): Share account subaccount/suffix value.
  • Response Object (holds):
    {
      “success”: true,
      “holds”: [] // Lists current holds on an individual’s account.
    }

5. Object References (Detailed Attributes)

5.1. stoppedPayments (Stopped Payment Retrieval Response Object)

  • Attributes: accountNumber, suffix, draftNumber, sequenceNumber, amount, releaseDate, enteredDate, reason, memberName, draftNumberFrom, draftNumberTo.

5.2. Stop Payment Request Object

  • Attributes: accountNumber, suffix, draftNumberFrom, draftNumberTo, amount (or stopPaymentAmount), sequenceNumber, enteredDate (or startDate), releaseDate (or expirationDate), reason, chargeFee, setupFee, feeSuffix, printNotice.

5.3. holds

  • Attributes: id, accountNumber, suffix, daysToHold, draftNumber, reason, location, dateOfHold, amount, timeOfHold, holdReleaseDate.

6. FLEX Validation Checks Included in HTTPS Status Code 500 Error

Flex provides additional information in 500 HTTP Status Code errors for troubleshooting. These errors often indicate invalid attribute values or missing configurations in the Credit Union’s database.

  • Common Error Messages (Examples):
    • “Internal server error – Fee Suffix must be entered”: When feeSuffix is missing or zero when chargeFee is true.
    • “Internal server error Account 8989891 does not exist”: Invalid account number in the request.
    • “Account Number must be entered”: Account number is zero or empty.
    • “Internal server error – Failed to setup stop payments”: Missing or invalid attribute values in the JSON Body.
    • “Internal server error – java.lang.RuntimeException: reason cannot exceed 20 characters”: Stop Payment reason exceeds 20 characters.
    • “Internal server error – Suffix number 155 does not exist for account 89891”: Invalid suffix number for the member account.
    • “Draft Number From or Draft Number To must be entered”: Both draftNumberFrom and draftNumberTo are zero.
    • “javax.persistence. PersistenceException: org.hibernate.exception.SQLGrammarException: could not execute query”: Incorrect data values or values too large for the field (e.g., account number > 9 characters, suffix/subaccount > 3 characters).
  • Troubleshooting Tip: Provide the exact error message to your Credit Union’s Flex support for efficient troubleshooting. They are typically familiar with these messages and how to correct the underlying data.