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

# Registrar encerramento de conta transacional

> Registra um encerramento de conta transacional, fazendo o DICT excluir em lote toda chave Pix vinculada àquela conta. Retorna os desfechos de exclusão por chave.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/account-closures
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/account-closures:
    post:
      tags:
        - Key DICT API
      summary: Registrar encerramento de conta transacional
      description: >-
        Registra um encerramento de conta transacional, fazendo o DICT excluir
        em lote toda chave Pix vinculada àquela conta. Retorna os desfechos de
        exclusão por chave.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloseAccountBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountClosureResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    CloseAccountBody:
      additionalProperties: false
      properties:
        account:
          description: O número da conta sendo encerrada.
          type: string
        accountId:
          description: >-
            O id da conta no CRM do chamador (resolve o ISPB do lado do
            servidor).
          type: string
        accountType:
          description: O tipo de conta (0=Checking,1=Salary,2=Savings,3=Payment,4=PI).
          format: int64
          type: integer
        branch:
          description: O número da agência da conta sendo encerrada.
          type: string
      required:
        - accountId
        - accountType
        - account
      type: object
    AccountClosureResponse:
      additionalProperties: false
      properties:
        deletedKeys:
          description: Os desfechos de exclusão por chave.
          items:
            $ref: '#/components/schemas/DeletedKeyView'
          type: array
          nullable: true
      required:
        - deletedKeys
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, escopado ao
            serviço emissor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: Uma explicação legível específica desta ocorrência do problema.
          type: string
        errors:
          description: Lista opcional de detalhes individuais de erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          format: uri
          type: string
        status:
          description: Código de status HTTP
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível do tipo de problema. Este valor não deve
            mudar entre ocorrências do erro.
          type: string
        type:
          default: about:blank
          description: Uma referência URI para a documentação legível do erro.
          format: uri
          type: string
      type: object
    DeletedKeyView:
      additionalProperties: false
      properties:
        document:
          description: O documento do dono da chave (somente encerramento de conta).
          type: string
        key:
          description: O valor da chave Pix excluída.
          type: string
        name:
          description: O nome do dono da chave (somente encerramento de conta).
          type: string
        reason:
          description: O código de motivo da exclusão.
          format: int64
          type: integer
        result:
          description: Resultado da exclusão (0=não excluída,1=excluída).
          format: int64
          type: integer
        resultDescription:
          description: O motivo da falha quando result=0.
          type: string
      required:
        - key
        - reason
        - result
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor no local informado
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````