Participant APIs | REST

Selected Version:
Download Open API File

Get a list of current (existing) reimbursement records associated with the participant.

https://api.wealthcare.com/participant/services/participant/reimbursements/{tpaId}/{employerId}/{participantId}

Get a list of current (existing) reimbursement records associated with the participant.

  • 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.

  • recordcount integer <int32> Required

    The maximum number of reimbursement records to return in the list

  • txnKey string

    The key to the transaction.

  • reimbKey integer <int32>

    The key to the reimbursement.

  • 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.

Response

  • TpaId string

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

  • EmprId string

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

  • EmpeKey integer <int32>

    Unique identifier key for the employee, generated by WCA when the employee was created in the system.

  • EmployeeFirstName string

    Employee's first name.

  • EmployeeMiddleInitial string

    Employee's middle name.

  • EmployeeLastName string

    Employee's last name.

  • ReimburseKey integer <int32>

    Represents a system generated identifier for the reimbursement which can be used to retrieve the reimbursement details in a separate request.

  • ReimburseDate string <date-time>

    Date of reimbursement.

  • TotalReimburseAmount number <double>

    Total amount reimbursed.

  • CheckNumber string

    Check number associated with this reimbursement.

  • TrackingNumber string

    Unique identifier to track this reimbursement.

  • VoidDate string <date-time>

    The date that the reimbursement was voided.

  • StopPaymentDate string <date-time>

    The date a stop payment request for a check was issued to the bank.

  • ACHDate string <date-time>

    The date that an ACH payment was initiated.

  • PaymentId string

    Represents the draft # issued by our Integrated Payment vendor.

  • PayoutMethod string

    Represents the payment method used by the participant or our Integrated Payment vendor. Valid methods include Pending, Check, Direct Deposit, External Check, External Direct Deposit, Card, Payroll, ePay-ACH, ePay-Virtual Card, and ePay-eCheck.

  • CheckClearedDate string

    The date that the reimbursent check was put into the bank account.

  • SetlDate string

    The date that the reimbursement was settled on.

  • TpaId string

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

  • EmprId string

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

  • EmpeKey integer <int32>

    Unique identifier key for the employee, generated by WCA when the employee was created in the system.

  • EmployeeFirstName string

    Employee's first name.

  • EmployeeMiddleInitial string

    Employee's middle name.

  • EmployeeLastName string

    Employee's last name.

  • ReimburseKey integer <int32>

    Represents a system generated identifier for the reimbursement which can be used to retrieve the reimbursement details in a separate request.

  • ReimburseDate string <date-time>

    Date of reimbursement.

  • TotalReimburseAmount number <double>

    Total amount reimbursed.

  • CheckNumber string

    Check number associated with this reimbursement.

  • TrackingNumber string

    Unique identifier to track this reimbursement.

  • VoidDate string <date-time>

    The date that the reimbursement was voided.

  • StopPaymentDate string <date-time>

    The date a stop payment request for a check was issued to the bank.

  • ACHDate string <date-time>

    The date that an ACH payment was initiated.

  • PaymentId string

    Represents the draft # issued by our Integrated Payment vendor.

  • PayoutMethod string

    Represents the payment method used by the participant or our Integrated Payment vendor. Valid methods include Pending, Check, Direct Deposit, External Check, External Direct Deposit, Card, Payroll, ePay-ACH, ePay-Virtual Card, and ePay-eCheck.

  • CheckClearedDate string

    The date that the reimbursent check was put into the bank account.

  • SetlDate string

    The date that the reimbursement was settled on.

The Try It feature is available in the beta Developer Portal. To use it, navigate to the beta version of this page.

AI Assistant Preview

Generating response...