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

# Incluir conta de recebimento

> Inclui ou substitui a conta de recebimento de uma proposta de **refinanciamento**, enquanto a
etapa ativa for `CONTA_RECEBIMENTO` (5). O titular deve ser o cliente da proposta. Propostas de financiamento
não são aceitas. Enviar novamente substitui a conta anterior.


Inclui ou substitui a conta onde o cliente recebe o crédito. Só para propostas de **refinanciamento**, enquanto a etapa ativa for `CONTA_RECEBIMENTO`.

**Exemplo:**

```json theme={null}
{
  "cpfTitular": "12345678909",
  "codigoBanco": "001",
  "agencia": "1234",
  "digitoAgencia": "5",
  "conta": "123456",
  "digitoConta": "7",
  "tipoConta": "CORRENTE"
}
```

> [!WARNING]
>
> O `cpfTitular` precisa ser o CPF do cliente da proposta. Senão, a API retorna `Proposal.DepositAccount.HolderNotBuyer`.

> [!TIP]
>
> `codigoBanco` com 3 dígitos, `agencia` com até 4 dígitos, `conta` de 4 a 13 dígitos. `digitoAgencia` e `digitoConta` são obrigatórios: um único caractere, de 0 a 9 ou `X`. `tipoConta`: `CORRENTE`, `POUPANCA` ou `PAGAMENTO`.

> [!TIP]
>
> Enviar de novo substitui a conta anterior, enquanto a etapa estiver ativa.

> [!NOTE]
>
> Retorna `204 No Content`. A etapa `CONTA_RECEBIMENTO` é do comprador. Fora dela, a API retorna `422` com `Proposal.ProposalIsNotInDepositAccountStatus`.


## OpenAPI

````yaml POST /v2/proposal/{propostaId}/deposit-account
openapi: 3.1.0
info:
  title: API Credicarro
  description: API para gerenciamento de cobranças e pagamentos usando o Credicarro.
  version: 1.0.0
servers:
  - url: https://api.staging.credicarro.com.br/integration
    description: Servidor para o ambiente de staging
  - url: https://api.credicarro.com.br/integration
    description: Servidor para o ambiente de produção
security: []
paths:
  /v2/proposal/{propostaId}/deposit-account:
    post:
      tags:
        - Proposta
      summary: Incluir a conta de recebimento
      description: >
        Inclui ou substitui a conta de recebimento de uma proposta de
        **refinanciamento**, enquanto a

        etapa ativa for `CONTA_RECEBIMENTO` (5). O titular deve ser o cliente da
        proposta. Propostas de financiamento

        não são aceitas. Enviar novamente substitui a conta anterior.
      parameters:
        - $ref: '#/components/parameters/ProposalId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - cpfTitular
                - codigoBanco
                - agencia
                - digitoAgencia
                - conta
                - digitoConta
                - tipoConta
              additionalProperties: false
              properties:
                cpfTitular:
                  type: string
                  description: >-
                    CPF do titular da conta, formatado ou apenas números. Deve
                    ser o CPF do cliente da proposta.
                  example: '12345678909'
                codigoBanco:
                  type: string
                  description: Código do banco (COMPE) com 3 dígitos.
                  example: '001'
                agencia:
                  type: string
                  description: >-
                    Número da agência com até 4 dígitos, sem o dígito
                    verificador.
                  example: '1234'
                digitoAgencia:
                  type: string
                  description: Dígito verificador da agência (número ou X).
                  example: '5'
                conta:
                  type: string
                  description: >-
                    Número da conta, de 4 a 13 dígitos, sem o dígito
                    verificador.
                  example: '123456'
                digitoConta:
                  type: string
                  description: Dígito verificador da conta (número ou X).
                  example: '7'
                tipoConta:
                  type: string
                  description: Tipo da conta.
                  enum:
                    - CORRENTE
                    - POUPANCA
                    - PAGAMENTO
                  example: CORRENTE
      responses:
        '204':
          description: Conta de recebimento registrada. A resposta não tem corpo.
          content:
            text/plain:
              schema:
                type: string
                description: Resposta sem corpo
              example: No Content
        '400':
          description: Erro na requisição
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          $ref: '#/components/responses/IntegrationInactive'
        '404':
          description: Proposta não encontrada para este parceiro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: >-
            Regra não atendida — `Proposal.DepositAccount.OnlyRefinancing`,
            `Proposal.DepositAccount.HolderNotBuyer`,
            `Proposal.ProposalIsNotInDepositAccountStatus` ou
            `Proposal.Access.NotIntegrationV2`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - bearerAuth: []
components:
  parameters:
    ProposalId:
      name: propostaId
      in: path
      required: true
      description: Identificador único da proposta (UUID) retornado na criação da proposta
      schema:
        type: string
        format: uuid
        example: bea8d060-f93d-48eb-b6c4-45f64483cdd9
  schemas:
    ProblemDetails:
      type: object
      properties:
        tipo:
          type: string
          description: Tipo de problema encontrado
          example: Validation.Cpf.Invalid
        titulo:
          type: string
          description: Título do erro
          example: Requisição inválida
        status:
          type: integer
          format: int32
          description: Status Code do erro
          example: 400
        detalhe:
          type: string
          description: Descrição do erro
          example: O CPF informado em 'cpf' é inválido.
        campo:
          type: string
          nullable: true
          description: Campo da requisição relacionado ao erro, quando houver
          example: cpf
        erros:
          type: array
          description: >-
            Lista de erros. Presente só quando o JSON enviado está malformado ou
            tem um valor de tipo errado.
          items:
            type: object
            properties:
              codigo:
                type: string
                description: Código estável do erro
                example: Validation.InvalidFormat
              mensagem:
                type: string
                description: Mensagem em português
                example: O valor informado para 'valorVeiculo' não é um número válido.
              campo:
                type: string
                nullable: true
                description: Campo inválido, quando houver
                example: cpf
      additionalProperties: false
  responses:
    IntegrationInactive:
      description: >-
        Integração do parceiro inativa ou não encontrada
        (`Integration.Access.Inactive`,
        `Integration.Access.OrganizationNotFound`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <token>` onde
        `<token>` é seu TOKEN de autenticação

````

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