Card PIN Control

post

https://uat-api.thredd.com/ws/api/v1/WS_PinControl

This web service enables you to set, retrieve, unblock and change the PIN associated with a card. It also allows you to unblock the CVC2 of a card or mobile device token.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Documentation
For more information on the Card PIN Control endpoint, see Set PIN Control.

Body Params

Schema for None

IssCode

string

required

length between 1 and 4

Thredd Issuer (Program Manager) Code. Assigned by Thredd.

PAN

string

required

length between 14 and 19

Card Number. Required in request if AuthType is '1', '2', '3','4' or '6' and PublicToken not present.

PublicToken

string

required

length between 1 and 9

The card's public token. Mandatory in request if PAN is not present.

ClientCode

string

required

length between 1 and 64

User ID of the customer using the service. Only applicable to systems using member logins. Legacy field, not used.

Func

string

enum

required

length between 1 and 2

PIN function requested: 00 = Set PIN, 01 = Get PIN, 02 = Change PIN, 03 = Generate and Get PIN, 04 = Unblock PIN, 05 = Send PIN mailer, 06 = Forward PIN request to external API, 07 = Unblock CVC2, 08 = Unblock PIN and CVC2

CurrentPin

string

required

length between 4 and 12

Current PIN. Represented as a 4-12 digit PIN block. This field is mandatory in the request for function 02 (Change PIN).

NewPin

string

required

length between 4 and 12

New PIN. Represented as a 4-12 digit PIN block. This field is mandatory in the request for functions 00 (Set PIN) and 02 (Change PIN).

ConfirmPin

string

required

length between 4 and 12

Confirmation of new PIN. Represented as a 4-12 digit PIN block. This field is mandatory in the request for functions 00 (Set PIN) and 02 (Change PIN).

AuthType

string

required

length between 1 and 1

Parameter to specify how the card is authenticated. See PIN Control - Field Descriptions.

DOB

date

required

length between 10 and 10

Date of Birth in YYYY-MM-DD format. Mandatory if value of AuthType is '2' or '6'.

FeeWaiver

string

enum

required

length between 1 and 1

Indicates whether to waive any web service fee set up on the system. 0 = No, 1 = Yes. Default is 0.

Allowed:

Responses

400

Invalid request

401

Unauthorized - Authentication required

500

Internal server error

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

Documentation

200Successful response