PIN Control - Field Descriptions

The following tables describe the fields in the request and the response for the PIN Control endpoint.

Request

The following table describes the fields that can be included in the request.

Field	Description	Type	Min Length	Max Length	Mandatory
wsid	The web service ID. This must be unique for every request sent. You can set your own wsid, for example by using the current date and time (20250213145006), or you can leave the field blank and Thredd generates the wsid for you.	N	0	19	No
AuthType	Parameter to specify how the card should be authenticated: 1 = Card number (PAN) or public token 2 = Card number/public token & cardholder’s date of birth 3 = Card number/public token & CVC2 4 = Card number/public token & access code 5 = Login ID 6 = Card number and cardholder’s date of birth and cardholder’s last name 7 = Full Track2 8 = Card number & security data	AN	1	1	No
DOB	Date of Birth of the cardholder. Mandatory if value of AuthType is 2 or 6.	YYYY-MM-DD	10	10	Conditional
PAN	Card Number. Required in request if AuthType is 1, 2, 3, 4 or 6 and PublicToken not present.	AN	14	19	Conditional
PublicToken	The card’s public token. Mandatory in request if PAN is not present.	AN	1	9	Conditional
ClientCode	User ID of the customer using the service. Only applicable to systems using member logins.	AN	1	64	Conditional
Func	The PIN function requested. This should be set to 05. This sends a PIN mailer to your cardholder. This is to instruct your Card Bureau to send the PIN in the post to the cardholder.	AN	1	2	Yes
CurrentPin	Current PIN. Represented as a 4-12 digit PIN block. Usage depends on the value of the func field. This field is mandatory in the request for function 02. For all other functions, this field is ignored.	AN	4	12	Conditional
NewPin	New PIN. Represented as a 4-12 digit PIN block. Usage depends on the value of the func field. This field is mandatory in the request for functions 00 and 02. For all other functions, this field is ignored.	AN	4	12	Conditional
ConfirmPin	Confirmation of new PIN. Represented as a 4-12 digit PIN block. Usage depends on the value of the func field. This field is mandatory in the request for functions 00 and 02. For all other functions, this field is ignored.	AN	4	12	Conditional
FeeWaiver	Indicates whether to waive any web service fee set up on the system: 0 = No, 1=Yes. Default is 0.	N	1	1	No
IssCode	Thredd Issuer (Program Manager) Code. Assigned by Thredd.	Y	1	4	Yes
LocDate	The local current date in year-month-date format.	Y	6	6	Yes
LocTime	The local current time, in hour-minute-second format.	Y	10	10	Yes

Response

The following table describes the fields that are included in the response.

Field	Description
PublicToken	The card's public token.
PINStatus	Indicates whether the allowed number of card PIN tries has been exceeded. 0 = No; 1 = Yes.
ActionCode	The action code for the response. This indicates whether the call has updated the Thredd database. For more information, see Action Codes.