> ## 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.

# 6 - Consultar Portabilidade

> <p>Scopes:</p>
<b>api.pix api.doacao.consultardoacao</b>

Por meio deste endpoint, o parceiro pode verificar a situação em que se encontram as solicitações de portabilidade de chave pix, ou seja, pode consultar um “status” das portabilidades.

<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/Doacao/Consultar/{codigo} | Nenhuma doação foi encontrada com estes parâmetros |
  | /api/Doacao/Consultar/{codigo} | Código inválido                                    |
</Expandable>


## OpenAPI

````yaml get /api/Doacao/Consultar/{codigo}
openapi: 3.0.1
info:
  title: Api Externa BMP SPI
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.pix.dbs.moneyp.com.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/Doacao/Consultar/{codigo}:
    get:
      tags:
        - Doacao
      summary: >-
        Consulta detalhes específicos de uma solicitação de portabilidade de
        chave Pix.
      description: "<p>Scopes:</p>\r\n<b>api.pix api.doacao.consultardoacao</b>"
      parameters:
        - name: codigo
          in: path
          description: >-
            Código UUID identificador da solicitação de portabilidade de chave
            Pix a ser consultada.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Doacao.ConsultarDoacaoResponse
        '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.Pix.Doacao.ConsultarDoacaoResponse:
      type: object
      properties:
        sucesso:
          type: boolean
        mensagem:
          type: string
          nullable: true
        codigo:
          type: string
          format: uuid
        codigoConta:
          type: string
          format: uuid
        codigoContaChavePix:
          type: string
          format: uuid
        codigoOperador:
          type: string
          format: uuid
        chave:
          type: string
          nullable: true
        tipoChave:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoChavePix'
          nullable: true
        tipoReivindicacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoReivindicacao'
          nullable: true
        idReivindicacao:
          type: string
          format: uuid
          nullable: true
        participanteSolicitante:
          type: string
          nullable: true
        agenciaSolicitante:
          type: string
          nullable: true
        contaSolicitante:
          type: string
          nullable: true
        nomeSolicitante:
          type: string
          nullable: true
        documentoSolicitante:
          type: string
          nullable: true
        tipoPessoaSolicitante:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoPessoa'
        statusReivindicacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.StatusReivindicacao'
        prazoResolucao:
          type: string
          format: date-time
          nullable: true
        prazoConclusao:
          type: string
          format: date-time
          nullable: true
        dtModificacao:
          type: string
          format: date-time
          nullable: true
        motivoConfirmacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.MotivoConfirmacao'
          nullable: true
        motivoCancelamento:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.MotivoCancelamento'
          nullable: true
        solicitanteCancelamento:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SolicitanteCancelamento'
          nullable: true
        dtInclusao:
          type: string
          format: date-time
        situacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoTransacao'
          nullable: true
        msgSituacao:
          type: string
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.TipoChavePix:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoReivindicacao:
      enum:
        - 1
        - 2
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoPessoa:
      enum:
        - 1
        - 2
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.StatusReivindicacao:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.MotivoConfirmacao:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.MotivoCancelamento:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.SolicitanteCancelamento:
      enum:
        - 0
        - 1
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.SituacaoTransacao:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 50
        - 60
        - 97
        - 98
        - 99
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````