Skip to content

Update PIN

Endpoint

POST/api/v1/merchant/cards/{cardId}/pin/

Update the PIN for a specified card.

Path Parameters

Name Type Required Description
cardId string The unique identifier for the card for which you want to update the PIN.

Request Body

{
  "pin": "string"
}

Body Parameters

Name Type Required Description
pin string The 4-12 digit PIN for transactions and ATM withdrawals. Must follow the specific rules explained below

PIN Rules

  • Length: 4–12 digits.
  • Non-consecutive identical digits: No more than two identical digits in non-consecutive positions (e.g., 124758).
  • Consecutive repeated digits: No more than two repeated digits in a row (e.g., 112441).

Example Request

PUT /api/v1/merchant/cards/5398472c-f898-48da-b5a6-e066dd85bd13/pin/
Content-Type: application/json
x-payments-api-key: 22bfefe264f4ce9fb5d07d09ad92cea60a0ff489

{
  "pin": "4859"
}

Response

{
  "message": "PIN updated successfully"
}

Response Codes

Status Code Description
200 OK PIN updated successfully.
400 Bad Request Invalid PIN format or constraints not met.
401 Unauthorized Authentication failed.
404 Not Found Card not found.
500 Internal Server Error Server error.