Administrative APIs | REST

Version:
Download Open API Specification

Update Employer Funding Bank Account

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

Update the funding bank account details for a specific employer identified by their TPA ID. This operation is typically used to modify account information such as account name, number, and routing details.

Request

  • tpaId string Required

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

  • accountName string

    Bank Account Name

    Min Length: 0
    Max Length: 50
  • bankAccountNumber string

    Bank Account Number

    Min Length: 0
    Max Length: 17
  • bankRoutingNumber string

    Bank Routing Number

    Min Length: 0
    Max Length: 9
  • bankSecondRoutingNumber string

    Bank Secondary Routing Number

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

    Type of account.

    Possible values: Checking Savings
  • financialInstitutionName string

    Name of the bank or financial institution that hosts the account

  • fiAddress1 string

    Address Line 1 of the bank or financial institution that hosts the account

    Min Length: 0
    Max Length: 55
  • fiAddress2 string

    Address Line 2 of the bank or financial institution that hosts the account

    Min Length: 0
    Max Length: 55
  • fiCity string

    City of the bank or financial institution that hosts the account

    Min Length: 0
    Max Length: 30
  • fiZipCode string

    Zip code of the bank or financial institution that hosts the account

    Min Length: 0
    Max Length: 15
  • fiState string

    Two-letter state code of the bank or financial institution that hosts the account

  • fiCountryCode string

    Country of the bank or financial institution that hosts the account. Will always be "US".

    Min Length: 0
    Max Length: 3
  • authorizedOwnerName string

    Financial Institution Authorized Owner Name

    Min Length: 0
    Max Length: 50
  • authorizedPersonName string

    Financial Institution Authorized Person Name

    Min Length: 0
    Max Length: 50
  • authorizedPersonTitle string

    Financial Institution Authorized Person Title

Response

  • ErrorCode integer <int32>

    A numeric code indicating the processing result of the request. 000000 indicates a success. Note: Ask Alegeus for a copy of error codes.

  • ErrorDescription string

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

AI Assistant Preview

Generating response...