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

# Adicionar conta bancária

> Crie uma nova conta bancária para a empresa.

A criação de uma conta bancária é **essencial para realizar saques** dos valores recebidos através da Super Pagamentos. 

**Importante:** A conta bancária deve obrigatoriamente pertencer ao mesmo titular/CNPJ da conta na Super Pagamentos. Contas bancárias de terceiros não são aceitas por questões de segurança e conformidade.

**Tipos de conta aceitos:**
- Conta Corrente
- Conta Poupança

**Documentação necessária:**
- A conta bancária deve estar no mesmo nome/CNPJ cadastrado na Super Pagamentos
- Todos os dados bancários devem estar corretos e atualizados

**Operação em subconta:**
Para criar uma conta bancária em uma subconta específica, inclua o header `x-subaccount-id` com o ID da subconta. Quando este header é fornecido, a operação será realizada no contexto da subconta especificada, em vez da conta principal autenticada.



## OpenAPI

````yaml POST /bank_accounts
openapi: 3.1.0
info:
  title: OpenAPI Super APIs
  description: Documentação das APIs destinada a companhias da Super Pagamentos
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox-api.superpagamentos.com
    description: Ambiente de desenvolvimento
  - url: https://api.superpagamentos.com
    description: Ambiente de produção
security: []
paths:
  /bank_accounts:
    post:
      description: >-
        Crie uma nova conta bancária para a empresa.


        A criação de uma conta bancária é **essencial para realizar saques** dos
        valores recebidos através da Super Pagamentos. 


        **Importante:** A conta bancária deve obrigatoriamente pertencer ao
        mesmo titular/CNPJ da conta na Super Pagamentos. Contas bancárias de
        terceiros não são aceitas por questões de segurança e conformidade.


        **Tipos de conta aceitos:**

        - Conta Corrente

        - Conta Poupança


        **Documentação necessária:**

        - A conta bancária deve estar no mesmo nome/CNPJ cadastrado na Super
        Pagamentos

        - Todos os dados bancários devem estar corretos e atualizados


        **Operação em subconta:**

        Para criar uma conta bancária em uma subconta específica, inclua o
        header `x-subaccount-id` com o ID da subconta. Quando este header é
        fornecido, a operação será realizada no contexto da subconta
        especificada, em vez da conta principal autenticada.
      parameters:
        - name: x-subaccount-id
          in: header
          description: >-
            ID da subconta onde a operação será realizada. Quando fornecido, a
            operação será executada no contexto desta subconta específica.
          required: false
          schema:
            type: string
            format: uuid
      requestBody:
        description: Dados necessários para criação de uma conta bancária
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createBankAccount'
        required: true
      responses:
        '200':
          description: Conta bancária criada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bankAccountResponse'
        '400':
          description: Erro na criação da conta bancária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bankAccountErrorResponse'
              examples:
                Campos não informados:
                  value:
                    data:
                      message:
                        - >-
                          O nome do beneficiário "holderName" deve ser um texto
                          válido
                        - O nome do beneficiário "holderName" é obrigatório
                        - O código do banco "bankCode" deve ser um texto válido
                        - O código do banco "bankCode" é obrigatório
                        - >-
                          O tipo de conta "accountType" deve ser CHECKING ou
                          SAVINGS
                        - O tipo de conta "accountType" é obrigatório
                        - >-
                          O número da conta "accountNumber" deve estar no
                          formato conta-dv (ex: 12345-6)
                        - >-
                          O número da conta "accountNumber" deve ser um texto
                          válido
                        - O número da conta "accountNumber" é obrigatório
                        - >-
                          O número da agência "routingNumber" deve estar no
                          formato agência-dv (ex: 0001-0)
                        - >-
                          O número da agência "routingNumber" deve ser um texto
                          válido
                        - O número da agência "routingNumber" é obrigatório
                        - O documento "document" deve ser um texto válido
                        - O documento "document" (CPF/CNPJ) é obrigatório
                      error: Bad Request
                      statusCode: 400
                Erro genérico:
                  value:
                    data:
                      message: >-
                        Erro ao criar conta bancária. Verifique os dados
                        informados ou entre em contato com o suporte.
                      returnCode: -7000
      security:
        - bearerAuth: []
components:
  schemas:
    createBankAccount:
      type: object
      required:
        - holderName
        - bankCode
        - routingNumber
        - accountNumber
        - accountType
        - holderName
        - document
      properties:
        holderName:
          description: Nome do benefíciario da conta
          type: string
          example: EMPRESA EXEMPLO LTDA
        bankCode:
          description: Código do banco
          type: string
          example: '001'
        routingNumber:
          description: >-
            Número da agência com dígito verificador.Se não possuir DV, coloque
            0 após o hífen
          type: string
          example: 1234-0
        accountNumber:
          description: >-
            Número da conta com dígito verificador. Se não possuir DV, coloque 0
            após o hífen
          type: string
          example: 123456-78
        accountType:
          description: Tipo da conta bancária
          type: string
          enum:
            - SAVINGS
            - CHECKING
          example: SAVINGS
        document:
          description: CPF ou CNPJ do benefíciario da conta
          type: string
          example: '12345678901'
    bankAccountResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            holderName:
              type: string
              example: Empresa Teste LTDA
            bankCode:
              type: string
              example: '001'
            routingNumber:
              type: string
              example: 0001-00
            accountNumber:
              type: string
              example: 12345678-00
            document:
              type: string
              example: '00000000000'
            accountType:
              type: string
              example: CHECKING
            status:
              type: string
              example: APPROVED
        message:
          type: string
          example: Conta bancária criada com sucesso
    bankAccountErrorResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            message:
              oneOf:
                - type: string
                - type: array
                  items:
                    type: string
            returnCode:
              type: integer
              format: int32
            error:
              type: string
            statusCode:
              type: integer
              format: int32
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no
        formato: Bearer <token>

````