Card Management

Unblock PIN [EXPERIMENTAL]

Unblock the PIN on a card.

Permissions: cardManagement:Create, cardManagement:All

post/cardManagement/actions/pinUnblock

Request

Request body

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.

localTransactionDateTimestring iso-8601-date-time

Date and time of the transaction in the local timezone.

transactionReferencestring

Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.

track2Datastring

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.

cardSequenceNumberstring

Distinguishes among separate cards having the same PAN. This is required if EMV tag 5F34 is present/personalized on the card chip.

emvDatastring

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.

Example request

{
  "merchantAcceptorResolver": {
    "merchantAcceptorKey": "mac-1eOdAHhgstYTUhlphPFf"
  },
  "card": {
    "number": "5286940020000205",
    "expiryYear": 2030,
    "expiryMonth": 12
  },
  "terminalEntryMode": "contactless",
  "terminal": {
    "id": "ATM001",
    "capabilities": [
      "contact_chip",
      "contactless_chip",
      "magstripe"
    ]
  },
  "track2Data": "5286940020000205D30122010123456789",
  "emvData": "820219808407A00000000410109505000000800101020880",
  "pinBlock": {
    "format": "ISO-4",
    "block": "32CF86E514CB24FE32CF86E514CB24FE",
    "zoneId": "atm-gateway",
    "keyId": "0001"
  }
}

Response

Created

keystring required

Uniquely identifies a card-management action.

type'pin_unblock' required
result'approved' | 'declined' required

The result of the authorization.

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.

transactionReferencestring

Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.

newEmvDatastring

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.

localTransactionDateTimestring iso-8601-date-time

Date and time of the transaction in the local timezone.

createdstring iso-8601-date-time required

The date and time this object was created

versioninteger required

The version of this object

Example response

{
  "key": "cma-4qlTL3c3FT0AUjZN5HXa",
  "type": "pin_unblock",
  "result": "approved",
  "card": {
    "maskedNumber": "52869400****0205"
  },
  "merchantAcceptorRef": {
    "key": "mac-1eOdAHhgstYTUhlphPFf",
    "version": 1
  },
  "terminalEntryMode": "contactless",
  "terminal": {
    "id": "ATM001",
    "capabilities": [
      "contact_chip",
      "contactless_chip",
      "magstripe"
    ]
  },
  "authorizationIsoFields": {
    "responseCode": "00",
    "responseCodeDescription": "Approved",
    "authorizationCode": "547159",
    "networkCode": "MCS",
    "systemTraceAuditNumber": "665357",
    "retrievalReferenceNumber": "326312665357",
    "networkSpecificFields": {
      "network": "mastercard",
      "banknetReference": "842824",
      "traceId": "MCS8428240527  "
    }
  },
  "newEmvData": "9F1A0208409F02060000000001009F21031104",
  "localTransactionDateTime": "2026-07-13T12:46:05.516Z",
  "created": "2026-07-13T12:46:05.516Z",
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.