PIN Request – Function PINRequest
A PINRequest results in card related data being sent to a card vendor in a file. The Card vendor in turn forwards PIN information to the cardholder.
There are 2 ways to issue a pin request through the AE CardAPI:
1. Place “PR” in parameter P25 in function 036.
2. Use the API function “PINRequest.”
Currently the function 036 makes no effort to handle any errors from a pin request service call. It will simply continue to process the cardholder update returning a positive response if the update was successful. It is best to use API function PINRequest over 036 to request a PIN.
| Inputs | Description | Required | Data Type |
|---|---|---|---|
| FunctionID | PINRequest | Y | |
| P1 | Primary Account Number | Y | (16,19) numeric |
| Outputs | Description | ||
| P1 | Error Code | Y | |
| P2 | Error Text | Y |
Example: PINRequest
https://api.m2fin.com:8443/AuthENGINAPI/AuthENGINAPI?CID=5&CUSR=myuseraccount&CPWD=passwor
dassignedtome&FUNC=PINRequest&MSGID=00001489067437827&P1=PAN or AlT ID
dassignedtome&FUNC=PINRequest&MSGID=00001489067437827&P1=PAN or AlT ID
Example: PINRequest Response
P1=0000&P2=PIN Request Successful
P1=620&P2=PIN RequestClient Error = (ERROR DETAILS GO HERE)
Example: P1=6201&P2=PIN RequestClient Error = Authorization Failed
The Authorization Failed (highlighted above for emphasis) error is returned when the user is not configured with a role that supports the use of pin requests.
P1=090&P2=Inadequate permissions to execute this function.
The above error is referencing that the API user does not have the PINRequest function assigned. Another significant error that may come from the service is:
P1=6201&P2=PIN RequestClient Error = Cannot process Pin Request – CardHolder address has recently changed
The service checks if there has been a recent address change. If there has the service will not send the pin. This was a business requirement implemented to protect the pin. It also reinforces the need to use the API function PINRequest over function 036 since any minor change may result in the appearance of change.