Skip to main content
POST
Set a card's PIN
Send the new four-digit PIN; it replaces the current one, and the cardholder uses it at the next purchase or withdrawal that asks for it. Only EMBOSSED cards have a PIN. Use default as walletId for the organization’s main wallet, and send x-environment: LIVE for a production card. Any member of the organization can set a card’s PIN.

Headers

x-environment
enum<string>

Environment of the card: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the card belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
walletId
string
required

ID of the card's wallet (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$
cardId
string
required

ID of the physical card (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
pin
string
required

New PIN of the card: exactly four digits, sent as a string.

Minimum string length: 1
Pattern: ^\d{4}$
Example:

"4096"

Response

No Content. The operation succeeded and the response has no body.