Change card PIN

Sets a new 4-digit PIN on a physical card. Authorized for admins, holders of
the vendor_cards_manage permission, or the cardholder.

The pin parameter is required (missing → 412, from
params.require(:pin)). It must match
^\d\d\d\d$ and the card's vendor must support PIN updates; otherwise the
endpoint returns 422 with
{ "error_code": "vendor_cards/pin_not_supported" }. Vendor-side failures
return 500 with the vendor's message.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the vendor card

Body Params

Payload to change a physical card's PIN.

string
required

The new 4-digit PIN. Must match ^\d\d\d\d$. Only cards whose vendor
supports PIN updates accept this; others return 422.

Headers
uuid
required

UUID of the company that owns the card.

Responses

401

Unauthorized

404

Vendor card not found (or not visible to the caller).

412

Precondition Failed — pin parameter is missing (params.require(:pin)). Body: { "message": "param is missing or the value is empty or invalid: pin" }.

422

Unprocessable Entity — card does not support PIN updates or pin is not a 4-digit string. { "error_code": "vendor_cards/pin_not_supported" }.

500

Internal Server Error — the issuing vendor rejected the PIN change. Body carries the vendor message.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json