Set or change a card's PIN from a PIN-pad block

POST/cards/{id}/pin

Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod. The PIN never leaves the HSM; only the IBM 3624 offset or Visa PVV is stored.

Path parameters

idstringRequired

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

current_pin_blockstringOptional

methodstringOptional

pin_blockstringRequired

pin_block_formatstringRequired

zone_key_indexstringRequired

Returns

200 OK

card_idstringRequired

Example card_2tVh8nqLxq4GbDe0K1F6S9zRcWm

changed_atstring · date-timeRequired

locked_atstring · date-time or nullOptional

methodstringRequired

pvk_key_idstringRequired

pvkiintegerRequired

set_atstring · date-timeRequired

statusstringRequired

triesintegerRequired

try_limitintegerRequired

unlocked_atstring · date-time or nullOptional

unlocked_bystringOptional

updated_atstring · date-timeRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503