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

# 52 - Atualizar Favorecido

> <p>Scopes:</p>
<b>api.pix api.favorecidopix.atualizar</b>

Por meio deste endpoint o parceiro pode cadastrar novos favorecidos para as contas e pagamentos.

<Expandable title="Mensagens de requisições com erro">
  O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

  | Endpoint        | Mensagem de erro                                                                                              |
  | --------------- | ------------------------------------------------------------------------------------------------------------- |
  | /api/Favorecido | Operador não configurado para esta integração                                                                 |
  | /api/Favorecido | Necessário informar Conta + ContaDigito ou ContaPgto                                                          |
  | /api/Favorecido | Conta inválida                                                                                                |
  | /api/Favorecido | Situação da conta inválida                                                                                    |
  | /api/Favorecido | Conta != Ativa                                                                                                |
  | /api/Favorecido | Operador não encontrado                                                                                       |
  | /api/Favorecido | Parceiro não autorizado para esta conta                                                                       |
  | /api/Favorecido | É necessário informar o número banco                                                                          |
  | /api/Favorecido | Conta inexistente                                                                                             |
  | /api/Favorecido | Banco inexistente                                                                                             |
  | /api/Favorecido | Não foi possível cadastrar o favorecido. A conta está bloqueada                                               |
  | /api/Favorecido | É necessário informar o Nome                                                                                  |
  | /api/Favorecido | É necessário informar um Tipo Conta                                                                           |
  | /api/Favorecido | É necessário informar uma Agência                                                                             |
  | /api/Favorecido | É necessário informar uma Conta Pagamento                                                                     |
  | /api/Favorecido | É necessário informar uma Conta - Dígito"                                                                     |
  | /api/Favorecido | Documento federal inválido                                                                                    |
  | /api/Favorecido | Tipo Chave inválido                                                                                           |
  | /api/Favorecido | Informe uma chave válida!                                                                                     |
  | /api/Favorecido | É necessário informar um Tipo Cadastro Pix                                                                    |
  | /api/Favorecido | Documento Federal inválido                                                                                    |
  | /api/Favorecido | Parceiro não encontrado                                                                                       |
  | /api/Favorecido | Não foi possível concluir a transferência. \nO destinatário informado não é válido para este tipo de operação |
  | /api/Favorecido | O código do banco deve ser informado                                                                          |
  | /api/Favorecido | A conta informada não existe ou está inativa                                                                  |
  | /api/Favorecido | Correntista do favorecido não encontrado                                                                      |
  | /api/Favorecido | O nome informado é diferente ao titular da conta                                                              |
  | /api/Favorecido | O documento federal informado é diferente ao titular da conta                                                 |
  | /api/Favorecido | Documento está em cadastro restritivo                                                                         |
  | /api/Favorecido | Favorecido já está cadastrado                                                                                 |
  | /api/Favorecido | Favorecido está pendente aprovação                                                                            |
  | /api/Favorecido | Não foi possível inserir ou atualizar o Favorecido                                                            |
  | /api/Favorecido | Favorecido encaminhado para análise                                                                           |
  | /api/Favorecido | Favorecido cadastrado com sucesso                                                                             |
  | /api/Favorecido | Favorecido encaminhado para análise                                                                           |
  | /api/Favorecido | Favorecido cadastrado com sucesso                                                                             |
  | /api/Favorecido | Operador não configurado para esta integração                                                                 |
  | /api/Favorecido | Necessário informar Conta + ContaDigito ou ContaPgto                                                          |
  | /api/Favorecido | Conta inválida                                                                                                |
  | /api/Favorecido | Situação da conta inválida                                                                                    |
  | /api/Favorecido | Conta != Ativa                                                                                                |
  | /api/Favorecido | Operador não encontrado                                                                                       |
  | /api/Favorecido | Parceiro não autorizado para esta conta                                                                       |
  | /api/Favorecido | É necessário informar o Código Favorecido                                                                     |
  | /api/Favorecido | É necessário informar o número banco                                                                          |
  | /api/Favorecido | Conta inexistente                                                                                             |
  | /api/Favorecido | Banco inexistente                                                                                             |
  | /api/Favorecido | Não foi possível cadastrar o favorecido. A conta está bloqueada                                               |
  | /api/Favorecido | É necessário informar o Nome                                                                                  |
  | /api/Favorecido | É necessário informar um Tipo Conta                                                                           |
  | /api/Favorecido | É necessário informar uma Agência                                                                             |
  | /api/Favorecido | É necessário informar uma Conta Pagamento                                                                     |
  | /api/Favorecido | É necessário informar uma Conta - Dígito"                                                                     |
  | /api/Favorecido | Documento federal inválido                                                                                    |
  | /api/Favorecido | Tipo Chave inválido                                                                                           |
  | /api/Favorecido | Informe uma chave válida!                                                                                     |
  | /api/Favorecido | É necessário informar um Tipo Cadastro Pix                                                                    |
  | /api/Favorecido | Documento Federal inválido                                                                                    |
  | /api/Favorecido | Parceiro não encontrado                                                                                       |
  | /api/Favorecido | Não foi possível concluir a transferência. \nO destinatário informado não é válido para este tipo de operação |
  | /api/Favorecido | O código do banco deve ser informado                                                                          |
  | /api/Favorecido | A conta informada não existe ou está inativa                                                                  |
  | /api/Favorecido | Correntista do favorecido não encontrado                                                                      |
  | /api/Favorecido | O nome informado é diferente ao titular da conta                                                              |
  | /api/Favorecido | O documento federal informado é diferente ao titular da conta                                                 |
  | /api/Favorecido | Documento está em cadastro restritivo                                                                         |
  | /api/Favorecido | Favorecido já está cadastrado                                                                                 |
  | /api/Favorecido | Favorecido está pendente aprovação                                                                            |
  | /api/Favorecido | Não foi possível inserir ou atualizar o Favorecido                                                            |
</Expandable>


## OpenAPI

````yaml put /api/Favorecido
openapi: 3.0.1
info:
  title: BMPSPBExt
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.dbs.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/Favorecido:
    put:
      tags:
        - Favorecido
      summary: Atualiza os Dados de um Favorecido.
      description: "<p>Scopes:</p>\r\n<b>api.ext api.favorecido.atualizar</b>"
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.Favorecido.FavorecidoAtualizarRequest
          text/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.Favorecido.FavorecidoAtualizarRequest
          application/*+json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.Favorecido.FavorecidoAtualizarRequest
      responses:
        '200':
          description: Success
        '400':
          description: Erro de negócio
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
components:
  schemas:
    BMPSPB.Domain.Messaging.API.Externa.Favorecido.FavorecidoAtualizarRequest:
      type: object
      properties:
        contaDto:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Domain.Messaging.API.Shared.Conta.ContaDto
          description: Objeto detalhado da conta bancária.*
          nullable: true
        codigoFavorecido:
          type: string
          description: Código UUID identificador do favorecido que está sendo atualizado.*
          format: uuid
        nome:
          type: string
          description: |-
            Nome completo do favorecido.*

            Observação:
            - O nome completo do favorecido pode ter no máximo 100 caracteres.
          nullable: true
        documentoFederal:
          type: string
          description: |-
            CPF ou CNPJ do favorecido.*

            Observação:
            - O CPF ou CNPJ do favorecido pode ter no máximo 14 caracteres.
          nullable: true
        numeroBanco:
          type: integer
          description: >-
            Código identificador do banco. Exemplo: 001 para Banco do Brasil,
            104 para Caixa Econômica Federal, etc.*
          format: int32
          nullable: true
        agencia:
          type: string
          description: >-
            Número da agência da conta bancária.*


            Observação:

            - O número da agência da conta bancária pode ter no máximo 10
            caracteres.
          nullable: true
        agenciaDigito:
          type: string
          description: >-
            Dígito verificador da agência da conta bancária.*


            Observação:

            - O dígito verificador da agência da conta bancária pode ter no
            máximo 1 caracter.
          nullable: true
        conta:
          type: string
          description: >-
            Número da conta bancária.


            Observações:

            - Para conta do tipo pagamento, informar o 'número da conta com
            dígito' (```contaPagamento```).

            - Para conta de outros tipos, informar o 'número da conta'
            (```conta```) e o 'dígito verificador' (```contaDigito```).

            - Caso nenhum dos campos referentes ao número da conta sejam
            informados, ocorrerá erro na requisição devido à falta de informação
            vital.

            - O número da conta bancária pode ter no máximo 12 caracteres.
          nullable: true
        contaDigito:
          type: string
          description: >-
            Dígito verificador da conta bancária.


            Observação:

            - O dígito verificador da conta bancária pode ter no máximo 1
            caracter.
          nullable: true
        contaPagamento:
          type: string
          description: >-
            Número da conta bancária seguido do dígito verificador, sem espaços
            ou caracteres especiais.


            Observação:

            - O número da conta bancária seguido do dígito verificador pode ter
            no máximo 20 caracteres.
          nullable: true
        tipoConta:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta'
          description: |-
            Tipo de conta.*

            Valores:
            -1 - CACC
            2 - SVGS
            3 - TRAN
            4 - SLRY
          nullable: true
      additionalProperties: false
    BMPSPB.Domain.Messaging.API.Shared.Conta.ContaDto:
      type: object
      properties:
        agencia:
          type: string
          description: |-
            Número da agência bancária.*

            Observações:
            - O número da agência pode ter no máximo 4 caracteres.
          nullable: true
        agenciaDigito:
          type: string
          description: >-
            Dígito verificador da agência bancária.


            Observações:

            - O dígito verificador da agência bancária pode ter no máximo 1
            caracter.
          nullable: true
        conta:
          type: string
          description: >-
            Número da conta bancária.


            Observações:

            - O número da conta bancária pode ter no máximo 12 caracteres.

            - Para que seja possível localizar a conta, é necessário informar o
            'número da conta com dígito' (```contaPgto```) ou o 'número da
            conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

            - Caso o 'número da conta com dígito' (```contaPgto```) seja
            informado, não é necessário preencher os campos 'número da conta'
            (```conta```) e 'dígito verificador' (```contaDigito```).

            - Caso nenhum dos campos referentes ao número da conta seja
            informado, ocorrerá erro na requisição devido à falta de informação
            vital.
          nullable: true
        contaDigito:
          type: string
          description: >-
            Dígito verificador do número da conta bancária.


            Observações:

            - O dígito verificador do número da conta bancária pode ter no
            máximo 1 caracter.
          nullable: true
        contaPgto:
          type: string
          description: >-
            Número da conta bancária seguido do dígito verificador.


            Observações:

            - O número da conta seguido do dígito verificador pode ter no máximo
            20 caracteres.
          nullable: true
        tipoConta:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta'
          description: |-
            Tipo da conta.*

            Valores:
            1 - Corrente
            2 - Poupanca
            3 - Pagamento
            4 - Salario
          nullable: true
        modeloConta:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.ModeloConta'
          description: |-
            Modelo da conta.*

            Valores:
            1 - Movimento
            2 - Escrow
            3 - Vinculada
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.TipoConta:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.ModeloConta:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````