Administrative APIs | REST

Version:
Download Open API Specification

Update employer bank account

https://api.wealthcare.com/system/Services/Employer/BankAccount/{tpaId}

Use this operation to update information or setup for an employer bank account.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • bankAccountName string Required

    Name assigned by the administrator during creation. It cannot be updated on subsequent loads. It can be applied to more than one employer by changing the employer ID. Settlement is NOT immediate for each newly linked employer

    Min Length: 0
    Max Length: 50
  • bankAccountNumber string Required

    Bank account number. Required if account usage includes ACH

  • bankRoutingNumber string Required

    Bank account routing number. Required if account usage includes ACH.

    Min Length: 0
    Max Length: 9
  • bankSecondRoutingNumber string

    Bank account secondary routing number

    Min Length: 0
    Max Length: 9
  • bankAccountTypeCode enum<string> Required

    Type of account. Defaults to 1 if left blank 0 - None 1 - Checking 2 - Savings 3 - General Ledger

    Possible values: None Checking Savings GeneralLedger
  • isZeroBalance boolean Required

    1 = Yes 0 = No

  • emailAddress string

    Email addresses separated by semicolon used to provide daily activity emails.

  • isDailyEmailReceive boolean

    Do you wish to receive daily account activity via email? 1= Yes 0 = No

  • address1 string

    First line of the bank’s mailing address

    Min Length: 0
    Max Length: 55
  • address2 string

    Second line of the bank’s mailing address

    Min Length: 0
    Max Length: 55
  • city string

    City associated with the bank’s address

    Min Length: 0
    Max Length: 30
  • zipCode string

    Up to nine digits Zip Code associated with the bank’s address. Limited to either five(5) or nine(9) characters, numbers only

    Min Length: 0
    Max Length: 15
  • state string

    Two letter state abbreviation associated with the bank’s address

  • countryCode string

    US is the only valid option. Contact us if you intend to send to any other international addresses

    Min Length: 0
    Max Length: 3
  • displayName string Required

    Unique display name associated with the account

    Min Length: 0
    Max Length: 50
  • accountOwnerName string

    Name of the account owner. Only required when the Account Owner Type is set to Third Party (Other). For Administrator/Employer Account Owner Types the Administrator’s or Employer’s name should autofill for this field.

    Min Length: 0
    Max Length: 50
  • authorizedPersonName string

    Person authorizing the account to be debited.

    Min Length: 0
    Max Length: 50
  • authorizedPersonTitle string

    Title of person listed in the authorizedPersonName field

  • physicalBankAccountUsageCode enum<string> Required

    Purpose of account. 1 - ACH only 2 - Reimbursement only 3 - All (default) 4 - Employer funding 5 - Balance repayment agent 6 - Incentive deposits 7 - Investments tranfer out Note Each employer must be linked to one ACH account that has reimbursement capabilities or no manual claims can be run for the employer (even for validation purposes via EDI). Recommended to choose ACH and Reimbursement

    Possible values: AchOnly ReimbursementOnly AchAndReimbursement
  • posSettlementType enum<string> Required

    Indicates if settlement will be one entry for each transaction (individual) or one entry per day for the net sum of all transactions (aggregate) IndividualSettlement = 0 AggregatedSettlement = 1

    Possible values: IndividualSettlement AggregatedSettlement
  • manualSettlementType enum<string> Required

    Indicates if settlement will be one entry for each transaction (individual) or one entry per day for the net sum of all transactions (aggregate) IndividualSettlement = 0 AggregatedSettlement = 1

    Possible values: IndividualSettlement AggregatedSettlement
  • emailAddressForManual string

    Email addresses separated by semicolon used to provide daily activity emails for manual transactions.

  • isDailyEmailReceiveForManual boolean

    Do you wish to receive daily account activity for manual transactions via email? Defaults to 0(No) if left blank  1= Yes 0 = No

  • fractionalRoutingNumber string

    The routing number that appears at the top of the check to identify the bank the check was cut off of. It is a combination of a control number, the last 4 digits of the banks routing number a slash then the first 4 digits of the routing number.

  • accountOwnerTaxId string

    Tax ID of the account owner. A value is conditionally required if the account owner does not have a Tax ID or if the Account Owner Type is set to Third Party (Other).

    Min Length: 0
    Max Length: 9
  • accountOwnerType enum<string>

    Determines who is the owner of the bank account.

    Possible values: None Administrator Employer Third Party (Other)
  • ErrorCode integer <int32>

    A numeric code indicating the processing result of the request. 000000 indicates a success. A list of error codes is available in Online Resources.

  • ErrorDescription string

    Human friendly description corresponding to ErrorCode to indicate either a success or why the request was not successfully processed.