Update a card's PIN - Equals Money Documentation

PUT

cards

{cardId}

Update a card's PIN

curl --request PUT \
  --url https://api.equalsmoney.com/v2/cards/{cardId}/pin \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pin": "stri",
  "cardholderVerificationMethod": "BIOMETRIC_FACE",
  "mfa": {
    "sessionId": "c92e2960-b745-4b38-8e77-898b2f9ad9bb",
    "token": "123456"
  }
}
'

{
  "success": true,
  "pin": "stri"
}

Authorizations

Authorization

string

header

required

Path Parameters

cardId

string<uuid>

required

The ID of the card to work with.

Maximum string length: 36

Example:

"e9293471-5eb3-4dbc-916c-dbaf9e2deefd"

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

personId

string<uuid>

required

The ID of the person to work with.

Maximum string length: 36

Example:

"775596ae-2624-40af-a9dc-9756110a4a04"

Body

application/json

Body

Request body for creating a PIN

string

The new card PIN. If not provided, we'll randomly generate one for you.

Required string length: 4

Pattern: ^\d+$

cardholderVerificationMethod

enum<string>

The supplemental method used to verify the cardholder’s identity before revealing the card’s PIN.

Available options:

BIOMETRIC_FACE,

BIOMETRIC_FINGERPRINT,

LOGIN,

OTP

Example:

"BIOMETRIC_FACE"

mfa

object

Show child attributes

Response

200 - application/json

success

boolean

required

Indicates the outcome of the operation.

string

required

The updated card PIN.

Required string length: 4

Pattern: ^\d+$

⌘I

Update a card's PIN

curl --request PUT \
  --url https://api.equalsmoney.com/v2/cards/{cardId}/pin \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pin": "stri",
  "cardholderVerificationMethod": "BIOMETRIC_FACE",
  "mfa": {
    "sessionId": "c92e2960-b745-4b38-8e77-898b2f9ad9bb",
    "token": "123456"
  }
}
'

{
  "success": true,
  "pin": "stri"
}