---
title: "Unblock PIN [EXPERIMENTAL]"
method: POST
path: "/cardManagement/actions/pinUnblock"
tags: ["Card Management"]
---

# Unblock PIN \[EXPERIMENTAL\]

`POST /cardManagement/actions/pinUnblock`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/cardManagement/actions/pinUnblock`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/cardManagement/actions/pinUnblock/post.ts> (a function with typed inputs; its response is checked against the schema)

Unblock the PIN on a card.

Permissions: `cardManagement:Create`, `cardManagement:All`

## Request body

- PinUnblockRequest
  - `merchantAcceptorResolver` union, required: The resolver is used to select the appropriate merchant acceptor for the action. It can accept either a `merchantAcceptorKey` or a combination of `merchantKey` and an optional `route`. If the optional property for `route` is not provided the default one generated when creating an acceptor will be used.
    - MerchantAcceptorKeyResolver: Used to select a merchant acceptor by key.
      - `merchantAcceptorKey` string, required: Uniquely identifies a merchant acceptor.
    - MerchantKeyResolver: Used to select a merchant acceptor by merchant key and an optional route.
      - `merchantKey` string, required: Uniquely identifies a merchant.
      - `route` string: Route key used to uniquely reference an acceptor when used in combination with its card network and merchant key.
  - `card` ComponentsSchemasCard, required: Card details for ATM transactions.
    - `number` string, required: The primary account number (PAN) of the card.
    - `expiryMonth` integer, required: The expiry month of the card (1-12).
    - `expiryYear` integer, required: The expiry year of the card (four digits).
  - `terminalEntryMode` 'chip' | 'contactless' | 'magstripe' | 'magstripe_fallback' | 'contactless_magstripe', required: The method used for PAN entry on the ATM terminal. When set to `chip` or `contactless`, `emvData` is required.
  - `terminal` SchemasTerminal, required: Details about the ATM terminal.
    - `id` string, required: ATM terminal's ID
    - `capabilities` SchemasTerminalCapability[], required: The capabilities of the ATM terminal. This can be one or multiple.
  - `localTransactionDateTime` string, iso-8601-date-time: Date and time of the transaction in the local timezone.
  - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.
  - `track2Data` string: The information encoded on track 2 of the card magnetic stripe as defined in the ISO 7813 specification, including data element separator but excluding the beginning and ending sentinels and the LRC (Longitudinal Redundancy Check) character. This property is mandatory when the `terminalEntryMode` is `chip`, `contactless` or `magstripe`.
  - `cardSequenceNumber` string: Distinguishes among separate cards having the same PAN. This is required if EMV tag 5F34 is present/personalized on the card chip.
  - `emvData` string: This field contains integrated circuit card (ICC) related binary data that is transmitted from the ICC to the card issuer and from the card issuer to the ICC. This field is formatted as 510 hexadecimal characters, which translates to 255 bytes. Required if `terminalEntryMode` is `chip` or `contactless`.
  - `pinBlock` SchemasPinBlock, required: PIN block related data in `ISO-4` format.
    - `format` 'ISO-4', required: The PIN block format.
    - `block` string, required: The encrypted PIN, as an `ISO-4` block of 32 hexadecimal characters.
    - `zoneId` string, required: ID of the encryption zone.
    - `keyId` string, required: Encryption key in the specified zone to use.

## Response `201`

Created

- CreatePinUnblockResponse
  - `key` string, required: Uniquely identifies a card-management action.
  - `type` 'pin_unblock', required
  - `result` 'approved' | 'declined', required: The result of the authorization.
  - `card` MaskedCard, required: Card data for ATM transactions. ATM transactions do not support processor tokenization.
    - `maskedNumber` string, required: The card number used to create this action, masked according to PCI standards. For card numbers with 16 or more digits, the first 8 and the last 4 digits are visible. For card numbers with 13-15 digits, the first 6 and the last 4 digits are visible. For cards numbers with less than 13 digits, the first 6 and last 2 digits are visible.
  - `merchantAcceptorRef` MerchantAcceptorRef, required
    - `key` string, required: Uniquely identifies a merchant acceptor.
    - `version` integer, required: The version of this object
  - `terminalEntryMode` 'chip' | 'contactless' | 'magstripe' | 'magstripe_fallback' | 'contactless_magstripe', required: The method used for PAN entry on the ATM terminal. When set to `chip` or `contactless`, `emvData` is required.
  - `terminal` SchemasTerminal, required: Details about the ATM terminal.
    - `id` string, required: ATM terminal's ID
    - `capabilities` SchemasTerminalCapability[], required: The capabilities of the ATM terminal. This can be one or multiple.
  - `transactionReference` string: Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.
  - `authorizationIsoFields` AuthorizationIsoFields, required: The values from the ISO8583 response message received from the network.
    - `responseCode` string, required: Contents of field 39
    - `responseCodeDescription` string, required: The description of the `responseCode`
    - `authorizationCode` string: Contents of field 38
    - `networkCode` string, required: Contents of field 63, subfield 1
    - `systemTraceAuditNumber` string, required: Contents of field 11
    - `retrievalReferenceNumber` string, required: Contents of field 37
    - `networkSpecificFields` union, required
      - VisaNetworkFields: Visa specific ISO8583 raw values
        - `network` 'visa', required: Card network
        - `transactionIdentifier` string, required: Contents of field 62, subfield 2
      - MastercardNetworkFields: Mastercard specific ISO8583 raw values
        - `network` 'mastercard', required: Card network
        - `banknetReference` string, required: Contents of field 63, subfield 2
        - `traceId` string, required: The trace ID can be used to refer to the original authorization when reversing it. The value is constructed from the contents of field 63, subfield 1, field 63, subfield 2, and field 15. The value intentionally ends with two spaces.
  - `newEmvData` string: This field contains integrated circuit card (ICC) related binary data that is transmitted from the card issuer to the ICC. This field is formatted as 510 hexadecimal characters, which translates to 255 bytes. If this field is present in the response message, it should be passed without modification to the ICC.
  - `localTransactionDateTime` string, iso-8601-date-time: Date and time of the transaction in the local timezone.
  - `created` string, iso-8601-date-time, required: The date and time this object was created
  - `version` integer, required: The version of this object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)