Accounts

openapi: 3.0.1 info: title: Symitar in Platform API - Accounts version: v1 description: API to interact with Symitar in Platform contact: name: Picard url: https://www.jackhenry.com/ email: DC-Picard-Product@jackhenry.com servers: - url: https://platform.banno.com description: Production Endpoint components: securitySchemes: OpenIDEnterprise: type: openIdConnect openIdConnectUrl: https://login.jackhenry.com/.well-known/openid-configuration description: "Jack Henry Enterprise Authentication. \n\n ### Supported Flows\n \n #### 1. Authorization Code Flow\n * **Use Case:** Person-at-keyboard logins (FI or JH Employees).\n * **Security:** Supports/recommends PKCE (S256). Supports Pushed Authorization Requests (PAR), and DPoP token binding.\n * **Client Auth:** Supports/recommends `client_assertion` (Private Key JWT), also supports `client_secret`.\n \n #### 2. Client Credentials Flow\n * **Use Case:** System services and machine-to-machine integrations.\n * **Security:** Supports DPoP token binding.\n * **Client Auth:** **Requires** `client_assertion` (Private Key JWT).\n" OpenIDConsumer: type: openIdConnect openIdConnectUrl: https://digital.garden-fi.com/.well-known/openid-configuration description: "Jack Henry Consumer Authentication. \n\n> **WARNING: FI-SPECIFIC ROUTING**\n> The authorization server is currently pointing to our **Sandbox Environment** (`digital.garden-fi.com`) so you can test this documentation. In production code, this domain **must** be replaced with the specific Financial Institution's domain.\n> Example: Replace `{API-ENVIRONMENT}` in `https://{API-ENVIRONMENT}/.well-known/openid-configuration` with `digital.garden-fi.com` for the Garden financial institution.\n\n### Supported Flows\n\n#### 1. Authorization Code Flow\n* **Use Case:** Person-at-keyboard logins (customer or member of FI).\n* **Security:** Supports/recommends PKCE (S256). Supports Pushed Authorization Requests (PAR), and DPoP token binding.\n* **Client Auth:** Supports `client_secret`.\n" tags: - name: Accounts description: Account search operations paths: /a/api/picard/v1/{InstitutionUniversalId}/accounts-search: post: operationId: findAccountBy tags: - Accounts summary: Find Account By… description: | Finds accounts using exactly one search criterion. Supply exactly one of the following fields in the request body; providing zero or more than one is a 400 error. <table> <thead><tr><th>Field</th><th>Looks up by</th><th>Returns</th></tr></thead> <tbody> <tr><td><code>shortName</code></td><td>the account's short name</td><td>one account</td></tr> <tr><td><code>accountNumber</code></td><td>10-digit account number</td><td>one account</td></tr> <tr><td><code>activeCardNumber</code></td><td>Active card number (≤ 30 chars)</td><td>one account</td></tr> <tr><td><code>anyCardNumber</code></td><td>Card number, active or inactive (≤ 30 chars)</td><td>one or more</td></tr> <tr><td><code>homeUser</code></td><td>Home banking username (≤ 20 chars)</td><td>one account</td></tr> <tr><td><code>lookupType</code> + <code>lookupNumber</code></td><td>Lookup type code + number (both required together)</td><td>one account</td></tr> <tr><td><code>micr</code></td><td>MICR line (≤ 22 chars); <code>draft</code> optional</td><td>one account</td></tr> </tbody> </table> Each response includes `shares`, `loans`, `cards`, and `preferences` arrays. This endpoint omits balance-bearing fields from `shares` and `loans`. Share/loan `account` metadata includes `currentRelationshipCode` when provided by SymXchange (`currentRelationshipCode` is also resolved to `currentRelationshipName` using the institution's Relationship Code Description parameter). `negativeBalanceDate` is share-only — SymXchange does not define it on loans, so it is omitted from `loans[].account`. Warning codes (`accountWarnings`, `shareWarnings`, `cardWarnings`) are enriched with human-readable descriptions and privilege flags — Inquiry (IQ), File Maintenance (FM), Transaction (TR) from the institution's Parameter configuration. Loans carry `accountWarnings` and `loanWarnings` on the same basis. See the `WarningDetail` schema for details. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object description: | Request body for `POST /accounts-search` and `POST /accounts-search-with-balances`. Supply **exactly one** of the following search fields. Providing zero fields or more than one is a 400 error. properties: shortName: type: string description: Short name nullable: true example: Husband accountNumber: type: string description: | 10-digit account number (not the 17-digit member record number). Use the `accountNumber` field from a `ShareInfo` or `LoanInfo` response. nullable: true example: 0000379758 activeCardNumber: type: string description: Active card number (up to 30 characters). Returns a single account. nullable: true maxLength: 30 example: '4111111111111111' anyCardNumber: type: string description: | Card number, active or inactive (up to 30 characters). May return multiple accounts. nullable: true maxLength: 30 example: '4111111111111111' homeUser: type: string description: Home banking username (up to 20 characters). Returns a single account. nullable: true maxLength: 20 example: jsmith lookupType: type: integer description: | Lookup type code (0–99). Must be provided together with `lookupNumber`. nullable: true minimum: 0 maximum: 99 example: 1 lookupNumber: type: string description: | Lookup number (up to 20 characters). Must be provided together with `lookupType`. nullable: true maxLength: 20 example: '123456789' micr: type: string description: MICR line (up to 22 characters). `draft` is optional. nullable: true maxLength: 22 example: '021000021' draft: type: string description: Draft/check number (up to 10 characters). Only used alongside `micr`. nullable: true maxLength: 10 example: '1234' responses: '200': description: Successful response content: application/json: schema: type: object description: | Response for `accounts-search`, `members-search`, and `loans-search`. Always returns all arrays; each will be empty (`[]`) if no results were found. required: - shares - loans - cards - notes - preferences properties: shares: type: array description: Share (deposit) accounts belonging to the member items: type: object description: Share (deposit) account information with relationships required: - account - eligibleForWires - accountStatus - standardAnalysis - relationships - isMicr - notes - accountWarnings - shareWarnings properties: account: type: object description: Account identifier required: - accountId properties: accountId: type: string description: Account ID (alphanumeric, 1-34 characters) minLength: 1 maxLength: 34 pattern: ^[a-zA-Z0-9]+$ example: S1234560001 restrict: type: integer description: Symitar account restriction code currentRelationshipCode: type: integer description: Symitar CURRENTRELATIONSHIPCODE value for the parent account nullable: true currentRelationshipName: type: string description: Institution-configured description for `currentRelationshipCode`, resolved from the Symitar Relationship Code Description parameter. Omitted when the code has no configured description or the parameter lookup is unavailable. example: Premier Member negativeBalanceDate: type: string description: Symitar NEGATIVEBALANCEDATE value from the share record. SymXchange only defines this field on shares, so it is omitted for loans. nullable: true accountNumber: type: string description: 10-digit account number, usable as the {accountNumber} path parameter in the transactions endpoint nullable: true example: 0000379758 shareId: type: string description: Share ID, usable as the {shareId} path parameter in the transactions endpoint nullable: true example: '0000' balance: type: string description: Account balance example: '1234.56' availableBalance: type: string description: Available balance example: '1200.00' eligibleForWires: type: boolean description: Whether account is eligible for wire transfers accountStatus: type: string description: Account status (Active/Closed) enum: - Active - Closed standardAnalysis: type: boolean description: Whether standard analysis is available relationships: type: array description: Account relationships items: type: object description: Account relationship identity/role information returned from SymX name records. Postal address data is not included. required: - memberName - relationshipCode properties: memberName: type: string description: Name of the related member memberRecordNumber: type: string description: 17-digit member record number, usable as the {memberRecordNumber} path parameter in GET /members/{memberRecordNumber} nullable: true example: '20190510000000000' relationshipCode: type: string description: Type of relationship enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Power of attorney - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only nullable: true isMicr: type: boolean description: Whether this is a MICR account accountByMicr: type: object allOf: - type: object description: Account identifier required: - accountId properties: accountId: type: string description: Account ID (alphanumeric, 1-34 characters) minLength: 1 maxLength: 34 pattern: ^[a-zA-Z0-9]+$ example: S1234560001 restrict: type: integer description: Symitar account restriction code currentRelationshipCode: type: integer description: Symitar CURRENTRELATIONSHIPCODE value for the parent account nullable: true currentRelationshipName: type: string description: Institution-configured description for `currentRelationshipCode`, resolved from the Symitar Relationship Code Description parameter. Omitted when the code has no configured description or the parameter lookup is unavailable. example: Premier Member negativeBalanceDate: type: string description: Symitar NEGATIVEBALANCEDATE value from the share record. SymXchange only defines this field on shares, so it is omitted for loans. nullable: true nullable: true description: type: string description: Share description (e.g. "REGULAR SHARES") nullable: true example: REGULAR SHARES shareType: type: string description: Share type code nullable: true shareCode: type: string description: Share account type (e.g. "Share", "Draft", "Certificate", "Club") nullable: true branch: type: string description: Branch number for the share nullable: true openDate: type: string description: Share open date (YYYY-MM-DD) nullable: true example: '2017-01-28' closeDate: type: string description: Share close date (YYYY-MM-DD) nullable: true nickname: type: string description: Share nickname nullable: true micrAcctNumber: type: string description: MICR account number nullable: true example: '100000000379758' activityDate: type: string description: Last activity date (YYYY-MM-DD) nullable: true recordChangeDate: type: string description: Record change date (YYYY-MM-DD) nullable: true lastFmDate: type: string description: Last FM date (YYYY-MM-DD) nullable: true lastPurgeDate: type: string description: Last purge date (YYYY-MM-DD) nullable: true lastTranDate: type: string description: Last transaction date (YYYY-MM-DD) nullable: true createdAtBranch: type: string description: Branch where the share was created nullable: true createdByUser: type: string description: User who created the share nullable: true minimumBalance: type: string description: Minimum balance nullable: true minimumDeposit: type: string description: Minimum deposit amount nullable: true minimumWithdrawal: type: string description: Minimum withdrawal amount nullable: true originalBalance: type: string description: Original balance nullable: true originalDeposit: type: string description: Original deposit amount nullable: true originalDepositDate: type: string description: Original deposit date (YYYY-MM-DD) nullable: true yearEndBalance: type: string description: Year-end balance nullable: true ledgerAccrual: type: string description: Ledger accrual amount nullable: true loanPaymentHold: type: string description: Loan payment hold amount nullable: true chargeOffAmount: type: string description: Charge-off amount nullable: true chargeOffType: type: string description: Charge-off type code nullable: true chargeOffDate: type: string description: Charge-off date (YYYY-MM-DD) nullable: true divRate: type: string description: Dividend rate nullable: true divType: type: string description: Dividend type code nullable: true divPostCode: type: string description: Dividend post code nullable: true divYtd: type: string description: Dividends year-to-date nullable: true divLastYear: type: string description: Dividends last year nullable: true divFromOpen: type: string description: Total dividends from open nullable: true divAccrual: type: string description: Dividend accrual amount nullable: true divAccrualDate: type: string description: Dividend accrual date (YYYY-MM-DD) nullable: true divPeriodStart: type: string description: Dividend period start date (YYYY-MM-DD) nullable: true dividendDue: type: string description: Dividend due amount nullable: true lastDivAmount: type: string description: Last dividend amount nullable: true lastDivDate: type: string description: Last dividend date (YYYY-MM-DD) nullable: true currDivPayable: type: string description: Current dividend payable nullable: true currMonthPaidDiv: type: string description: Current month paid dividend nullable: true divDisbUpdtActvtyD: type: string description: Dividend disbursement update activity date flag nullable: true dividendRateMargin: type: string description: Dividend rate margin nullable: true dividendRateMarginSign: type: string description: Dividend rate margin sign nullable: true dividendRateMax: type: string description: Dividend rate maximum nullable: true dividendRateMin: type: string description: Dividend rate minimum nullable: true dividendRatePeriodFreq: type: string description: Dividend rate period frequency nullable: true bondIntLastYear: type: string description: Bond interest last year nullable: true bondIntYtd: type: string description: Bond interest year-to-date nullable: true cddivAccrLastYr: type: string description: CD dividend accrued last year nullable: true cddivAccrYtd: type: string description: CD dividend accrued year-to-date nullable: true mcDivLastYear: type: string description: Money-center dividend last year nullable: true mcDivYtd: type: string description: Money-center dividend year-to-date nullable: true mtdAccruedDivs: type: string description: Month-to-date accrued dividends nullable: true mtdEarnedDivs: type: string description: Month-to-date earned dividends nullable: true mtdPaidDivs: type: string description: Month-to-date paid dividends nullable: true mtdPriorRateAccrual: type: string description: Month-to-date prior rate accrual nullable: true divPeriodBalDays: type: string description: Dividend period balance days nullable: true statementDate: type: string description: Statement date (YYYY-MM-DD) nullable: true statementPrevDate: type: string description: Previous statement date (YYYY-MM-DD) nullable: true statementGroup: type: string description: Statement group code nullable: true statementMailCode: type: string description: Statement mail code nullable: true termFrequency: type: string description: Term frequency code nullable: true termPeriod: type: string description: Term period nullable: true maturityPostCode: type: string description: Maturity post code nullable: true renewShareType: type: string description: Renewal share type nullable: true renewTermFreq: type: string description: Renewal term frequency nullable: true renewTermPeriod: type: string description: Renewal term period nullable: true bumpRate: type: string description: Bump rate nullable: true periodicCap: type: string description: Periodic cap nullable: true periodicStartRate: type: string description: Periodic start rate nullable: true regDCheckCount: type: string description: Regulation D check count nullable: true regDTransferCount: type: string description: Regulation D transfer count nullable: true regDCtrStartDay: type: string description: Regulation D counter start day nullable: true regECount: type: string description: Regulation E count nullable: true overdraftTolerance: type: string description: Overdraft tolerance amount nullable: true overdraftFeeLastYr: type: string description: Overdraft fee last year nullable: true overdraftFeeYtd: type: string description: Overdraft fee year-to-date nullable: true withdrawalCount: type: string description: Withdrawal count nullable: true withdrawalLimit: type: string description: Withdrawal limit nullable: true withdrawalFeeCount: type: string description: Withdrawal fee count nullable: true withdrawalFeeType: type: string description: Withdrawal fee type nullable: true withdrawnFromOpen: type: string description: Total withdrawn from open nullable: true penaltyLastYear: type: string description: Penalty last year nullable: true penaltyYtd: type: string description: Penalty year-to-date nullable: true penaltyType: type: string description: Penalty type code nullable: true withholdingCode: type: string description: Withholding code nullable: true withholdingLastYear: type: string description: Withholding last year nullable: true withholdingYtd: type: string description: Withholding year-to-date nullable: true stateWithholdingCode: type: string description: State withholding code nullable: true stateWithholdingLastQtr: type: string description: State withholding last quarter nullable: true stateWithholdingLastYear: type: string description: State withholding last year nullable: true stateWithholdingQtd: type: string description: State withholding quarter-to-date nullable: true stateWithholdingYtd: type: string description: State withholding year-to-date nullable: true chapter4WithheldLstYr: type: string description: Chapter 4 withheld last year nullable: true chapter4WithheldYtd: type: string description: Chapter 4 withheld year-to-date nullable: true chapter4WithholdingCode: type: string description: Chapter 4 withholding code nullable: true insuranceMaximum: type: string description: Insurance maximum amount nullable: true insuranceType: type: string description: Insurance type code nullable: true irsCode: type: string description: IRS code nullable: true irsPlan: type: string description: IRS plan code nullable: true irs1042SUfid: type: string description: IRS 1042-S UFID nullable: true escrowLastYear: type: string description: Escrow last year nullable: true escrowYtd: type: string description: Escrow year-to-date nullable: true nsfLastYear: type: string description: NSF count last year nullable: true nsfMonthToDate: type: string description: NSF count month-to-date nullable: true nsfYtd: type: string description: NSF count year-to-date nullable: true nsfFeeLy: type: string description: NSF fee count last year nullable: true nsfFeeMtd: type: string description: NSF fee count month-to-date nullable: true nsfFeeYtd: type: string description: NSF fee count year-to-date nullable: true courtesyPayLastYear: type: string description: Courtesy pay count last year nullable: true courtesyPayMonthToDate: type: string description: Courtesy pay count month-to-date nullable: true courtesyPayYtd: type: string description: Courtesy pay count year-to-date nullable: true courtesyFeeLy: type: string description: Courtesy fee count last year nullable: true courtesyFeeMtd: type: string description: Courtesy fee count month-to-date nullable: true courtesyFeeYtd: type: string description: Courtesy fee count year-to-date nullable: true cappedFeesAmountCap: type: string description: Capped fees amount cap nullable: true cappedFeesAmtPeriod: type: string description: Capped fees amount period nullable: true cappedFeesCntPeriod: type: string description: Capped fees count period nullable: true cappedFeesCountCap: type: string description: Capped fees count cap nullable: true feeExemptCrtsyBal: type: string description: Fee exempt courtesy balance nullable: true unpaidFeeLastYear: type: string description: Unpaid fee last year nullable: true unpaidFeeYtd: type: string description: Unpaid fee year-to-date nullable: true corporateUserTransferCode: type: string description: Corporate user transfer code nullable: true memberUserTransferCode: type: string description: Member user transfer code nullable: true memberBranchSupport: type: string description: Member branch support code nullable: true xfrLastYear: type: string description: Transfers last year nullable: true xfrMonthToDate: type: string description: Transfers month-to-date nullable: true xfrYtd: type: string description: Transfers year-to-date nullable: true sweepBalanceType: type: string description: Sweep balance type nullable: true sweepPriority: type: string description: Sweep priority nullable: true sweepTargetMaximum: type: string description: Sweep target maximum nullable: true sweepTargetMinimum: type: string description: Sweep target minimum nullable: true extAchXfrDailyLimitIn: type: string description: External ACH transfer daily limit inbound nullable: true extAchXfrDailyLimitOut: type: string description: External ACH transfer daily limit outbound nullable: true creditReportLastStatus: type: string description: Credit report last status nullable: true creditReportOriginalAmountRptd: type: string description: Credit report original amount reported nullable: true creditReportingCode: type: string description: Credit reporting code nullable: true amortizationSchd: type: string description: Amortization schedule code nullable: true amortizationSchdType: type: string description: Amortization schedule type nullable: true analysisPmtIdType: type: string description: Analysis payment ID type nullable: true callItemSchd: type: string description: Call item schedule nullable: true callItemSchdType: type: string description: Call item schedule type nullable: true cuTotalsUseCode: type: string description: CU totals use code nullable: true lastDirectDepAmt: type: string description: Last direct deposit amount nullable: true negativeBalanceNoticeNumber: type: string description: Negative balance notice number nullable: true negativeBalanceNoticeType: type: string description: Negative balance notice type nullable: true positivePayDraft: type: string description: Positive pay draft flag nullable: true putItemSchd: type: string description: Put item schedule nullable: true putItemSchdType: type: string description: Put item schedule type nullable: true userAmount1: type: string description: User-defined amount 1 nullable: true userAmount2: type: string description: User-defined amount 2 nullable: true alternateNameLocator: type: string description: Alternate name locator nullable: true alternateNameType: type: string description: Alternate name type nullable: true payeeNameLocator: type: string description: Payee name locator nullable: true payeeNameType: type: string description: Payee name type nullable: true accountWarnings: type: array description: | Warning codes set at the **account** level in Symitar. Each entry includes the raw warning code and a human-readable description resolved from the institution's Parameter configuration. Each entry also includes three privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) that control what actions the warning allows. Up to 20 warning code slots exist per account. Only populated slots (code ≠ 0) are returned. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' shareWarnings: type: array description: | Warning codes set at the **share** level in Symitar. Same structure as `accountWarnings` but scoped to the individual share record. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' notes: type: array description: Share-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 loans: type: array description: Loan accounts belonging to the member items: type: object description: Loan account information with relationships required: - account - accountStatus - relationships - notes - accountWarnings - loanWarnings properties: account: type: object description: Account identifier required: - accountId properties: accountId: type: string description: Account ID (alphanumeric, 1-34 characters) minLength: 1 maxLength: 34 pattern: ^[a-zA-Z0-9]+$ example: S1234560001 restrict: type: integer description: Symitar account restriction code currentRelationshipCode: type: integer description: Symitar CURRENTRELATIONSHIPCODE value for the parent account nullable: true currentRelationshipName: type: string description: Institution-configured description for `currentRelationshipCode`, resolved from the Symitar Relationship Code Description parameter. Omitted when the code has no configured description or the parameter lookup is unavailable. example: Premier Member negativeBalanceDate: type: string description: Symitar NEGATIVEBALANCEDATE value from the share record. SymXchange only defines this field on shares, so it is omitted for loans. nullable: true accountNumber: type: string description: 10-digit account number nullable: true example: 0000379758 loanId: type: string description: Loan ID within the account nullable: true example: '0001' balance: type: string description: Loan balance (outstanding principal) example: '15000.00' accountStatus: type: string description: Loan status (Active/Closed) enum: - Active - Closed relationships: type: array description: Loan relationships (borrowers, co-signers, etc.) items: type: object description: Account relationship identity/role information returned from SymX name records. Postal address data is not included. required: - memberName - relationshipCode properties: memberName: type: string description: Name of the related member memberRecordNumber: type: string description: 17-digit member record number, usable as the {memberRecordNumber} path parameter in GET /members/{memberRecordNumber} nullable: true example: '20190510000000000' relationshipCode: type: string description: Type of relationship enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Power of attorney - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only nullable: true accountWarnings: type: array description: | Warning codes set at the **account** level in Symitar. Shared across all shares and loans on the account. Only populated slots (code ≠ 0) are returned, enriched with description and privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) from the institution's Parameter configuration. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' loanWarnings: type: array description: | Warning codes set at the **loan** level in Symitar. Scoped to this individual loan record. Same structure as `accountWarnings`. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' notes: type: array description: Loan-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 description: type: string description: Loan description (e.g. "AUTO LOAN") nullable: true example: AUTO LOAN loanType: type: string description: Loan type code nullable: true loanCode: type: string description: Raw loan code value from SymXchange nullable: true loanCodeName: type: string description: Human-readable loan account type name (e.g. "Closed end", "Open end", "Line of credit", "Credit card", "Lease") nullable: true branch: type: string description: Branch number for the loan nullable: true openDate: type: string description: Loan open date (YYYY-MM-DD) nullable: true example: '2022-03-15' closeDate: type: string description: Loan close date (YYYY-MM-DD) nullable: true nickname: type: string description: Loan nickname nullable: true activityDate: type: string description: Last activity date (YYYY-MM-DD) nullable: true recordChangeDate: type: string description: Record change date (YYYY-MM-DD) nullable: true lastFmDate: type: string description: Last FM date (YYYY-MM-DD) nullable: true lastTranDate: type: string description: Last transaction date (YYYY-MM-DD) nullable: true createdAtBranch: type: string description: Branch where the loan was created nullable: true createdByUser: type: string description: User who created the loan nullable: true originalBalance: type: string description: Original loan balance nullable: true creditLimit: type: string description: Credit limit (for LOC/credit card loans) nullable: true availableCredit: type: string description: Available credit remaining nullable: true payoffAmount: type: string description: Current payoff amount nullable: true pastDueAmount: type: string description: Past due amount nullable: true chargeOffAmount: type: string description: Charge-off amount nullable: true chargeOffType: type: string description: Charge-off type code nullable: true chargeOffDate: type: string description: Charge-off date (YYYY-MM-DD) nullable: true interestRate: type: string description: Current interest rate nullable: true example: '5.250' apr: type: string description: Annual percentage rate nullable: true interestYtd: type: string description: Interest paid year-to-date nullable: true interestLastYear: type: string description: Interest paid last year nullable: true intUnpaidBilled: type: string description: Unpaid billed interest nullable: true payment: type: string description: Regular payment amount nullable: true example: '350.00' paymentDue: type: string description: Current payment due amount nullable: true minimumPayment: type: string description: Minimum payment amount nullable: true dueDate: type: string description: Next due date (YYYY-MM-DD) nullable: true example: '2026-04-01' lastPaymentDate: type: string description: Last payment date (YYYY-MM-DD) nullable: true lastPaymentAmount: type: string description: Last payment amount nullable: true maturityDate: type: string description: Loan maturity date (YYYY-MM-DD) nullable: true example: '2028-03-15' cards: type: array description: Card records belonging to the member. Always present; empty array if there are no cards. items: type: object description: | Card record associated with a member account. Includes identity/status fields, issuance details, limits/counters, warning codes, sub-records (access list and cardholder names), and card-level notes. properties: accountNumber: type: string description: 10-digit account number the card belongs to nullable: true example: 0000379758 locator: type: string description: Symitar card locator number nullable: true accountWarnings: type: array description: Account-level warning codes enriched with descriptions and privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' cardWarnings: type: array description: Card-level warning codes enriched with descriptions and privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' description: type: string description: Card description nullable: true type: type: string description: Card type code nullable: true status: type: string description: Card status nullable: true statusReason: type: string description: Reason for the current card status nullable: true blockCode: type: string description: Block code restricting card usage nullable: true reclassCode: type: string description: Reclassification code nullable: true chkId: type: string description: Checking account ID linked to the card nullable: true creditCardId: type: string description: Credit card identifier nullable: true suffix: type: string description: Card suffix nullable: true nameType: type: string description: Name type code nullable: true locId: type: string description: Line of credit ID nullable: true savId: type: string description: Savings account ID linked to the card nullable: true activeDate: type: string description: Date the card was activated (YYYY-MM-DD) nullable: true closeDate: type: string description: Date the card was closed (YYYY-MM-DD) nullable: true effectiveDate: type: string description: Card effective date (YYYY-MM-DD) nullable: true issueDate: type: string description: Date the card was issued (YYYY-MM-DD) nullable: true lastAddrChgDate: type: string description: Date the card's address was last changed (YYYY-MM-DD) nullable: true recordChangeDate: type: string description: Date the card record was last modified (YYYY-MM-DD) nullable: true createdAtBranch: type: string description: Branch where the card was created nullable: true createdByUser: type: string description: User who created the card record nullable: true issueCode: type: string description: Issue code nullable: true reissueCode: type: string description: Reissue code nullable: true reissueMonths: type: string description: Number of months between automatic reissues nullable: true instantIssue: type: string description: Instant issue flag nullable: true onlineCardIssue: type: string description: Online card issue flag nullable: true onlineRushIssue: type: string description: Online rush issue flag nullable: true extraEmboss: type: string description: Extra embossing text nullable: true emvChipProfile: type: string description: EMV chip profile code nullable: true digitalIssueStatus: type: string description: Digital issuance status nullable: true digitalIssueExcept: type: string description: Digital issuance exception code nullable: true imageRefDate: type: string description: Image reference date nullable: true imageRefIssueCount: type: string description: Image reference issue count nullable: true imageRefNumber: type: string description: Image reference number nullable: true prevActivationDate: type: string description: Previous card activation date (YYYY-MM-DD) nullable: true limitAmount: type: string description: Overall card limit amount nullable: true limitDays: type: string description: Limit period in days nullable: true singleUsageMax: type: string description: Maximum single transaction amount nullable: true tempLimitStartDate: type: string description: Temporary limit start date (YYYY-MM-DD) nullable: true tempLimitEndDate: type: string description: Temporary limit end date (YYYY-MM-DD) nullable: true atmCount: type: string description: Current ATM transaction count nullable: true atmCountLimit: type: string description: ATM transaction count limit nullable: true atmTempLimit: type: string description: Temporary ATM limit nullable: true authAmount: type: string description: Current authorization amount nullable: true authCount: type: string description: Current authorization count nullable: true authCountLimit: type: string description: Authorization count limit nullable: true authLimit: type: string description: Authorization amount limit nullable: true authTempLimit: type: string description: Temporary authorization limit nullable: true billPayAmount: type: string description: Current bill pay amount nullable: true billPayCount: type: string description: Current bill pay count nullable: true billPayCountLimit: type: string description: Bill pay count limit nullable: true billPayLimit: type: string description: Bill pay amount limit nullable: true billPayMax: type: string description: Bill pay maximum amount nullable: true credDebAmount: type: string description: Current credit/debit amount nullable: true credDebCount: type: string description: Current credit/debit count nullable: true credDebCountLimit: type: string description: Credit/debit count limit nullable: true credDebLimit: type: string description: Credit/debit amount limit nullable: true depAmount: type: string description: Current deposit amount nullable: true depCount: type: string description: Current deposit count nullable: true depCountLimit: type: string description: Deposit count limit nullable: true depLimit: type: string description: Deposit amount limit nullable: true depMax: type: string description: Deposit maximum amount nullable: true miscAmount: type: string description: Current miscellaneous transaction amount nullable: true miscCount: type: string description: Current miscellaneous transaction count nullable: true miscCountLimit: type: string description: Miscellaneous transaction count limit nullable: true miscLimit: type: string description: Miscellaneous transaction amount limit nullable: true posAmount: type: string description: Current POS transaction amount nullable: true posCount: type: string description: Current POS transaction count nullable: true posCountLimit: type: string description: POS transaction count limit nullable: true posLimit: type: string description: POS transaction amount limit nullable: true posTempLimit: type: string description: Temporary POS limit nullable: true usageAmount: type: string description: Current usage amount nullable: true usageDate: type: string description: Last usage date nullable: true usageLimit: type: string description: Usage limit nullable: true wdCheckAmount: type: string description: Current withdrawal/check amount nullable: true wdCheckCount: type: string description: Current withdrawal/check count nullable: true wdCheckCountLimit: type: string description: Withdrawal/check count limit nullable: true wdCheckLimit: type: string description: Withdrawal/check amount limit nullable: true wdCheckMax: type: string description: Withdrawal/check maximum amount nullable: true xferAmount: type: string description: Current transfer amount nullable: true xferCount: type: string description: Current transfer count nullable: true xferCountLimit: type: string description: Transfer count limit nullable: true xferLimit: type: string description: Transfer amount limit nullable: true xferMax: type: string description: Transfer maximum amount nullable: true fileUpdateManagerException: type: string description: File update manager exception code nullable: true access: type: array description: Card access sub-records defining which accounts the card can access items: type: object description: Card access sub-record defining which account the card can access and what operations are permitted. properties: locator: type: string description: Access record locator nullable: true accessType: type: string description: Access type code nullable: true accountNumber: type: string description: Account number this access record links to nullable: true enableDeposit: type: string description: Whether deposits are enabled nullable: true enableFm: type: string description: Whether file maintenance is enabled nullable: true enableInquiry: type: string description: Whether inquiries are enabled nullable: true enableWithdrawal: type: string description: Whether withdrawals are enabled nullable: true extLoanAccount: type: string description: External loan account number nullable: true id: type: string description: Access record ID nullable: true idType: type: string description: Access record ID type nullable: true qualifier: type: string description: Access qualifier nullable: true recordChangeDate: type: string description: Date the access record was last modified (YYYY-MM-DD) nullable: true names: type: array description: Cardholder name sub-records items: type: object description: Cardholder name sub-record representing a name associated with the card. properties: locator: type: string description: Name record locator nullable: true type: type: string description: Name type code nullable: true subType: type: string description: Name sub-type code nullable: true first: type: string description: First name nullable: true middle: type: string description: Middle name nullable: true last: type: string description: Last name nullable: true suffix: type: string description: Name suffix nullable: true title: type: string description: Name title/prefix nullable: true shortName: type: string description: Short name nullable: true longName: type: string description: Long name (full name) nullable: true extendedName: type: string description: Extended name field nullable: true nameFormat: type: string description: Name format code nullable: true lateChargeAccrued: type: string description: Late charge accrued amount nullable: true lateChargeDate: type: string description: Late charge date (YYYY-MM-DD) nullable: true lateChargeDue: type: string description: Late charge due amount nullable: true lateChargeType: type: string description: Late charge type code nullable: true lateChargeUnpaid: type: string description: Late charge unpaid amount nullable: true lateChargeYtd: type: string description: Late charges year-to-date nullable: true lateChargeLastYear: type: string description: Late charges last year nullable: true statementDate: type: string description: Statement date (YYYY-MM-DD) nullable: true statementPrevDate: type: string description: Previous statement date (YYYY-MM-DD) nullable: true statementGroup: type: string description: Statement group code nullable: true statementMailCode: type: string description: Statement mail code nullable: true creditReportLastStatus: type: string description: Credit report last status nullable: true creditReportingCode: type: string description: Credit reporting code nullable: true accrualStatus: type: string description: Accrual status code nullable: true approvalCode: type: string description: Approval code nullable: true approvalDate: type: string description: Approval date (YYYY-MM-DD) nullable: true alternateNameLocator: type: string description: Alternate name locator nullable: true alternateNameType: type: string description: Alternate name type nullable: true notes: type: array description: Loan-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 notes: type: array description: Card-level notes/comments items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 notes: type: array description: Account-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 preferences: type: array description: Preference records belonging to the member. Always present; empty array if there are no preferences. items: type: object description: Preference record representing a member's home-banking preference settings. properties: accountNumber: type: string description: 10-digit account number the preference belongs to nullable: true depLimit: type: string description: Deposit limit nullable: true depMax: type: string description: Deposit maximum nullable: true hbEnable: type: string description: Whether home banking is enabled nullable: true hbUsername: type: string description: Home-banking username associated with the preference nullable: true lastLogonDate: type: string description: Date of last logon (YYYY-MM-DD) nullable: true lastLogonTime: type: string description: Time of last logon nullable: true lastTranDate: type: string description: Date of last transaction (YYYY-MM-DD) nullable: true locator: type: string description: Preference record locator nullable: true locked: type: string description: Whether the preference is locked nullable: true pwdResetDate: type: string description: Password reset date (YYYY-MM-DD) nullable: true wdCashLimit: type: string description: Withdrawal cash limit nullable: true wdCashMax: type: string description: Withdrawal cash maximum nullable: true wdCheckLimit: type: string description: Withdrawal check limit nullable: true wdCheckMax: type: string description: Withdrawal check maximum nullable: true xferLimit: type: string description: Transfer limit nullable: true xferMax: type: string description: Transfer maximum nullable: true access: type: array description: Preference access sub-records. Always present; empty array if there are no preference access records. items: type: object description: Preference access sub-record representing access settings for a preference. properties: locator: type: string description: Access record locator nullable: true accessType: type: string description: Access type code nullable: true accountNumber: type: string description: Account number for the access record nullable: true enableDeposit: type: string description: Whether deposit access is enabled nullable: true enableFm: type: string description: Whether file maintenance access is enabled nullable: true enableInquiry: type: string description: Whether inquiry access is enabled nullable: true enableWithdrawal: type: string description: Whether withdrawal access is enabled nullable: true extLoanAccount: type: string description: External loan account reference nullable: true id: type: string description: Share/loan ID the access record references nullable: true idType: type: string description: ID type (e.g. share or loan) nullable: true qualifier: type: string description: Access qualifier nullable: true recordChangeDate: type: string description: Date the access record was last modified (YYYY-MM-DD) nullable: true members: type: array description: 'Internal-route only (`/internal/v1/.../accounts-search`) name-record member fields from SymXchange, including SSN. Collected from every level that can hold a name: the account name list plus each share, loan and card name list. A joint held only on a share, loan or card is therefore still listed. Deduplicated by `memberNumber`, keeping the account-level record when the same person appears more than once.' items: type: object description: Member fields from Account Name records returned by SymXchange (internal accounts-search only). properties: activeDuty: type: string nullable: true addressType: type: string nullable: true beneficialOwner: type: string nullable: true beneficialPercent: type: string nullable: true beneficiaryPercent: type: string nullable: true chapter4StatusCode: type: string nullable: true confidential: type: string nullable: true crNameChgDate: type: string nullable: true ctrExempt: type: string nullable: true currGrossMonthPay: type: string nullable: true currNetMonthPay: type: string nullable: true dbaNameFormat: type: string nullable: true dbaShortName: type: string nullable: true ecoaCode: type: string nullable: true effectiveDate: type: string nullable: true expirationDate: type: string nullable: true firstName: type: string nullable: true description: First name formW8OnFile: type: string nullable: true headquarters: type: string nullable: true identDocFlags: type: array items: type: object properties: entryId: type: integer flag: type: integer identIdTypes: type: array items: type: object properties: entryId: type: integer type: type: integer irs1042SAmendNum: type: string nullable: true irsCorrection: type: string nullable: true last: type: string nullable: true lastAddrChgDate: type: string nullable: true locator: type: string nullable: true longName: type: string nullable: true mailOverride: type: string nullable: true marketingAddress: type: string nullable: true mbrAddrFileType: type: string nullable: true mbrCreateDate: type: string nullable: true mbrFileType: type: string nullable: true mbrFmLastDate: type: string nullable: true mbrRecordChangeDate: type: string nullable: true mbrStatus: type: string nullable: true mbrStatusFmDate: type: string nullable: true memberNumLink: type: string nullable: true memberNumLinkChgDate: type: string nullable: true memberNumber: type: string nullable: true middleName: type: string nullable: true description: Middle name; omitted when the member has no middle name mobilePhone: type: string nullable: true nameFormat: type: string nullable: true nraTaxRate: type: string nullable: true phoneType: type: string nullable: true preferredContact: type: string nullable: true preferredContactMethod: type: string nullable: true recordChangeDate: type: string nullable: true restrict: type: string nullable: true shortName: type: string nullable: true ssn: type: string nullable: true ssnCertification: type: string nullable: true ssnOverride: type: string nullable: true ssnType: type: string nullable: true subType: type: string nullable: true substantialOwner: type: string nullable: true suffix: type: string nullable: true description: Name suffix title: type: string nullable: true description: Name title/prefix type: type: string nullable: true usPersonFlag: type: string nullable: true userAmount1: type: string nullable: true userAmount2: type: string nullable: true '400': description: Bad request — zero or more than one search field provided content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/picard/v1/{InstitutionUniversalId}/accounts-search-with-balances: post: operationId: findAccountByWithBalances tags: - Accounts summary: Find Account By… (With Balances) description: | Same search behavior and request contract as `POST /accounts-search`, but returns the full balance-bearing account payload. Share/loan `account` metadata includes `currentRelationshipCode` when provided by SymXchange, plus `currentRelationshipName` resolved from the institution's Relationship Code Description parameter. `negativeBalanceDate` is share-only — SymXchange does not define it on loans, so it is omitted from `loans[].account`. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: required: true content: application/json: schema: type: object description: | Request body for `POST /accounts-search` and `POST /accounts-search-with-balances`. Supply **exactly one** of the following search fields. Providing zero fields or more than one is a 400 error. properties: shortName: type: string description: Short name nullable: true example: Husband accountNumber: type: string description: | 10-digit account number (not the 17-digit member record number). Use the `accountNumber` field from a `ShareInfo` or `LoanInfo` response. nullable: true example: 0000379758 activeCardNumber: type: string description: Active card number (up to 30 characters). Returns a single account. nullable: true maxLength: 30 example: '4111111111111111' anyCardNumber: type: string description: | Card number, active or inactive (up to 30 characters). May return multiple accounts. nullable: true maxLength: 30 example: '4111111111111111' homeUser: type: string description: Home banking username (up to 20 characters). Returns a single account. nullable: true maxLength: 20 example: jsmith lookupType: type: integer description: | Lookup type code (0–99). Must be provided together with `lookupNumber`. nullable: true minimum: 0 maximum: 99 example: 1 lookupNumber: type: string description: | Lookup number (up to 20 characters). Must be provided together with `lookupType`. nullable: true maxLength: 20 example: '123456789' micr: type: string description: MICR line (up to 22 characters). `draft` is optional. nullable: true maxLength: 22 example: '021000021' draft: type: string description: Draft/check number (up to 10 characters). Only used alongside `micr`. nullable: true maxLength: 10 example: '1234' responses: '200': description: Successful response content: application/json: schema: type: object description: | Response for `accounts-search`, `members-search`, and `loans-search`. Always returns all arrays; each will be empty (`[]`) if no results were found. required: - shares - loans - cards - notes - preferences properties: shares: type: array description: Share (deposit) accounts belonging to the member items: type: object description: Share (deposit) account information with relationships required: - account - eligibleForWires - accountStatus - standardAnalysis - relationships - isMicr - notes - accountWarnings - shareWarnings properties: account: type: object description: Account identifier required: - accountId properties: accountId: type: string description: Account ID (alphanumeric, 1-34 characters) minLength: 1 maxLength: 34 pattern: ^[a-zA-Z0-9]+$ example: S1234560001 restrict: type: integer description: Symitar account restriction code currentRelationshipCode: type: integer description: Symitar CURRENTRELATIONSHIPCODE value for the parent account nullable: true currentRelationshipName: type: string description: Institution-configured description for `currentRelationshipCode`, resolved from the Symitar Relationship Code Description parameter. Omitted when the code has no configured description or the parameter lookup is unavailable. example: Premier Member negativeBalanceDate: type: string description: Symitar NEGATIVEBALANCEDATE value from the share record. SymXchange only defines this field on shares, so it is omitted for loans. nullable: true accountNumber: type: string description: 10-digit account number, usable as the {accountNumber} path parameter in the transactions endpoint nullable: true example: 0000379758 shareId: type: string description: Share ID, usable as the {shareId} path parameter in the transactions endpoint nullable: true example: '0000' balance: type: string description: Account balance example: '1234.56' availableBalance: type: string description: Available balance example: '1200.00' eligibleForWires: type: boolean description: Whether account is eligible for wire transfers accountStatus: type: string description: Account status (Active/Closed) enum: - Active - Closed standardAnalysis: type: boolean description: Whether standard analysis is available relationships: type: array description: Account relationships items: type: object description: Account relationship identity/role information returned from SymX name records. Postal address data is not included. required: - memberName - relationshipCode properties: memberName: type: string description: Name of the related member memberRecordNumber: type: string description: 17-digit member record number, usable as the {memberRecordNumber} path parameter in GET /members/{memberRecordNumber} nullable: true example: '20190510000000000' relationshipCode: type: string description: Type of relationship enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Power of attorney - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only nullable: true isMicr: type: boolean description: Whether this is a MICR account accountByMicr: type: object allOf: - type: object description: Account identifier required: - accountId properties: accountId: type: string description: Account ID (alphanumeric, 1-34 characters) minLength: 1 maxLength: 34 pattern: ^[a-zA-Z0-9]+$ example: S1234560001 restrict: type: integer description: Symitar account restriction code currentRelationshipCode: type: integer description: Symitar CURRENTRELATIONSHIPCODE value for the parent account nullable: true currentRelationshipName: type: string description: Institution-configured description for `currentRelationshipCode`, resolved from the Symitar Relationship Code Description parameter. Omitted when the code has no configured description or the parameter lookup is unavailable. example: Premier Member negativeBalanceDate: type: string description: Symitar NEGATIVEBALANCEDATE value from the share record. SymXchange only defines this field on shares, so it is omitted for loans. nullable: true nullable: true description: type: string description: Share description (e.g. "REGULAR SHARES") nullable: true example: REGULAR SHARES shareType: type: string description: Share type code nullable: true shareCode: type: string description: Share account type (e.g. "Share", "Draft", "Certificate", "Club") nullable: true branch: type: string description: Branch number for the share nullable: true openDate: type: string description: Share open date (YYYY-MM-DD) nullable: true example: '2017-01-28' closeDate: type: string description: Share close date (YYYY-MM-DD) nullable: true nickname: type: string description: Share nickname nullable: true micrAcctNumber: type: string description: MICR account number nullable: true example: '100000000379758' activityDate: type: string description: Last activity date (YYYY-MM-DD) nullable: true recordChangeDate: type: string description: Record change date (YYYY-MM-DD) nullable: true lastFmDate: type: string description: Last FM date (YYYY-MM-DD) nullable: true lastPurgeDate: type: string description: Last purge date (YYYY-MM-DD) nullable: true lastTranDate: type: string description: Last transaction date (YYYY-MM-DD) nullable: true createdAtBranch: type: string description: Branch where the share was created nullable: true createdByUser: type: string description: User who created the share nullable: true minimumBalance: type: string description: Minimum balance nullable: true minimumDeposit: type: string description: Minimum deposit amount nullable: true minimumWithdrawal: type: string description: Minimum withdrawal amount nullable: true originalBalance: type: string description: Original balance nullable: true originalDeposit: type: string description: Original deposit amount nullable: true originalDepositDate: type: string description: Original deposit date (YYYY-MM-DD) nullable: true yearEndBalance: type: string description: Year-end balance nullable: true ledgerAccrual: type: string description: Ledger accrual amount nullable: true loanPaymentHold: type: string description: Loan payment hold amount nullable: true chargeOffAmount: type: string description: Charge-off amount nullable: true chargeOffType: type: string description: Charge-off type code nullable: true chargeOffDate: type: string description: Charge-off date (YYYY-MM-DD) nullable: true divRate: type: string description: Dividend rate nullable: true divType: type: string description: Dividend type code nullable: true divPostCode: type: string description: Dividend post code nullable: true divYtd: type: string description: Dividends year-to-date nullable: true divLastYear: type: string description: Dividends last year nullable: true divFromOpen: type: string description: Total dividends from open nullable: true divAccrual: type: string description: Dividend accrual amount nullable: true divAccrualDate: type: string description: Dividend accrual date (YYYY-MM-DD) nullable: true divPeriodStart: type: string description: Dividend period start date (YYYY-MM-DD) nullable: true dividendDue: type: string description: Dividend due amount nullable: true lastDivAmount: type: string description: Last dividend amount nullable: true lastDivDate: type: string description: Last dividend date (YYYY-MM-DD) nullable: true currDivPayable: type: string description: Current dividend payable nullable: true currMonthPaidDiv: type: string description: Current month paid dividend nullable: true divDisbUpdtActvtyD: type: string description: Dividend disbursement update activity date flag nullable: true dividendRateMargin: type: string description: Dividend rate margin nullable: true dividendRateMarginSign: type: string description: Dividend rate margin sign nullable: true dividendRateMax: type: string description: Dividend rate maximum nullable: true dividendRateMin: type: string description: Dividend rate minimum nullable: true dividendRatePeriodFreq: type: string description: Dividend rate period frequency nullable: true bondIntLastYear: type: string description: Bond interest last year nullable: true bondIntYtd: type: string description: Bond interest year-to-date nullable: true cddivAccrLastYr: type: string description: CD dividend accrued last year nullable: true cddivAccrYtd: type: string description: CD dividend accrued year-to-date nullable: true mcDivLastYear: type: string description: Money-center dividend last year nullable: true mcDivYtd: type: string description: Money-center dividend year-to-date nullable: true mtdAccruedDivs: type: string description: Month-to-date accrued dividends nullable: true mtdEarnedDivs: type: string description: Month-to-date earned dividends nullable: true mtdPaidDivs: type: string description: Month-to-date paid dividends nullable: true mtdPriorRateAccrual: type: string description: Month-to-date prior rate accrual nullable: true divPeriodBalDays: type: string description: Dividend period balance days nullable: true statementDate: type: string description: Statement date (YYYY-MM-DD) nullable: true statementPrevDate: type: string description: Previous statement date (YYYY-MM-DD) nullable: true statementGroup: type: string description: Statement group code nullable: true statementMailCode: type: string description: Statement mail code nullable: true termFrequency: type: string description: Term frequency code nullable: true termPeriod: type: string description: Term period nullable: true maturityPostCode: type: string description: Maturity post code nullable: true renewShareType: type: string description: Renewal share type nullable: true renewTermFreq: type: string description: Renewal term frequency nullable: true renewTermPeriod: type: string description: Renewal term period nullable: true bumpRate: type: string description: Bump rate nullable: true periodicCap: type: string description: Periodic cap nullable: true periodicStartRate: type: string description: Periodic start rate nullable: true regDCheckCount: type: string description: Regulation D check count nullable: true regDTransferCount: type: string description: Regulation D transfer count nullable: true regDCtrStartDay: type: string description: Regulation D counter start day nullable: true regECount: type: string description: Regulation E count nullable: true overdraftTolerance: type: string description: Overdraft tolerance amount nullable: true overdraftFeeLastYr: type: string description: Overdraft fee last year nullable: true overdraftFeeYtd: type: string description: Overdraft fee year-to-date nullable: true withdrawalCount: type: string description: Withdrawal count nullable: true withdrawalLimit: type: string description: Withdrawal limit nullable: true withdrawalFeeCount: type: string description: Withdrawal fee count nullable: true withdrawalFeeType: type: string description: Withdrawal fee type nullable: true withdrawnFromOpen: type: string description: Total withdrawn from open nullable: true penaltyLastYear: type: string description: Penalty last year nullable: true penaltyYtd: type: string description: Penalty year-to-date nullable: true penaltyType: type: string description: Penalty type code nullable: true withholdingCode: type: string description: Withholding code nullable: true withholdingLastYear: type: string description: Withholding last year nullable: true withholdingYtd: type: string description: Withholding year-to-date nullable: true stateWithholdingCode: type: string description: State withholding code nullable: true stateWithholdingLastQtr: type: string description: State withholding last quarter nullable: true stateWithholdingLastYear: type: string description: State withholding last year nullable: true stateWithholdingQtd: type: string description: State withholding quarter-to-date nullable: true stateWithholdingYtd: type: string description: State withholding year-to-date nullable: true chapter4WithheldLstYr: type: string description: Chapter 4 withheld last year nullable: true chapter4WithheldYtd: type: string description: Chapter 4 withheld year-to-date nullable: true chapter4WithholdingCode: type: string description: Chapter 4 withholding code nullable: true insuranceMaximum: type: string description: Insurance maximum amount nullable: true insuranceType: type: string description: Insurance type code nullable: true irsCode: type: string description: IRS code nullable: true irsPlan: type: string description: IRS plan code nullable: true irs1042SUfid: type: string description: IRS 1042-S UFID nullable: true escrowLastYear: type: string description: Escrow last year nullable: true escrowYtd: type: string description: Escrow year-to-date nullable: true nsfLastYear: type: string description: NSF count last year nullable: true nsfMonthToDate: type: string description: NSF count month-to-date nullable: true nsfYtd: type: string description: NSF count year-to-date nullable: true nsfFeeLy: type: string description: NSF fee count last year nullable: true nsfFeeMtd: type: string description: NSF fee count month-to-date nullable: true nsfFeeYtd: type: string description: NSF fee count year-to-date nullable: true courtesyPayLastYear: type: string description: Courtesy pay count last year nullable: true courtesyPayMonthToDate: type: string description: Courtesy pay count month-to-date nullable: true courtesyPayYtd: type: string description: Courtesy pay count year-to-date nullable: true courtesyFeeLy: type: string description: Courtesy fee count last year nullable: true courtesyFeeMtd: type: string description: Courtesy fee count month-to-date nullable: true courtesyFeeYtd: type: string description: Courtesy fee count year-to-date nullable: true cappedFeesAmountCap: type: string description: Capped fees amount cap nullable: true cappedFeesAmtPeriod: type: string description: Capped fees amount period nullable: true cappedFeesCntPeriod: type: string description: Capped fees count period nullable: true cappedFeesCountCap: type: string description: Capped fees count cap nullable: true feeExemptCrtsyBal: type: string description: Fee exempt courtesy balance nullable: true unpaidFeeLastYear: type: string description: Unpaid fee last year nullable: true unpaidFeeYtd: type: string description: Unpaid fee year-to-date nullable: true corporateUserTransferCode: type: string description: Corporate user transfer code nullable: true memberUserTransferCode: type: string description: Member user transfer code nullable: true memberBranchSupport: type: string description: Member branch support code nullable: true xfrLastYear: type: string description: Transfers last year nullable: true xfrMonthToDate: type: string description: Transfers month-to-date nullable: true xfrYtd: type: string description: Transfers year-to-date nullable: true sweepBalanceType: type: string description: Sweep balance type nullable: true sweepPriority: type: string description: Sweep priority nullable: true sweepTargetMaximum: type: string description: Sweep target maximum nullable: true sweepTargetMinimum: type: string description: Sweep target minimum nullable: true extAchXfrDailyLimitIn: type: string description: External ACH transfer daily limit inbound nullable: true extAchXfrDailyLimitOut: type: string description: External ACH transfer daily limit outbound nullable: true creditReportLastStatus: type: string description: Credit report last status nullable: true creditReportOriginalAmountRptd: type: string description: Credit report original amount reported nullable: true creditReportingCode: type: string description: Credit reporting code nullable: true amortizationSchd: type: string description: Amortization schedule code nullable: true amortizationSchdType: type: string description: Amortization schedule type nullable: true analysisPmtIdType: type: string description: Analysis payment ID type nullable: true callItemSchd: type: string description: Call item schedule nullable: true callItemSchdType: type: string description: Call item schedule type nullable: true cuTotalsUseCode: type: string description: CU totals use code nullable: true lastDirectDepAmt: type: string description: Last direct deposit amount nullable: true negativeBalanceNoticeNumber: type: string description: Negative balance notice number nullable: true negativeBalanceNoticeType: type: string description: Negative balance notice type nullable: true positivePayDraft: type: string description: Positive pay draft flag nullable: true putItemSchd: type: string description: Put item schedule nullable: true putItemSchdType: type: string description: Put item schedule type nullable: true userAmount1: type: string description: User-defined amount 1 nullable: true userAmount2: type: string description: User-defined amount 2 nullable: true alternateNameLocator: type: string description: Alternate name locator nullable: true alternateNameType: type: string description: Alternate name type nullable: true payeeNameLocator: type: string description: Payee name locator nullable: true payeeNameType: type: string description: Payee name type nullable: true accountWarnings: type: array description: | Warning codes set at the **account** level in Symitar. Each entry includes the raw warning code and a human-readable description resolved from the institution's Parameter configuration. Each entry also includes three privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) that control what actions the warning allows. Up to 20 warning code slots exist per account. Only populated slots (code ≠ 0) are returned. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' shareWarnings: type: array description: | Warning codes set at the **share** level in Symitar. Same structure as `accountWarnings` but scoped to the individual share record. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' notes: type: array description: Share-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 loans: type: array description: Loan accounts belonging to the member items: type: object description: Loan account information with relationships required: - account - accountStatus - relationships - notes - accountWarnings - loanWarnings properties: account: type: object description: Account identifier required: - accountId properties: accountId: type: string description: Account ID (alphanumeric, 1-34 characters) minLength: 1 maxLength: 34 pattern: ^[a-zA-Z0-9]+$ example: S1234560001 restrict: type: integer description: Symitar account restriction code currentRelationshipCode: type: integer description: Symitar CURRENTRELATIONSHIPCODE value for the parent account nullable: true currentRelationshipName: type: string description: Institution-configured description for `currentRelationshipCode`, resolved from the Symitar Relationship Code Description parameter. Omitted when the code has no configured description or the parameter lookup is unavailable. example: Premier Member negativeBalanceDate: type: string description: Symitar NEGATIVEBALANCEDATE value from the share record. SymXchange only defines this field on shares, so it is omitted for loans. nullable: true accountNumber: type: string description: 10-digit account number nullable: true example: 0000379758 loanId: type: string description: Loan ID within the account nullable: true example: '0001' balance: type: string description: Loan balance (outstanding principal) example: '15000.00' accountStatus: type: string description: Loan status (Active/Closed) enum: - Active - Closed relationships: type: array description: Loan relationships (borrowers, co-signers, etc.) items: type: object description: Account relationship identity/role information returned from SymX name records. Postal address data is not included. required: - memberName - relationshipCode properties: memberName: type: string description: Name of the related member memberRecordNumber: type: string description: 17-digit member record number, usable as the {memberRecordNumber} path parameter in GET /members/{memberRecordNumber} nullable: true example: '20190510000000000' relationshipCode: type: string description: Type of relationship enum: - Primary - Joint - Mailing Only - Alternate mailing - Beneficiary - Custodian - Trustee - Responsible Individual - Power of attorney - Authorized Signer - Dividend payee - Maturity Payee - Coverdell ESA Beneficiary - Next of Kin - Representative Payee - Grantor - Guarantor - Loan Co-Maker - Loan Co-Applicant - Trustor - Co-Borrower - Co-Signer - CTR Owner Address/ID - CTR Transactor - DBA - Attorney Trust - Safe Deposit Box Co-Lessee - Safe Deposit Box Deputy - CTR Common Carrier - Property Address - Successor in Interest - Information Only nullable: true accountWarnings: type: array description: | Warning codes set at the **account** level in Symitar. Shared across all shares and loans on the account. Only populated slots (code ≠ 0) are returned, enriched with description and privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) from the institution's Parameter configuration. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' loanWarnings: type: array description: | Warning codes set at the **loan** level in Symitar. Scoped to this individual loan record. Same structure as `accountWarnings`. Always present; empty array if there are no active warnings. items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' notes: type: array description: Loan-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 description: type: string description: Loan description (e.g. "AUTO LOAN") nullable: true example: AUTO LOAN loanType: type: string description: Loan type code nullable: true loanCode: type: string description: Raw loan code value from SymXchange nullable: true loanCodeName: type: string description: Human-readable loan account type name (e.g. "Closed end", "Open end", "Line of credit", "Credit card", "Lease") nullable: true branch: type: string description: Branch number for the loan nullable: true openDate: type: string description: Loan open date (YYYY-MM-DD) nullable: true example: '2022-03-15' closeDate: type: string description: Loan close date (YYYY-MM-DD) nullable: true nickname: type: string description: Loan nickname nullable: true activityDate: type: string description: Last activity date (YYYY-MM-DD) nullable: true recordChangeDate: type: string description: Record change date (YYYY-MM-DD) nullable: true lastFmDate: type: string description: Last FM date (YYYY-MM-DD) nullable: true lastTranDate: type: string description: Last transaction date (YYYY-MM-DD) nullable: true createdAtBranch: type: string description: Branch where the loan was created nullable: true createdByUser: type: string description: User who created the loan nullable: true originalBalance: type: string description: Original loan balance nullable: true creditLimit: type: string description: Credit limit (for LOC/credit card loans) nullable: true availableCredit: type: string description: Available credit remaining nullable: true payoffAmount: type: string description: Current payoff amount nullable: true pastDueAmount: type: string description: Past due amount nullable: true chargeOffAmount: type: string description: Charge-off amount nullable: true chargeOffType: type: string description: Charge-off type code nullable: true chargeOffDate: type: string description: Charge-off date (YYYY-MM-DD) nullable: true interestRate: type: string description: Current interest rate nullable: true example: '5.250' apr: type: string description: Annual percentage rate nullable: true interestYtd: type: string description: Interest paid year-to-date nullable: true interestLastYear: type: string description: Interest paid last year nullable: true intUnpaidBilled: type: string description: Unpaid billed interest nullable: true payment: type: string description: Regular payment amount nullable: true example: '350.00' paymentDue: type: string description: Current payment due amount nullable: true minimumPayment: type: string description: Minimum payment amount nullable: true dueDate: type: string description: Next due date (YYYY-MM-DD) nullable: true example: '2026-04-01' lastPaymentDate: type: string description: Last payment date (YYYY-MM-DD) nullable: true lastPaymentAmount: type: string description: Last payment amount nullable: true maturityDate: type: string description: Loan maturity date (YYYY-MM-DD) nullable: true example: '2028-03-15' cards: type: array description: Card records belonging to the member. Always present; empty array if there are no cards. items: type: object description: | Card record associated with a member account. Includes identity/status fields, issuance details, limits/counters, warning codes, sub-records (access list and cardholder names), and card-level notes. properties: accountNumber: type: string description: 10-digit account number the card belongs to nullable: true example: 0000379758 locator: type: string description: Symitar card locator number nullable: true accountWarnings: type: array description: Account-level warning codes enriched with descriptions and privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' cardWarnings: type: array description: Card-level warning codes enriched with descriptions and privilege flags (Inquiry (IQ), File Maintenance (FM), Transaction (TR)) items: type: object description: | A single warning code entry enriched with the institution's parameter definitions. Symitar warning codes are integers 0–999 configured per institution. The restriction fields indicate what actions are affected when this warning is present on an account, share, or loan. required: - entryId - code - description - inquiryRestriction - maintenanceRestriction - tellerRestriction properties: entryId: type: integer description: Positional slot index of this warning (0–19). minimum: 0 maximum: 19 example: 0 code: type: integer description: The warning code number as configured in Symitar (0–999). minimum: 0 maximum: 999 example: 5 description: type: string description: | Human-readable label for the warning code, resolved from the institution's Parameter configuration (e.g. "Deceased Member", "Legal Hold – Do Not Release Funds"). Empty if the code could not be resolved. example: Deceased Member inquiryRestriction: type: integer description: | Controls whether a user can **inquire** on (view) the account, share, or loan carrying this warning. Institution-specific; typically `0` = no restriction, `1` = restricted. example: 0 maintenanceRestriction: type: integer description: | Controls whether a user can perform **file maintenance** (modify) on the account, share, or loan carrying this warning. Typically `0` = no restriction, `1` = restricted. example: 1 tellerRestriction: type: integer description: | Controls whether this warning is displayed in the **Teller Transaction** work area and whether teller transactions are restricted. Typically `0` = no restriction, `1` = displayed / restricted. example: 1 expirationDate: type: string description: | Expiration date for this warning slot (YYYY-MM-DD). Omitted if the warning does not expire. nullable: true example: '2027-12-31' description: type: string description: Card description nullable: true type: type: string description: Card type code nullable: true status: type: string description: Card status nullable: true statusReason: type: string description: Reason for the current card status nullable: true blockCode: type: string description: Block code restricting card usage nullable: true reclassCode: type: string description: Reclassification code nullable: true chkId: type: string description: Checking account ID linked to the card nullable: true creditCardId: type: string description: Credit card identifier nullable: true suffix: type: string description: Card suffix nullable: true nameType: type: string description: Name type code nullable: true locId: type: string description: Line of credit ID nullable: true savId: type: string description: Savings account ID linked to the card nullable: true activeDate: type: string description: Date the card was activated (YYYY-MM-DD) nullable: true closeDate: type: string description: Date the card was closed (YYYY-MM-DD) nullable: true effectiveDate: type: string description: Card effective date (YYYY-MM-DD) nullable: true issueDate: type: string description: Date the card was issued (YYYY-MM-DD) nullable: true lastAddrChgDate: type: string description: Date the card's address was last changed (YYYY-MM-DD) nullable: true recordChangeDate: type: string description: Date the card record was last modified (YYYY-MM-DD) nullable: true createdAtBranch: type: string description: Branch where the card was created nullable: true createdByUser: type: string description: User who created the card record nullable: true issueCode: type: string description: Issue code nullable: true reissueCode: type: string description: Reissue code nullable: true reissueMonths: type: string description: Number of months between automatic reissues nullable: true instantIssue: type: string description: Instant issue flag nullable: true onlineCardIssue: type: string description: Online card issue flag nullable: true onlineRushIssue: type: string description: Online rush issue flag nullable: true extraEmboss: type: string description: Extra embossing text nullable: true emvChipProfile: type: string description: EMV chip profile code nullable: true digitalIssueStatus: type: string description: Digital issuance status nullable: true digitalIssueExcept: type: string description: Digital issuance exception code nullable: true imageRefDate: type: string description: Image reference date nullable: true imageRefIssueCount: type: string description: Image reference issue count nullable: true imageRefNumber: type: string description: Image reference number nullable: true prevActivationDate: type: string description: Previous card activation date (YYYY-MM-DD) nullable: true limitAmount: type: string description: Overall card limit amount nullable: true limitDays: type: string description: Limit period in days nullable: true singleUsageMax: type: string description: Maximum single transaction amount nullable: true tempLimitStartDate: type: string description: Temporary limit start date (YYYY-MM-DD) nullable: true tempLimitEndDate: type: string description: Temporary limit end date (YYYY-MM-DD) nullable: true atmCount: type: string description: Current ATM transaction count nullable: true atmCountLimit: type: string description: ATM transaction count limit nullable: true atmTempLimit: type: string description: Temporary ATM limit nullable: true authAmount: type: string description: Current authorization amount nullable: true authCount: type: string description: Current authorization count nullable: true authCountLimit: type: string description: Authorization count limit nullable: true authLimit: type: string description: Authorization amount limit nullable: true authTempLimit: type: string description: Temporary authorization limit nullable: true billPayAmount: type: string description: Current bill pay amount nullable: true billPayCount: type: string description: Current bill pay count nullable: true billPayCountLimit: type: string description: Bill pay count limit nullable: true billPayLimit: type: string description: Bill pay amount limit nullable: true billPayMax: type: string description: Bill pay maximum amount nullable: true credDebAmount: type: string description: Current credit/debit amount nullable: true credDebCount: type: string description: Current credit/debit count nullable: true credDebCountLimit: type: string description: Credit/debit count limit nullable: true credDebLimit: type: string description: Credit/debit amount limit nullable: true depAmount: type: string description: Current deposit amount nullable: true depCount: type: string description: Current deposit count nullable: true depCountLimit: type: string description: Deposit count limit nullable: true depLimit: type: string description: Deposit amount limit nullable: true depMax: type: string description: Deposit maximum amount nullable: true miscAmount: type: string description: Current miscellaneous transaction amount nullable: true miscCount: type: string description: Current miscellaneous transaction count nullable: true miscCountLimit: type: string description: Miscellaneous transaction count limit nullable: true miscLimit: type: string description: Miscellaneous transaction amount limit nullable: true posAmount: type: string description: Current POS transaction amount nullable: true posCount: type: string description: Current POS transaction count nullable: true posCountLimit: type: string description: POS transaction count limit nullable: true posLimit: type: string description: POS transaction amount limit nullable: true posTempLimit: type: string description: Temporary POS limit nullable: true usageAmount: type: string description: Current usage amount nullable: true usageDate: type: string description: Last usage date nullable: true usageLimit: type: string description: Usage limit nullable: true wdCheckAmount: type: string description: Current withdrawal/check amount nullable: true wdCheckCount: type: string description: Current withdrawal/check count nullable: true wdCheckCountLimit: type: string description: Withdrawal/check count limit nullable: true wdCheckLimit: type: string description: Withdrawal/check amount limit nullable: true wdCheckMax: type: string description: Withdrawal/check maximum amount nullable: true xferAmount: type: string description: Current transfer amount nullable: true xferCount: type: string description: Current transfer count nullable: true xferCountLimit: type: string description: Transfer count limit nullable: true xferLimit: type: string description: Transfer amount limit nullable: true xferMax: type: string description: Transfer maximum amount nullable: true fileUpdateManagerException: type: string description: File update manager exception code nullable: true access: type: array description: Card access sub-records defining which accounts the card can access items: type: object description: Card access sub-record defining which account the card can access and what operations are permitted. properties: locator: type: string description: Access record locator nullable: true accessType: type: string description: Access type code nullable: true accountNumber: type: string description: Account number this access record links to nullable: true enableDeposit: type: string description: Whether deposits are enabled nullable: true enableFm: type: string description: Whether file maintenance is enabled nullable: true enableInquiry: type: string description: Whether inquiries are enabled nullable: true enableWithdrawal: type: string description: Whether withdrawals are enabled nullable: true extLoanAccount: type: string description: External loan account number nullable: true id: type: string description: Access record ID nullable: true idType: type: string description: Access record ID type nullable: true qualifier: type: string description: Access qualifier nullable: true recordChangeDate: type: string description: Date the access record was last modified (YYYY-MM-DD) nullable: true names: type: array description: Cardholder name sub-records items: type: object description: Cardholder name sub-record representing a name associated with the card. properties: locator: type: string description: Name record locator nullable: true type: type: string description: Name type code nullable: true subType: type: string description: Name sub-type code nullable: true first: type: string description: First name nullable: true middle: type: string description: Middle name nullable: true last: type: string description: Last name nullable: true suffix: type: string description: Name suffix nullable: true title: type: string description: Name title/prefix nullable: true shortName: type: string description: Short name nullable: true longName: type: string description: Long name (full name) nullable: true extendedName: type: string description: Extended name field nullable: true nameFormat: type: string description: Name format code nullable: true lateChargeAccrued: type: string description: Late charge accrued amount nullable: true lateChargeDate: type: string description: Late charge date (YYYY-MM-DD) nullable: true lateChargeDue: type: string description: Late charge due amount nullable: true lateChargeType: type: string description: Late charge type code nullable: true lateChargeUnpaid: type: string description: Late charge unpaid amount nullable: true lateChargeYtd: type: string description: Late charges year-to-date nullable: true lateChargeLastYear: type: string description: Late charges last year nullable: true statementDate: type: string description: Statement date (YYYY-MM-DD) nullable: true statementPrevDate: type: string description: Previous statement date (YYYY-MM-DD) nullable: true statementGroup: type: string description: Statement group code nullable: true statementMailCode: type: string description: Statement mail code nullable: true creditReportLastStatus: type: string description: Credit report last status nullable: true creditReportingCode: type: string description: Credit reporting code nullable: true accrualStatus: type: string description: Accrual status code nullable: true approvalCode: type: string description: Approval code nullable: true approvalDate: type: string description: Approval date (YYYY-MM-DD) nullable: true alternateNameLocator: type: string description: Alternate name locator nullable: true alternateNameType: type: string description: Alternate name type nullable: true notes: type: array description: Loan-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 notes: type: array description: Card-level notes/comments items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 notes: type: array description: Account-level notes/comments. Always present; empty array if there are no notes. items: type: object description: A note/comment record on an account, share, or loan. properties: locator: type: integer description: Unique identifier for the note within its parent example: 1 code: type: integer description: Note category/type code example: 10 enterDate: type: string description: Date the note was entered (YYYY-MM-DD) example: '2026-01-15' enterTime: type: integer description: Time the note was entered (HHMM format) example: 1430 expirationDate: type: string description: When the note expires id: type: string description: Identifier of the user/process that created the note example: TELLER01 idType: type: integer description: Type of the id field recordChangeDate: type: string description: Last modification date text: type: string description: | Note text. Multiple text lines from Symitar are aggregated into a single space-separated string. example: Member called about account balance. Verified identity via security questions. user: allOf: - type: object description: | Symitar system user (teller, employee, etc.). Retrieved via the SymXchange `getUserSelectFields` operation on the User CRUD service. This is **not** a credit union member — see the `Member` schema for member information. When embedded in a `Note`, only `number` is guaranteed to be present. The remaining fields are populated when the user record is available in the cache. required: - number properties: number: type: integer description: Symitar user number example: 42 name: type: string description: Full name of the user example: Jean-Luc Picard email: type: string description: Email address example: jlpicard@example.com phone: type: string description: Phone number example: 555-0100 extension: type: string description: Phone extension jobTitle: type: string description: Job title example: Branch Manager jobFunction: type: string description: Job function deptName: type: string description: Department name example: Operations location: type: string description: Location managersName: type: string description: Manager's name assignedBranch: type: integer description: Assigned branch number example: 1 type: type: integer description: User type code onlineAccess: type: integer description: Online access flag activeMode: type: integer description: Active mode flag lastLogonDate: type: string description: Last logon date (YYYY-MM-DD) example: '2026-03-09' lastLogonTime: type: integer description: Last logon time (HHMM format) example: 1430 secondaryId: type: string description: Secondary identifier directory: type: string description: Directory path recordChangeDate: type: string description: Record change date (YYYY-MM-DD) securityCodes: type: array description: List of enabled security codes for the user. items: type: object properties: code: type: integer description: Security code identifier description: type: string description: Human-readable security code description description: | The user who created the note. Always contains at least `number`. When the user record is available in the cache the remaining fields (name, email, etc.) are populated. voidFlag: type: integer description: Whether the note has been voided (0 = active, 1 = voided) example: 0 voidedBy: type: integer description: User ID who voided the note example: 0 preferences: type: array description: Preference records belonging to the member. Always present; empty array if there are no preferences. items: type: object description: Preference record representing a member's home-banking preference settings. properties: accountNumber: type: string description: 10-digit account number the preference belongs to nullable: true depLimit: type: string description: Deposit limit nullable: true depMax: type: string description: Deposit maximum nullable: true hbEnable: type: string description: Whether home banking is enabled nullable: true hbUsername: type: string description: Home-banking username associated with the preference nullable: true lastLogonDate: type: string description: Date of last logon (YYYY-MM-DD) nullable: true lastLogonTime: type: string description: Time of last logon nullable: true lastTranDate: type: string description: Date of last transaction (YYYY-MM-DD) nullable: true locator: type: string description: Preference record locator nullable: true locked: type: string description: Whether the preference is locked nullable: true pwdResetDate: type: string description: Password reset date (YYYY-MM-DD) nullable: true wdCashLimit: type: string description: Withdrawal cash limit nullable: true wdCashMax: type: string description: Withdrawal cash maximum nullable: true wdCheckLimit: type: string description: Withdrawal check limit nullable: true wdCheckMax: type: string description: Withdrawal check maximum nullable: true xferLimit: type: string description: Transfer limit nullable: true xferMax: type: string description: Transfer maximum nullable: true access: type: array description: Preference access sub-records. Always present; empty array if there are no preference access records. items: type: object description: Preference access sub-record representing access settings for a preference. properties: locator: type: string description: Access record locator nullable: true accessType: type: string description: Access type code nullable: true accountNumber: type: string description: Account number for the access record nullable: true enableDeposit: type: string description: Whether deposit access is enabled nullable: true enableFm: type: string description: Whether file maintenance access is enabled nullable: true enableInquiry: type: string description: Whether inquiry access is enabled nullable: true enableWithdrawal: type: string description: Whether withdrawal access is enabled nullable: true extLoanAccount: type: string description: External loan account reference nullable: true id: type: string description: Share/loan ID the access record references nullable: true idType: type: string description: ID type (e.g. share or loan) nullable: true qualifier: type: string description: Access qualifier nullable: true recordChangeDate: type: string description: Date the access record was last modified (YYYY-MM-DD) nullable: true members: type: array description: 'Internal-route only (`/internal/v1/.../accounts-search`) name-record member fields from SymXchange, including SSN. Collected from every level that can hold a name: the account name list plus each share, loan and card name list. A joint held only on a share, loan or card is therefore still listed. Deduplicated by `memberNumber`, keeping the account-level record when the same person appears more than once.' items: type: object description: Member fields from Account Name records returned by SymXchange (internal accounts-search only). properties: activeDuty: type: string nullable: true addressType: type: string nullable: true beneficialOwner: type: string nullable: true beneficialPercent: type: string nullable: true beneficiaryPercent: type: string nullable: true chapter4StatusCode: type: string nullable: true confidential: type: string nullable: true crNameChgDate: type: string nullable: true ctrExempt: type: string nullable: true currGrossMonthPay: type: string nullable: true currNetMonthPay: type: string nullable: true dbaNameFormat: type: string nullable: true dbaShortName: type: string nullable: true ecoaCode: type: string nullable: true effectiveDate: type: string nullable: true expirationDate: type: string nullable: true firstName: type: string nullable: true description: First name formW8OnFile: type: string nullable: true headquarters: type: string nullable: true identDocFlags: type: array items: type: object properties: entryId: type: integer flag: type: integer identIdTypes: type: array items: type: object properties: entryId: type: integer type: type: integer irs1042SAmendNum: type: string nullable: true irsCorrection: type: string nullable: true last: type: string nullable: true lastAddrChgDate: type: string nullable: true locator: type: string nullable: true longName: type: string nullable: true mailOverride: type: string nullable: true marketingAddress: type: string nullable: true mbrAddrFileType: type: string nullable: true mbrCreateDate: type: string nullable: true mbrFileType: type: string nullable: true mbrFmLastDate: type: string nullable: true mbrRecordChangeDate: type: string nullable: true mbrStatus: type: string nullable: true mbrStatusFmDate: type: string nullable: true memberNumLink: type: string nullable: true memberNumLinkChgDate: type: string nullable: true memberNumber: type: string nullable: true middleName: type: string nullable: true description: Middle name; omitted when the member has no middle name mobilePhone: type: string nullable: true nameFormat: type: string nullable: true nraTaxRate: type: string nullable: true phoneType: type: string nullable: true preferredContact: type: string nullable: true preferredContactMethod: type: string nullable: true recordChangeDate: type: string nullable: true restrict: type: string nullable: true shortName: type: string nullable: true ssn: type: string nullable: true ssnCertification: type: string nullable: true ssnOverride: type: string nullable: true ssnType: type: string nullable: true subType: type: string nullable: true substantialOwner: type: string nullable: true suffix: type: string nullable: true description: Name suffix title: type: string nullable: true description: Name title/prefix type: type: string nullable: true usPersonFlag: type: string nullable: true userAmount1: type: string nullable: true userAmount2: type: string nullable: true '400': description: Bad request — zero or more than one search field provided content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error

Please ignore this field