Error Handling

Lynx uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate a success. Codes in the 4xx range indicate an error and the information for the cause of failure is provided (e.g. "Required parameter was omitted", "Charge failed", etc.). Codes in the 5xx range indicate internal server errors.
An exception contains a title and the HTTP status code with one or more of the following:

The exceptionSource is populated with the following values:

• JSON - Errors arising from validations of input requests
• PARAMETER - Errors arising due to invalid or missing request parameters
• SYSTEM - Errors arising from processing a request

Note that the errorCode field is populated only in the case when exceptionSource is SYSTEM and the HTTP status code is 400. In all other cases the errorCode is an empty string.

A sample error response SYSTEM is listed below (note that the HTTP status would have been 400):

{
	"data": null,
	"exceptions": [
			{
				"errorCode": "GBL-100",
				"exceptionSource": "SYSTEM",
				"exceptionMessage": "ClientOrg is in Inactive state for name: XYZ"
			}
    ]
}

The Lynx Platform adheres to the principles of idempotency by implementing Lynx idempotency keys. You should retry requests that previously returned a '500' status, with the same idempotency key and the same parameters until they’re able to receive a result from the server; doing so will allow retries without the risk of unintended duplicate processing.

The complete list of error codes is as follows:

• GBL-100 Duplicate clientMemberId: [%s] cannot be enrolled
• GBL-101 Duplicate SSN: [%s] cannot be enrolled
• GBL-102 Client org not enrolled in requested member products: [%s]
• GBL-103 One phone number must be designated as primary
• GBL-104 One email must be designated as primary
• GBL-105 One address must be designated as primary
• GBL-106 Unsupported product type. At the moment we only support: [%s]
• GBL-107 ClientOrg name [%s] must be a parent node to both the source ClientOrg [%s] and destination ClientOrg [%s]
• GBL-108 DestinationClientOrg: [%s] does not have a parent client org
• GBL-109 ClientMemberId: [%s] already exists on destinationClientOrg: [%s]
• GBL-110 Product type: [%s] could not be found on the destination client org: [%s]
• GBL-114 You can't delete a primary address for clientMemberId=[%s], clientOrgName=[%s], addressId=[%s]
• GBL-115 You can't delete a primary phone for clientMemberId=[%s], clientOrgName=[%s], phoneType=[%s]
• GBL-116 You can't delete a primary email for clientMemberId=[%s], clientOrgName=[%s], emailType=[%s]
• GBL-117 Member cannot be deleted if not enrolled in the INCENTIVE product. [%s]
• GBL-118 Member cannot be deleted if balance is not 0. [%s]
• GBL-119 Member cannot be deleted if enrolled in multiple products. [%s]
• GBL-120 Member status already in requested status: Inactive
• GBL-121 Member status already in requested status: Active
• GBL-122 Cannot change status of member from current status [%s]
• GBL-123 Unsuccessful link token create request to plaid with status: [%s], and message: [%s]
• GBL-124 Card must be frozen in order to unfreeze it.
• GBL-125 Card with cardProxy: {%s}, clientOrgName {%s}, clientMemberId {%s} and status of: {%s} cannot be activated
• GBL-126 Card cannot be reported lost/stolen due to current status
• GBL-128 Card cannot be replaced due to current status
• GBL-133 There are Insufficient Funds in the Account ending with [%s]
• GBL-134 ClientOrg is in Inactive state for name: [%s]
• GBL-135 Insufficient funds. Your current available balance is: [%s]
• GBL-136 endpoint supported for HSA products only
• GBL-137 A tag already exists with the same name in the database: [%s]
• GBL-138 Member must be enrolled in the [%s] product before enrolling in the [%s] product
• GBL-139 Client Org: [%s] does not allow member enrollments
• GBL-140 %s: cannot be updated due to KYC completion
• GBL-141 No incentive ratio is configured for clientMemberId: [%s]
• GBL-142 ClientMemberId: %s cannot be enrolled until all required member information is updated on the existing member: %s
• GBL-144 ClientOrg: [%s] is not configured to use incentive ratio for the product [%s].
• GBL-145 Client Org Contact already exists with the same ssn: [%s]
• GBL-146 Member product effective date cannot be in the past. [%s]
• GBL-147 Primary Client Org Contact already exists
• GBL-148 Duplicate primary Client Org contacts
• GBL-149 Instrument [%s] is not on the approved list of investments
• GBL-150 You are required to maintain a minimum balance of %s in your HSA to invest.
• GBL-151 You have insufficient funds in your HSA account to complete your order.
• GBL-152 Consent name: %s has already been accepted
• GBL-153 %s product(s) not supported for enrollment
• GBL-154 ClientMemberId: %s is already enrolled in requested product: %s
• GBL-155 Quantity cannot be specified for a BUY order
• GBL-156 Either quantity or amountCash is required for a SELL order
• GBL-157 Status cannot be updated as the account is not Active or Closed
• GBL-158 relatedProductName is required and must have an associated account of type [%s]
• GBL-159 Country = %s is not eligible for Tax Treaty
• GBL-160 Member product effective date cannot be in the past. [%s]
• GBL-161 Member account status cannot be updated for the requested product: [%s]
• GBL-162 Selected products cannot be stacked on a single card
• GBL-164 Card Package Name [%s] is not valid for the selected products. Valid Card Packages are: %s
• GBL-166 Status cannot be updated as the account is already in status: [%s]
• GBL-167 AcceptedIndicator must be true for Consent name: %s
• GBL-169 Card is not currently in a lost or stolen status and cannot be reissued
• GBL-170 Primary Client Org Contact already exists
• GBL-171 %s // <ErrorDescription from FIS response>
• GBL-172 Duplicate primary Client Org contacts
• GBL-173 Account is currently [%s]
• GBL-174 clientMemberId: [%s] is in Inactive state.
• GBL-175 Member [%s] could not be updated
• GBL-176 Card in [%s] status cannot be frozen for partnerCardId: [%s], clientMemberId: [%s], clientOrgName: [%s]
• GBL-177 Member Consent [%s] already exists for clientMemberId: [%s] and clientOrgName: [%s]
• GBL-178 US taxpayer indicator must be true for the existing member when country of citizenship is USA
• GBL-179 Member Account is already in [%s] status
• GBL-180 A new card has already been created for the dependent
• GBL_181 Orders may only be placed on open accounts
• GBL-184 FBO Contribution account is not for [%s] Product, therefore the request can not be submitted
• GBL-185 Endpoint is not supported for member’s card
• GBL-186 Cards may only be requested for Dependents
• GBL-187 Incorrect number of beneficiary-related person(s). Please include all related persons with type = beneficiary and beneficiary type = %s in the request.
• GBL-188 Contribution would cause the Account to exceed the IRS HSA Contribution Limit [%s] for Tax Year [%s]. Tax Year [%s] contributions amount to [%s]
• GBL-190 Member contributions are not allowed for account type [%s]
• GBL-191 Member reimbursements are not allowed for account type [%s]
• GBL-198 Allocation percentage is [%s]%%. Please allocate to 100%% to update allocation(s).
• GBL-199 Member account has no effective date
• GBL-200 [%s] are not allowed for member accounts with future dated effective date: [%s]
• GBL-201 Cannot contribute to previous tax year beyond cutoff date
• GBL-202 Invalid value – cannot be zero or negative
• GBL-203 Contribution date cannot be in the past.
• GBL-204 Invalid taxYear [%s]. Allowed values are [%s], [%s]
• GBL-205 A processor token is required for transfer from external bank account.
• GBL-206 Invalid amount value - must be [%s] decimals.
• GBL-207 Member must be 18 years or older to enroll in [%s].
• GBL-208 Card cannot be closed due to current status
• GBL-209 [%s] does not allow [%s] enrollments for [%s] products.
• GBL-210 The following [%s] are invalid or could not be found: %s. Please note that all other commodities have been added/removed as requested.
• GBL-211 Allowed statuses that can be set for MemberCard are [Closed,Active,Lost,Frozen,Unfreeze,Stolen]
• GBL-212 You cannot set card status to [%s] when the card status is [%s]
• GBL-213 ClientOrg: [%s] is not configured to allow ACH pulls
• GBL-214 clientOrgExternalBankAccountId: [%s] is not authorized for ACH pull
• GBL-215 Transaction amount must be greater than $1
• GBL-216 Contribution amount greater than $[%s] is not allowed
• GBL-217 SKU %s is already in member's cart.
• GBL-218 Routing number could not be verified
• GBL-219 Member's cart is empty
• GBL-220 Total order amount [%s] exceeds amount requested [%s].
• GBL-221 Unable to order, item [%s] is not in stock.
• GBL-222 Client org must be enrolled in ECOMMERCE product to access this API
• GBL-223 originatingClientOrgAccountId [%s] is not an allowable originating account type for book transfers
• GBL-224 receivingClientOrgAccountId [%s] is not an allowable receiving account type for book transfers
• GBL-225 Book transfers between client orgs are not allowed
• GBL-226 originatingClientOrgAccountId and receivingClientOrgAccountId values cannot be the same
• GBL-227 Card in [%s] status cannot be updated to [%s] for partnerCardId: [%s], clientMemberId: [%s], clientOrgName: [%s]
• GBL-228 [%s] is already included in the exclusion list or could not be found: %s. Please note that all other commodities have been added/removed as requested.
• GBL-229 Amount requested [%s] exceeds the total order amount [%s].
• GBL-230 There was an issue with your request, please try again.
• GBL-231 Unable to request refund for item's that are not in shipped or delivered status.
• GBL-232 Unable to request refund for items that were ordered over %s days ago.
• GBL-234 No item found with SKU: [%s] in order: [%s]
• GBL-235 Quantity requested [%s] exceeds the quantity ordered [%s]
• GBL-237 Member's account must be in Active status to process a refund.
• GBL-238 Unable to process refund. Item has already had a refund requested.
• GBL-239 Claim amount request [%s] exceeds available balance [%s].
• GBL-240 Cannot process claim reimbursement via ACH, member doesn't have a linked external account.
• GBL-241 Date Trigger cannot be null when Trigger Type is Scheduled
• GBL-242 Event Name cannot be null when Trigger Type is Event
• GBL-243 Date must be in future
• GBL-244 Recipient Type Account cannot be null when Recipient Type is Account Type
• GBL-247 Approval amount exceeds Claim Amount
• GBL-248 Claim Status needs to be Approved in order to set a approvalAmount
• GBL-249 SKU [%s] is out of stock. Please remove from cart and retry the request.
• GBL-250 Unable to update Member Claim in [%s] status
• GBL-252 SKU [%s] not found for the requested Catalog [%s]
• GBL-253 The catalog name [%s] is already in use, please resubmit with unique name.
• GBL-254 receivingClientOrgAccountId [%s] is not an allowable receiving account type from originatingClientOrgAccountId [%s]
• GBL-255 ClientOrgConfigurationNotification with name [%s] already exists for this clientOrg: [%s]
• GBL-256 Frequency of type OneTime, Weekly, Monthly can only be set for ClientOrgConfigurationNotification with Trigger Scheduled
• GBL-257 Adhoc Notification firing not supported for [%s]
• GBL-258 Member account cannot be closed with a negative balance
• GBL-259 Member account cannot be closed with an active Investment account
• GBL-260 Member must authorize the account to be closed since this is a member-owned account
• GBL-261 Invalid product configuration
• GBL-262 Member account cannot be closed as member does not have a linked external account
• GBL-263 Frequency is required for trigger type Scheduled or Event
• GBL-264 Frequency of type EachTrigger is only supported for Trigger type Event
• GBL-265 Event Type [%s] is not supported for notification
• GBL-267 ClientOrgNotificationConfiguration with name [%s] already exists in clientorg [%s]
• GBL-271 Member account cannot be closed as member does not have a linked external account
• GBL-273 Sales Tax must be calculated before placing a member order
• GBL-274 Cannot add to the Exclusion List, invalid exclusion type: %s
• GBL-275 Only files with type %s are supported
• GBL-276 File size exceeds the max limit of [%s]mb
• GBL-277 Unable to validate file, please try again
• GBL-278 Expense date cannot be a future Date
• GBL-279 Invalid claim amount
• GBL-280 Claims cannot be submitted against ADVISORY account
• GBL-282 No clientOrgApplication with [%s] partner org was found for client org: [%s]
• GBL-283 [%s] are not allowed for member accounts that have expired: [%s]
• GBL-284 Approved amount is required for approving this claim
• GBL-285 Field could not be updated as requested value already exists: [%s]
• GBL-289 Invalid field. Unable to search by [%s]
• GBL_290 Member product is already effective and new effective date cannot be set
• GBL-291 Member Account is not configured for type = [%s]
• GBL-292 Amount [%s] is greater than the product_funding_configuration
• GBL-293 Client Org is not configured for this transaction type [%s]
• GBL-294 Claim reimbursement via ACH requires an external account.
• GBL-295 Unable to void transaction, nightly settlement has already occurred.
• GBL-296 The service amount does not match the price of the service
• GBL-297 Member product is not currently active: [%s]
• GBL-298 Member enrollment cannot be updated when there are no active products
• GBL-299 The sum of amounts from member account and externalCard must be equal to the service amount
• GBL-300 No purse has been configured for the new product effective date
• GBL-301 Funding configuration not found for product: [%s] in year: [%s]
• GBL-600 siteConnectionActive is false
• GBL-602 Member: [%s] not registered to Product: [%s]
• GBL-603 We may be experiencing a high volume of traffic. Please try again after a brief wait period
• GBL-604 Member cannot be deleted if the member has a product with multiple accounts for the same account type. [%s]