Set PIN Control

The Set PIN Control endpoint enables you to set, retrieve, unblock and change the PIN associated with the card. It also allows you to unblock the CVC2 of a card or mobile device token.

You can set the PIN control for a card by making a POST request to the endpoint. For example:

{{base-url}}/ws/api/v1/WS_PinControl

The request body must include the function value, which specifies the kind of function you're performing. The following table describes each of the functions available for the endpoint.

PIN Function	Description
00	Enables you to set the PIN for the card. The field NewPin and ConfirmPin must be included in the request when using this function.
01	Enables you to retrieve the PIN for the card.
02	Enables you to change the PIN for the card. The fields NewPin, ConfirmPin and CurrentPin must be included in the request when using this function.
03	Enables you to create a card and retrieve the PIN in the response.
04	Enables you to unblock the PIN for the card.
05	Enables you to send the PIN in the post to the cardholder.
06	Enables you to forward the PIN to an external API.
07	Enables you to unblock the CVC2 for the card.
08	Enables you to unblock the PIN and CVC2 of the card.

The following example shows sending the PIN to the cardholder in the post, signified by the Func value being set to 05

{
    "wsid": "20250213145006",
    "AuthType": "2",
  	"DOB": 1982-11-03,
    "PublicToken": "123456789",
    "Func": "05",
    "IssCode": "PMT",
    "LocDate": "2025-01-01",
    "LocTime": "120000", 
}

A successful response returns a HTTP 200 response code. Below is an example response:

{
    "PublicToken": "123456789",
    "ActionCode": "000"
}

📘
More Information

For detailed field descriptions for the fields in the request and response, see PIN Control - Field Descriptions.

To view the endpoint in API Explorer, see Card PIN Control.

Updated 7 days ago

📘More Information

📘
More Information