Participant APIs | REST

Selected Version:
Download Open API File

Validate External Bank Account

https://api.wealthcare.com/participant/services/participant/hsa/bankaccounts/validation/{tpaId}/{employerId}/{participantId}

Validate the external bank account associated with a participant by verifying specific credit amounts. This operation is essential for ensuring the accuracy and legitimacy of bank account information before processing transactions.

Request

  • tpaId string Required

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

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • participantId string Required

    Unique identifier for the participant user whose feature information is being retrieved.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

  • TpaId string

    Unique identifier assigned to the administrator

  • ExtBankAcctKey integer <int64>

    Unique identifier assigned to a bank account

  • DataPartnerId string

    Unique identifier for the Product Partner

  • CreditAmt1 number <double>

    First of three credit amounts needed to validate a physical bank account

  • CreditAmt2 number <double>

    Second of three credit amounts needed to validate a physical bank account

  • CreditAmt3 number <double>

    Third of three credit amounts needed to validate a physical bank account

  • TpaId string

    Unique identifier assigned to the administrator

  • ExtBankAcctKey integer <int64>

    Unique identifier assigned to a bank account

  • DataPartnerId string

    Unique identifier for the Product Partner

  • CreditAmt1 number <double>

    First of three credit amounts needed to validate a physical bank account

  • CreditAmt2 number <double>

    Second of three credit amounts needed to validate a physical bank account

  • CreditAmt3 number <double>

    Third of three credit amounts needed to validate a physical bank account

Response

Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...