curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/Doacao/Consultar/{codigo} \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoContaChavePix": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoOperador": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chave": "<string>",
  "tipoChave": 0,
  "tipoReivindicacao": 1,
  "idReivindicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "participanteSolicitante": "<string>",
  "agenciaSolicitante": "<string>",
  "contaSolicitante": "<string>",
  "nomeSolicitante": "<string>",
  "documentoSolicitante": "<string>",
  "tipoPessoaSolicitante": 1,
  "statusReivindicacao": 1,
  "prazoResolucao": "2023-11-07T05:31:56Z",
  "prazoConclusao": "2023-11-07T05:31:56Z",
  "dtModificacao": "2023-11-07T05:31:56Z",
  "motivoConfirmacao": 1,
  "motivoCancelamento": 1,
  "solicitanteCancelamento": 0,
  "dtInclusao": "2023-11-07T05:31:56Z",
  "situacao": 0,
  "msgSituacao": "<string>"
}

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.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Path Parameters

​
codigo
string
required

Código UUID identificador da solicitação de portabilidade de chave Pix a ser consultada.

Response

200 - application/json
Success
​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
codigo
string

Código UUID identificador da Doação de Chave PIX.

​
codigoConta
string

Código UUID identificador da Conta Bancária de Origem.

​
codigoContaChavePix
string

Código UUID identificador do relacionamento entre Conta Bancária de Origem e a Chave PIX.

​
codigoOperador
string

Código UUID identificador do Operador responsável pelo início do processo de Doação.

​
chave
string | null

Chave PIX doada.

​
tipoChave
enum<integer>

0 = CPF; 1 = CNPJ; 2 = TELEFONE; 3 = EMAIL; 4 = EVP

Available options:
0,
1,
2,
3,
4
​
tipoReivindicacao
enum<integer>

1 = Reivindicação; 2 = Portabilidade

Available options:
1,
2
​
idReivindicacao
string | null

Um identificador UUID da reivindicação de Chave PIX associada à Doação.

​
participanteSolicitante
string | null

ISPB da instituição financeira do solicitante, responsável por receber a chave Pix transferida por meio do processo de doação.

​
agenciaSolicitante
string | null

Agência da Conta Bancária do Solicitante.

​
contaSolicitante
string | null

Número da Conta Bancária do Solicitante.

​
nomeSolicitante
string | null

Nome completo do Solicitante.

​
documentoSolicitante
string | null

CPF ou CNPJ do Solicitante, à depender da natureza do mesmo.

​
tipoPessoaSolicitante
enum<integer>

1 = PF; 2 = PJ

Available options:
1,
2
​
statusReivindicacao
enum<integer>

1 = Aberto; 2 = Esperando confirmação; 3 = Confirmado; 4 = Cancelado; 5 = Completado

Available options:
1,
2,
3,
4,
5
​
prazoResolucao
string | null

Data limite para que o processo de Doação seja analisado e uma decisão seja tomada.

​
prazoConclusao
string | null

Data limite para a conclusão completa da Doação, com a chave transferida ao Solicitante.

​
dtModificacao
string | null

Data e hora da última atualização do registro.

​
motivoConfirmacao
enum<integer>

1 = Solicitação do usuário; 2 = Fechamento de conta; 3 = Operação padrão

Available options:
1,
2,
3
​
motivoCancelamento
enum<integer>

1 = Solicitação do usuário; 2 = Fechamento de conta; 3 = Fraude; 4 = Operação padrão; 5 = Reconciliação

Available options:
1,
2,
3,
4,
5
​
solicitanteCancelamento
enum<integer>

0 = DONOR; 1 = CLAIMER

Available options:
0,
1
​
dtInclusao
string

Data e hora da inclusão do registro.

​
situacao
enum<integer>

0 = Pendente; 1 = Registrando; 2 = Registrado; 3 = Cancelado; 4 = Confirmado; 5 = Confirmando; 50 = PendenteReprocessamento; 97 = NaoProcessada; 98 = ErroNegocio; 99 = ErroSistema

Available options:
0,
1,
2,
3,
4,
5,
50,
97,
98,
99
​
msgSituacao
string | null

Esta página foi útil?