> ## Documentation Index
> Fetch the complete documentation index at: https://docs-payment-merchant.keysecure.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Physical Card PIN

Sets the physical card PIN. Only **physical cards** (`Physical`) are supported, and the card status must be normal (`Activated`). The `pin` must be encrypted with **AES/ECB/PKCS5Padding + Base64** before being passed in.

<Note>
  * Only physical cards are supported; calling this endpoint for a virtual card returns **4017**.
  * The plaintext PIN must be **exactly 6 digits**, and must not contain three or more identical or sequential digits (for example, `111111` or `123456`); otherwise **4016** is returned.
  * The card status must be `Activated`; otherwise **4005** is returned.
  * See the "Code Utilities" section for encryption algorithm details.
</Note>

## Request Headers

<ParamField header="Api-Key" type="string" required placeholder="your_api_key">
  apiKey (merchant credential, bound to IP whitelist)
</ParamField>

<ParamField header="Timestamp" type="string" required>
  Unix timestamp in milliseconds. The deviation from the server time must be within 60 seconds, and future timestamps are not accepted.
</ParamField>

<ParamField header="Access-Token" type="string" required placeholder="your_access_token">
  Login token (required for all interfaces except Get Token).
</ParamField>

<ParamField header="Content-Type" type="string" default="application/json">
  Fixed to `application/json`
</ParamField>

## Request Body

<ParamField body="card_no" type="string" required>
  Card order number.
</ParamField>

<ParamField body="cardholder_no" type="string" required>
  Cardholder order number.
</ParamField>

<ParamField body="pin" type="string" required placeholder="Base64EncodedEncryptedPin...">
  Encrypted PIN (Base64 ciphertext).
</ParamField>

## Response Parameters

<ResponseField name="code" type="number">
  Response status code. `0` indicates success.
</ResponseField>

<ResponseField name="msg" type="string">
  Response message.
</ResponseField>

<ResponseField name="data" type="object">
  Response data.

  <Expandable title="data">
    <ResponseField name="result" type="boolean">Setting result</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash Request theme={null}
  curl --request POST \
    --url https://sandbox-openplatform.keysecure.io/open-api/v1/card/pin/set \
    --header 'Content-Type: application/json' \
    --header 'Api-Key: your_api_key' \
    --header 'Timestamp: 1716307200000' \
    --header 'Access-Token: your_access_token' \
    --data '{
      "card_no": "C202605220001",
      "cardholder_no": "U202605220001",
      "pin": "Base64EncodedEncryptedPin..."
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "code": 0,
    "msg": "Success",
    "data": {"result": true}
  }
  ```
</ResponseExample>