---
title: "Set ATM Pin for Payment Instrument"
method: PUT
path: "/programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}"
tags: ["PaymentInstrument"]
---

# Set ATM Pin for Payment Instrument

`PUT /programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}`

Set and Reset an ATM Pin This endpoint gives the partner the ability to update the ATM pin data of a payment instrument.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `paymentInstrumentIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- SetPinRequestEncrypted — Represents a request to set or reset the ATM PIN for a payment instrument using an encrypted PIN value.
  - `encryptedPin` EncryptedData — Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.
    - `version` string, nullable — The version of the encryption algorithm used to encrypt the data (e.g., "v1", "v2").
    - `ephemeralPublicKey` string, nullable — The ephemeral public key used in the encryption process, typically for key exchange or session establishment.
    - `publicKeyHash` string, nullable — The hash of the public key used to verify the integrity and authenticity of the encryption key.
    - `data` string, nullable — The encrypted data payload, typically base64-encoded, containing the sensitive information.
  - `channel` 'Unknown' | 'IVR' | 'Mobile' | 'PCIWidget' | 'Web', nullable — The channel through which the PIN set request is initiated (e.g., IVR, Mobile, Web).

## Response `200`

OK

- SetPinResponse — Represents the response for a Set PIN operation on a payment instrument.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)