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

Through this endpoint, partners can check a Pix key claim and verify the current status of the request.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
CodigoReivindicacao
string

Identificador UUID da Reivindicação à 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.

​
chave
string | null

Chave PIX reivindicada.

​
tipoChave
enum<integer>

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

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

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

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

1 = Reivindicação; 2 = Portabilidade

Available options:
1,
2
​
idReivindicacao
string | null

Identificador do registro de reivindicação.

​
dtInclusao
string

Data de inclusão do registro.

​
prazoResolucao
string | null

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

​
prazoConclusao
string | null

Data limite para a conclusão completa da Reivindicação, com a chave devidamente transferida.

​
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

Was this page helpful?