Set Card PIN

POST 
/api/cards/:cardId/set-pin

Set a new PIN on a card.

---

The following validation rules are applied to the new PIN:

• Must be exactly four digits
• Can not be a repeating sequence: 0000, 1111, 2222, 3333, 4444, 5555, 6666, 7777, 8888, or 9999
• Where Y, M, and D represent the customer's date of birth with the format Y1Y2Y3Y4-M1M2-D1D2, the PIN digits should not use the formats Y1Y2Y3Y4, M1M2D1D2, Y3Y4M2D2, Y3Y4M1M2. For example, if the date of birth is 1 April 1963 the following will not be accepted: 1963, 0401, 6341, 6304
• Can not be the same as the last four digits of the PAN
• Can not match any part of the customer's phone number(s)
• Can not match any part of any reference number for the customer

---

Request

Path Parameters

cardId stringrequired

ID of card

application/json

Body

newPin stringrequired

New PIN to set on the card

Responses

200

Successful operation

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired

errors

object[]

Array [

message string

path string

The location of the invalid path param, query param or payload attribute.

]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

403

User is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN The card or cardholder does not exist or the user has insufficient permissions.

LIVENESS_MISMATCH Resource liveness does not match request liveness.

INVALID_PIN_FORMAT The PIN did not pass the validation rules.

CARD_SET_PIN_FORBIDDEN The card is blocked, expired, or not active.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...