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

# bank_account_deleted

> Disparado quando uma conta bancária é removida do sistema.

**Payload:** Mesmo formato de `bank_account_updated` — contém os dados da conta no momento da exclusão.




## OpenAPI

````yaml /api-reference/openapi.yaml post /webhook-events/bank_account_deleted
openapi: 3.0.3
info:
  title: Nexus
  version: 1.0.2
  description: >
    API para integração entre Ticto e clientes externos


    # Autenticação


    Para autenticar as solicitações aos endpoints descritos a seguir, por favor,
    siga os passos abaixo:


    1. **Solicite** seu cadastro como cliente através do e-mail
    **infraestrutura@ticto.com.br** para obter seu `client_id` e `token`.

    2. **Use** seu token e ID de cliente para fazer login no Nexus e obter seu
    `client_token`.

    3. **Em todas as outras requisições**, envie seu `client_token` no header
    como `X-Api-Client-Token`.

    4. **Crie** seus usuários na rota de criação de usuário. Para cada usuário,
    será retornado um `public_token` único.

    5. **Para endpoints que não estão em public.php**, adicione o `public_token`
    do usuário no cabeçalho **Authorization** utilizando o formato:

       ```http
       Authorization: Bearer {public_token}
       ```

    ## Restrição de origem


    O acesso a esta API não está disponível para todos os sellers. Seu uso é
    estritamente permitido para parceiros comerciais que a utilizarão em
    cenários específicos. Por este motivo, o acesso será restrito a endereços IP
    e domínios previamente informados por esses parceiros. Essa medida visa
    proporcionar um ambiente mais controlado e seguro para todos os nossos
    usuários e parceiros.


    ### O que isso significa para os desenvolvedores?


    - **Acesso Limitado:**
      Somente os IPs e domínios pré-autorizados poderão realizar chamadas à API. Qualquer tentativa de acesso de um IP ou domínio não listado será automaticamente rejeitada.

    - **Processo de Autorização:**
      Para garantir a continuidade do acesso à API sem interrupções, é essencial que os desenvolvedores enviem os endereços IP ou domínios que necessitam de acesso diretamente à nossa equipe de suporte.

    - **Como Solicitar Acesso:**
      Envie um e-mail para **liberacao@ticto.com.br** com o assunto _"Solicitação de Acesso à API de pagamentos"_, incluindo:
      - Nome da empresa ou do desenvolvedor
      - Endereços IP ou domínios a serem autorizados
      - Justificativa para o acesso
      - Informações de contato para eventuais esclarecimentos

    ## Alterações e/ou inclusão de novos domínios e IPs


    Recomendamos que solicitações de adição ou alteração de IPs/domínios sejam
    feitas o mais breve possível para garantir uma transição suave. Em casos de
    alterações, os domínios e/ou IPs anteriores serão imediatamente bloqueados
    após sua remoção.


    ## Suporte e Dúvidas


    Para dúvidas ou suporte adicional, entre em contato conosco através do
    e-mail **liberacao@ticto.com.br**. Estamos comprometidos em auxiliar neste
    processo e garantir a melhor experiência possível.
servers:
  - url: https://nexus.ticto.com.br/api/v1
    description: Produção
security: []
tags:
  - name: Autenticação
  - name: Configurações do Cliente
  - name: Usuários
  - name: Onboarding de usuário
  - name: Contas Bancárias
  - name: Faixas de Taxa
    description: >-
      Endpoints para consulta de faixas de taxa personalizadas e histórico de
      alterações.
  - name: Frete
  - name: Financeiro
  - name: PIX Automático
    description: >-
      Consulta, cancelamento e nova tentativa de cobrança de assinaturas com PIX
      Automático (débito recorrente autorizado pelo pagador).
  - name: Produtos
  - name: Integrações
  - name: 'Webhooks: Usuários'
    description: Eventos relacionados a cadastro e atualização de usuários.
  - name: 'Webhooks: Contas Bancárias'
    description: Eventos relacionados a contas bancárias dos sellers.
  - name: 'Webhooks: Produtos e Ofertas'
    description: Eventos relacionados a produtos, ofertas, afiliados e coprodutores.
  - name: 'Webhooks: Financeiro'
    description: Eventos de reembolso, saque e antecipação.
  - name: 'Webhooks: Faixas de Taxa'
    description: Eventos de criação, atualização e exclusão de faixas de taxa.
  - name: 'Webhooks: Pedidos'
    description: Eventos de criação e atualização de pedidos.
  - name: 'Webhooks: Cobranças'
    description: >-
      Eventos de criação e mudança de status de cobranças (transações), na
      primeira compra e nas renovações.
  - name: 'Webhooks: Assinaturas'
    description: Eventos do ciclo de vida de assinaturas, cobranças e trial.
paths:
  /webhook-events/bank_account_deleted:
    post:
      tags:
        - 'Webhooks: Contas Bancárias'
      summary: bank_account_deleted
      description: >
        Disparado quando uma conta bancária é removida do sistema.


        **Payload:** Mesmo formato de `bank_account_updated` — contém os dados
        da conta no momento da exclusão.
      operationId: webhookBankAccountDeleted
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/WebhookEnvelope'
                - type: object
                  properties:
                    payload:
                      $ref: '#/components/schemas/WebhookBankAccountPayload'
            example:
              event: bank_account_deleted
              endpoint: https://api.meusite.com/webhook/nexus
              payload:
                code: BA0DE3C2D9
                bank_code: '341'
                holder_name: João da Silva
                pix_key: joao@email.com
                receiver_type: checking_account
                branch_number: '1234'
                branch_check_digit: '0'
                account_number: '12345'
                account_check_digit: '6'
                status: approved
                reason: null
                bank_document: null
              metadata:
                origin: nexus
                request_id: 67be1a2f3c4d5
                correlation_id: null
              created_at: '2026-02-25T10:00:00.000000Z'
              updated_at: '2026-02-25T10:00:00.000000Z'
      responses:
        '200':
          description: Webhook recebido com sucesso
components:
  schemas:
    WebhookEnvelope:
      type: object
      description: |
        Envelope padrão de todos os webhooks enviados pelo Nexus.
        O campo `payload` varia conforme o evento.
      required:
        - event
        - endpoint
        - payload
        - metadata
        - created_at
        - updated_at
      properties:
        event:
          type: string
          description: Nome do evento disparado
          example: user_updated
        endpoint:
          type: string
          format: url
          description: URL do webhook configurada pelo cliente
          example: https://api.meusite.com/webhook/nexus
        payload:
          type: object
          description: Dados específicos do evento (varia por evento)
        metadata:
          $ref: '#/components/schemas/WebhookMetadata'
        created_at:
          type: string
          format: date-time
          description: Data de criação do webhook (ISO 8601)
          example: '2026-02-25T10:00:00.000000Z'
        updated_at:
          type: string
          format: date-time
          description: Data de atualização do webhook (ISO 8601)
          example: '2026-02-25T10:00:00.000000Z'
    WebhookBankAccountPayload:
      type: object
      description: |
        Payload dos eventos `bank_account_updated` e `bank_account_deleted`.
        Disparado quando uma conta bancária é alterada ou removida.
      required:
        - code
        - holder_name
      properties:
        code:
          type: string
          description: >-
            Código identificador da conta bancária (mesmo valor retornado no
            POST /users/bank-accounts)
          example: BA0DE3C2D9
        bank_code:
          type: string
          nullable: true
          description: Código do banco (ex. "001" para Banco do Brasil)
          example: '341'
        holder_name:
          type: string
          description: Nome do titular da conta
          example: João da Silva
        pix_key:
          type: string
          nullable: true
          description: Chave PIX cadastrada
          example: joao@email.com
        receiver_type:
          type: string
          nullable: true
          description: Tipo de recebedor
          example: checking_account
        branch_number:
          type: string
          nullable: true
          description: Número da agência
          example: '1234'
        branch_check_digit:
          type: string
          nullable: true
          description: Dígito verificador da agência
          example: '0'
        account_number:
          type: string
          nullable: true
          description: Número da conta
          example: '12345'
        account_check_digit:
          type: string
          nullable: true
          description: Dígito verificador da conta
          example: '6'
        status:
          type: string
          nullable: true
          description: Status da conta bancária
          example: approved
        reason:
          type: string
          nullable: true
          description: Motivo do status (ex. reprovação)
          example: null
        bank_document:
          type: string
          nullable: true
          description: URL do comprovante bancário
          example: null
    WebhookMetadata:
      type: object
      description: Metadados de rastreamento do webhook
      properties:
        origin:
          type: string
          description: Sistema de origem do evento
          example: nexus
        request_id:
          type: string
          description: ID único da requisição para rastreamento
          example: 67be1a2f3c4d5
        correlation_id:
          type: string
          nullable: true
          description: ID de correlação (quando disponível)
          example: null

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.