Skip to main content
Consulta detalhes específicos de uma solicitação de portabilidade de chave Pix.
curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.com.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>",
  "idReivindicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "participanteSolicitante": "<string>",
  "agenciaSolicitante": "<string>",
  "contaSolicitante": "<string>",
  "nomeSolicitante": "<string>",
  "documentoSolicitante": "<string>",
  "prazoResolucao": "2023-11-07T05:31:56Z",
  "prazoConclusao": "2023-11-07T05:31:56Z",
  "dtModificacao": "2023-11-07T05:31:56Z",
  "dtInclusao": "2023-11-07T05:31:56Z",
  "msgSituacao": "<string>"
}
Through this endpoint, the partner can check the status of Pix key portability requests, that is, they can consult the portability status.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Path Parameters

​
codigo
string<uuid>
required

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

Response

Success

​
sucesso
boolean
​
mensagem
string | null
​
codigo
string<uuid>
​
codigoConta
string<uuid>
​
codigoContaChavePix
string<uuid>
​
codigoOperador
string<uuid>
​
chave
string | null
​
tipoChave
enum<integer>
Available options:
0,
1,
2,
3,
4
​
tipoReivindicacao
enum<integer>
Available options:
1,
2
​
idReivindicacao
string<uuid> | null
​
participanteSolicitante
string | null
​
agenciaSolicitante
string | null
​
contaSolicitante
string | null
​
nomeSolicitante
string | null
​
documentoSolicitante
string | null
​
tipoPessoaSolicitante
enum<integer>
Available options:
1,
2
​
statusReivindicacao
enum<integer>
Available options:
0,
1,
2,
3,
4,
5
​
prazoResolucao
string<date-time> | null
​
prazoConclusao
string<date-time> | null
​
dtModificacao
string<date-time> | null
​
motivoConfirmacao
enum<integer>
Available options:
0,
1,
2,
3,
4
​
motivoCancelamento
enum<integer>
Available options:
0,
1,
2,
3,
4
​
solicitanteCancelamento
enum<integer>
Available options:
0,
1
​
dtInclusao
string<date-time>
​
situacao
enum<integer>
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
50,
60,
97,
98,
99
​
msgSituacao
string | null