Manage PINs

Retrieve or update a given card's Personal Identification Number (PIN).

Retrieve a card's PIN

Get/v2/cards/{cardId}/pin

Request

Use this request to retrieve the PIN for a given card.

Sample requestRequest structure

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/pin?accountId=F12345&personId=775596ae-2624-40af-a9dc-9756110a4a04&cardholderVerificationMethod=BIOMETRIC_FACE' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/{cardId}/pin?accountId={accountId}&personId={personId}&cardholderVerificationMethod={cardholderVerificationMethod}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

Parameter	Description
`cardId` string required	The ID of the card that you want to retrieve the PIN for. Allowable values: An existing `cardId` (<= 36 characters)

Query parameters

Parameter	Description
`accountId` string required	The ID of the account associated with the card. Allowable values: An existing `cardId` (<= 36 characters)
`personId` string required	The ID of the person who owns the card. Allowable values: An existing `personId` (<= 36 characters)
`cardholderVerificationMethod` string required	The method that was used to verify the identity of the cardholder. Allowable values: `BIOMETRIC_FACE`, `BIOMETRIC_FINGERPRINT`, `LOGIN`

Response

If your request is successful, you'll receive a 200 response containing the pin.

Sample responseResponse structure

Copy

Copied

{
  "pin": "7268"
}

Copy

Copied

{
  "pin": "string"
}

For more detailed information about this request and its response, see the API reference.

Update a card's PIN

Put/v2/cards/{cardId}/pin

Request

Use this request to update the PIN of a card on a given account where an accountId and cardId are provided.

Sample requestRequest structure

Copy

Copied

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/pin?accountId=F12345&personId=775596ae-2624-40af-a9dc-9756110a4a04' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pin": "7268"
  }'

Copy

Copied

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/{cardId}/pin?accountId={accountId}&personId={personId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pin": "string"
  }'

Path parameters

Parameter	Description
`cardId` string required	The ID of the card that you want to update the PIN for. You can get the `cardId` when you view card details. Allowable values: An existing `cardId` (<= 36 characters)

Query parameters

Parameter	Description
`accountId` string required	The ID of the account associated with the card. Allowable values: An existing `accountId` (<= 36 characters)
`personId` string required	The ID of the person that the card belongs to. Allowable values: An existing `personId` (<= 36 characters)

Request body schema

Parameter	Description
`pin` string	The new card PIN. If not provided, we'll randomly generate one for you. Allowable values: 4 characters (`^\d+$`)

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure

Copy

Copied

{
  "success": true
}

Copy

Copied

{
  "success": boolean
}

For more detailed information about this request and its response, see the API reference.