Participant APIs | REST

Version:
Download Open API Specification

Return the list of provider based on the search criteria.

https://api.wealthcare.com/participant/services/payprovider/search/{tpaId}

Return the list of provider based on the search criteria.

  • tpaId string Required

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

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

  • SearchField enum<string>
    Possible values: ProviderId ProviderName Address City State Zip Phone ProviderEIN StatusCode
  • SearchText string
  • OperationMode enum<string>
    Possible values: AdimMaintenance AdminProcessing ParticipantProcessing
  • StartOrdinalPosition integer <int32>
  • NumRowsReturn integer <int32>
  • PayProviders array <object>
    • TpaId string

      Unique identifier that WealthCare Admin assigns to you.

    • PayProviderKey integer <int32>

      Unique identifier key of Pay Provider

    • ProviderId string

      Unique identifier of Pay Provider

    • ProviderName string

      Name associated with Pay Provider

    • Addr1 string

      First line of the Pay provider's address.

    • Addr2 string

      Second line of the Pay provider's address.

    • City string

      City associated with the Pay provider's address.

    • State string

      Two-character state code associated with the Pay provider's address.

    • Zip string

      ZIP code associated with the Pay provider's address.

    • CountryCde string

      Country associated with the Pay provider's address, usually US.

    • Phone string

      Pay provider's phone number, including area code.

    • ProviderEin string

      Unique identification number of Pay Provider

    • StatusCde enum<string>

      Status Code of Pay Provider : New = 1,Active = 2,Inactive = 3

      Possible values: New Active Inactive
    • StatusDesc string

      Description of the Status

    • InsertFirstName string

      First Name associated with Pay Provider

    • InsertLastName string

      Last Name associated with Pay Provider

    • LastUpdateDte string <date-time>

      The last update date for the Pay Provider record

    • BillingNPINumber string

      Billing NPI Number associated with Pay Provider

    • ParticipantId string

      Optional participant identifier for use when a Partner is saving a Pay Provider on behalf of a participant

    • EmployerId string

      Optional employer identifier for use when a Partner is saving a Pay Provider on behalf of a participant

  • TotalRowCount integer <int32>