v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
card-sensitive-details

Get card PIN

Fetches the card's PIN.

Requires an encrypted JWE payload for security. See the sensitive card details guide for implementation details.

{% admonition type="warning" %} This endpoint is SCA protected when applicable. If your profile is registered within the UK and/or EEA, SCA most likely applies. For more information, see implementing SCA. {% /admonition %}

post/twcard-data/v1/sensitive-card-data/pin

Headers

x-tw-twcard-card-tokenstring uuid required

The card token identifying which card to retrieve the PIN for.

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

keyVersioninteger required

The version of the encryption key to use. Always set to 1.

encryptedPayloadstring required

Your JWE encrypted payload.

Example request

{
  "keyVersion": 1,
  "encryptedPayload": "<your JWE>"
}

Response

Card PIN retrieved successfully.

noncestring uuid

An arbitrary UUID issued from the cryptographic communication.

pinstring

The card PIN.

Example response

{
  "nonce": "33d51227-9ad6-4624-b4b7-7853b56076dd",
  "pin": "1234"
}