> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spritz.finance/llms.txt
> Use this file to discover all available pages before exploring further.

# Get card PIN

> Retrieves the encrypted card PIN.

**Encryption:**
The PIN is returned as an AES-128-GCM encrypted payload. Use the session's AES key to decrypt it.

**PIN Block Format (ISO 9564-1 Format 2):**
After decryption, the plaintext is a 16-character PIN block with the following structure:
- Byte 0: Control field (`2` indicates Format 2)
- Byte 1: PIN length in hexadecimal (4-12)
- Bytes 2-(1+N): The actual PIN digits
- Remaining bytes: Padding (`F`)

**Example:**
A 4-digit PIN "1234" would be encoded as: `241234FFFFFFFFFF`

**Parsing the PIN block:**
```
const pinLength = parseInt(pinBlock[1], 16);
const pin = pinBlock.slice(2, 2 + pinLength);
```



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json post /v1/cards/{cardId}/pin
openapi: 3.0.3
info:
  title: Spritz Finance API
  version: 1.0.0
  description: API for the Spritz Finance platform with RFC 9457 error handling
servers:
  - url: https://platform.spritz.finance
    description: Production
  - url: https://sandbox.spritz.finance
    description: Sandbox
security: []
tags:
  - name: Users
    description: User management endpoints
  - name: Bank Accounts
    description: Manage bank accounts for off-ramp destinations
  - name: Bills
    description: Manage bill pay accounts
  - name: Cards
    description: Spritz-issued debit cards
  - name: Auto-Ramp Accounts
    description: Virtual bank accounts that automatically convert fiat deposits to crypto
  - name: Spritz App
    description: >-
      Endpoints used by the Spritz app and internal SDKs. Excluded from the
      public partner spec.
paths:
  /v1/cards/{cardId}/pin:
    post:
      tags:
        - Cards
      summary: Get card PIN
      description: >-
        Retrieves the encrypted card PIN.


        **Encryption:**

        The PIN is returned as an AES-128-GCM encrypted payload. Use the
        session's AES key to decrypt it.


        **PIN Block Format (ISO 9564-1 Format 2):**

        After decryption, the plaintext is a 16-character PIN block with the
        following structure:

        - Byte 0: Control field (`2` indicates Format 2)

        - Byte 1: PIN length in hexadecimal (4-12)

        - Bytes 2-(1+N): The actual PIN digits

        - Remaining bytes: Padding (`F`)


        **Example:**

        A 4-digit PIN "1234" would be encoded as: `241234FFFFFFFFFF`


        **Parsing the PIN block:**

        ```

        const pinLength = parseInt(pinBlock[1], 16);

        const pin = pinBlock.slice(2, 2 + pinLength);

        ```
      operationId: postV1CardsByCardIdPin
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            minLength: 1
            description: The id of the card whose pin is being requested
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                encryptedKey:
                  minLength: 1
                  description: >-
                    Base64-encoded RSA-encrypted AES-128 key used for PIN
                    decryption
                  type: string
              required:
                - encryptedKey
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                encryptedKey:
                  minLength: 1
                  description: >-
                    Base64-encoded RSA-encrypted AES-128 key used for PIN
                    decryption
                  type: string
              required:
                - encryptedKey
          multipart/form-data:
            schema:
              type: object
              properties:
                encryptedKey:
                  minLength: 1
                  description: >-
                    Base64-encoded RSA-encrypted AES-128 key used for PIN
                    decryption
                  type: string
              required:
                - encryptedKey
      responses:
        '200':
          description: >-
            The encrypted PIN block for the card. When decrypted, the plaintext
            is an ISO 9564-1 Format 2 PIN block.
          content:
            application/json:
              schema:
                description: >-
                  The encrypted PIN block for the card. When decrypted, the
                  plaintext is an ISO 9564-1 Format 2 PIN block.
                type: object
                properties:
                  encryptedPin:
                    type: object
                    properties:
                      iv:
                        minLength: 1
                        description: >-
                          Base64-encoded initialization vector for AES-GCM
                          decryption
                        type: string
                      data:
                        minLength: 1
                        description: Base64-encoded AES-GCM encrypted PIN block
                        type: string
                    required:
                      - iv
                      - data
                required:
                  - encryptedPin
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 401
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                    example: Bearer token required
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  realm:
                    description: The authentication realm
                    type: string
                    example: API
                  scope:
                    description: The required scope for this resource
                    type: string
                    example: read:users
                required:
                  - title
                  - status
                additionalProperties: false
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                  status:
                    description: The HTTP status code
                    type: number
                    example: 404
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                  resourceType:
                    description: The type of resource that was not found
                    type: string
                    example: user
                  resourceId:
                    description: The identifier of the resource that was not found
                    type: string
                required:
                  - title
                  - status
                  - resourceType
                  - resourceId
                additionalProperties: false
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    default: about:blank
                    description: A URI reference that identifies the problem type
                    type: string
                    example: urn:problem-type:auth:unauthorized
                  title:
                    description: A short, human-readable summary of the problem type
                    type: string
                    example: Unauthorized
                  status:
                    description: The HTTP status code
                    type: number
                    example: 400
                  detail:
                    description: A human-readable explanation specific to this occurrence
                    type: string
                  instance:
                    description: A URI reference that identifies the specific occurrence
                    type: string
                    example: /errors/1234567890
                  code:
                    description: >-
                      Machine-readable cause, present when exactly one thing
                      failed. Branch on this, never on `detail`, which is
                      human-facing copy and may change. For deposit limits the
                      vocabulary matches the `reason` values the limits API
                      returns pre-flight.
                    type: string
                    example: transaction_limit
                  field:
                    description: The offending request field, present alongside `code`.
                    type: string
                    example: amountUsd
                  retryable:
                    description: >-
                      Whether retrying the same request later may succeed
                      without changing its inputs.
                    type: boolean
                    example: true
                required:
                  - title
                  - status
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito JWT token for regular user authentication

````