Get card pin
Retrieve the participant's PIN for the currently issued card, identified by TPA ID, Employer ID, and Participant ID. This operation is typically used when a participant needs to access their card PIN for transactions or account management.
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.
-
card string Required
The proxy number of the card, which can be retrieved using the Get Card Summary API. This parameter is required to identify the specific card for which the PIN is being requested.
-
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.
-
asText integer <int32>
Specify the format in which the PIN should be returned: 0 for image format and 1 for text format. Defaults to 0, which returns the PIN as an image.