> ## Documentation Index
> Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict



## OpenAPI

````yaml /api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict
openapi: 3.0.3
info:
  title: Platform
  version: 1.0.0
  description: >-
    Portão 3 platform API. Generated by tools/openapi from code (routes +
    security) and the hand-written spec (request/response bodies). Confidence
    tiers: generated:typed=17 copied:manual=6 unknown=93.
servers:
  - url: https://api.platform.v2.portao3.com.br/
    description: production
  - url: https://api.platform.dev.3pers.com.br/
    description: development
security:
  - bearerAuth: []
tags:
  - name: Wallets
  - name: Cards
  - name: PIX
  - name: PIX Keys (DICT)
  - name: Boleto
  - name: Transfers
  - name: Batch Payments
  - name: Scheduled Payments
  - name: Transactions & Statements
  - name: Invoices
  - name: Contracts & Deals
  - name: Billing
  - name: Custom Fields
  - name: Notifications
  - name: Files
  - name: Users
  - name: Internal
paths:
  /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict:
    post:
      tags:
        - PIX Keys (DICT)
      summary: >-
        /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict
      operationId: postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixDict
      parameters:
        - name: realmId
          in: path
          required: true
          schema:
            type: string
        - name: organizationId
          in: path
          required: true
          schema:
            type: string
        - name: walletId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - PHONE
                    - EMAIL
                    - CPF
                    - CNPJ
                    - EVP
                value:
                  type: string
                  minLength: 1
              required:
                - type
                - value
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  createdBy:
                    type: string
                  updatedBy:
                    type: string
                  name:
                    type: string
                  organization:
                    type: string
                  realm:
                    type: string
                  status:
                    type: string
                    enum:
                      - CREATING
                      - ACTIVE
                      - DEACTIVATED
                  type:
                    type: string
                    enum:
                      - PERSONAL
                      - ORGANIZATION
                      - SHARED
                  external:
                    type: object
                    properties:
                      account:
                        type: string
                      wallet:
                        type: string
                      productId:
                        type: string
                    required:
                      - account
                      - wallet
                  currency:
                    type: string
                    enum:
                      - '356'
                      - '978'
                      - '710'
                      - '967'
                      - '932'
                      - '953'
                      - '704'
                      - '937'
                      - '548'
                      - '860'
                      - '940'
                      - '858'
                      - '800'
                      - '980'
                      - '036'
                      - '949'
                      - '934'
                      - '840'
                      - '788'
                      - '780'
                      - '776'
                      - '554'
                      - '952'
                      - '834'
                      - '972'
                      - '901'
                      - '764'
                      - '941'
                      - '951'
                      - '678'
                      - '578'
                      - '947'
                      - '756'
                      - '948'
                      - '752'
                      - '968'
                      - '728'
                      - '938'
                      - '748'
                      - '144'
                      - '706'
                      - '994'
                      - '532'
                      - '690'
                      - '694'
                      - '925'
                      - '882'
                      - '654'
                      - '504'
                      - '646'
                      - '946'
                      - '760'
                      - '214'
                      - '203'
                      - '950'
                      - '826'
                      - '404'
                      - '417'
                      - '634'
                      - '985'
                      - '604'
                      - '965'
                      - '600'
                      - '586'
                      - '598'
                      - '590'
                      - '512'
                      - '566'
                      - '558'
                      - '524'
                      - '516'
                      - '484'
                      - '979'
                      - '104'
                      - '943'
                      - '496'
                      - '498'
                      - '480'
                      - '478'
                      - '458'
                      - '462'
                      - '454'
                      - '969'
                      - '807'
                      - '446'
                      - '434'
                      - '422'
                      - '430'
                      - '426'
                      - '418'
                      - '414'
                      - '400'
                      - '392'
                      - '388'
                      - '886'
                      - '376'
                      - '352'
                      - '364'
                      - '368'
                      - '360'
                      - '090'
                      - '208'
                      - '238'
                      - '136'
                      - '348'
                      - '344'
                      - '340'
                      - '332'
                      - '270'
                      - '324'
                      - '328'
                      - '320'
                      - '292'
                      - '981'
                      - '936'
                      - '960'
                      - '608'
                      - '242'
                      - '643'
                      - '230'
                      - '997'
                      - '232'
                      - '784'
                      - '222'
                      - '818'
                      - '262'
                      - '931'
                      - '192'
                      - '191'
                      - '188'
                      - '408'
                      - '410'
                      - '976'
                      - '174'
                      - '170'
                      - '970'
                      - '702'
                      - '156'
                      - '990'
                      - '152'
                      - '398'
                      - '124'
                      - '116'
                      - '132'
                      - '064'
                      - '108'
                      - '975'
                      - '096'
                      - '986'
                      - '072'
                      - '977'
                      - '984'
                      - '068'
                      - '060'
                      - '084'
                      - '974'
                      - '052'
                      - '050'
                      - '048'
                      - '044'
                      - '944'
                      - '682'
                      - '533'
                      - '051'
                      - '012'
                      - '032'
                      - '008'
                  shared:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        firstName:
                          type: string
                        lastName:
                          type: string
                        email:
                          type: string
                        role:
                          type: string
                          enum:
                            - OWNER
                            - USER
                            - READ_ONLY
                      required:
                        - id
                        - firstName
                        - lastName
                        - email
                        - role
                  settings:
                    type: object
                    properties:
                      payment:
                        type: object
                        properties:
                          pix:
                            type: boolean
                          bankSlip:
                            type: boolean
                          card:
                            type: boolean
                        required:
                          - pix
                          - bankSlip
                          - card
                      notification:
                        type: object
                        properties:
                          balanceLimit:
                            type: object
                            properties:
                              amount:
                                type: number
                              email:
                                type: boolean
                              isActive:
                                type: boolean
                              lastNotification:
                                type: object
                                properties:
                                  balance:
                                    type: number
                                required:
                                  - balance
                            required:
                              - amount
                              - email
                              - isActive
                        required:
                          - balanceLimit
                    required:
                      - payment
                  dict:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                      value:
                        type: string
                      status:
                        type: string
                    required:
                      - id
                      - type
                      - value
                      - status
                  customFields:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        identifier:
                          type: string
                        values:
                          type: array
                          items:
                            type: string
                        version:
                          type: number
                      required:
                        - id
                        - values
                required:
                  - id
                  - createdBy
                  - updatedBy
                  - name
                  - organization
                  - realm
                  - status
                  - type
                  - external
                  - currency
                  - shared
                  - settings
                  - dict
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````