Skip to main content
PUT
Update card PIN
Requires Authorization: Bearer <user-access-token> — the token from Verify login code.
Pass x-idempotency-key with a unique UUID per request. Without it, duplicate-request detection is skipped and a retried call may change the PIN twice.
The PIN must be 4 to 12 digits. When no cardId is sent, the new PIN is applied to every active card the user has, not just the primary card.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-idempotency-key
string<uuid>
required

Unique idempotency key for the operation. Use a UUID to prevent duplicate processing.

Query Parameters

cardId
string

Target a specific card (Rain card id) instead of the primary card.

Body

application/json

New PIN, 4 to 12 digits.

pin
string
required

New PIN, 4 to 12 digits.

Pattern: ^\d{4,12}$
Example:

"9876"

Response

PIN updated successfully.

success
boolean
required
Example:

true

cardId
string<uuid> | null

Representative card id when no cardId was targeted.

last4
string | null
Example:

"8567"

updatedCount
integer

Number of active cards updated (present when no cardId is sent).

Example:

1

failedCount
integer
Example:

0

results
object[]