curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/Reivindicacao/Solicitar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '{
  "conta": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "chave": "<string>",
  "tipoChave": 0,
  "codigoAutenticacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "codigoMFA": "<string>"
}'
{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoReivindicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Por meio deste endpoint, o parceiro pode gerar uma solicitação de reivindicação de uma chave pix caso a chave esteja cadastrada em outra instituição financeira.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
conta
object

Objeto detalhado da Conta Bancária referente ao usuário que deseja reivindicar a Chave PIX.

​
chave
string | null

Chave PIX relacionada à Reivindicação.

​
tipoChave
enum<integer>

Natureza da Chave PIX.

Available options:
0,
1,
2,
3,
4
​
codigoAutenticacao
string | null

Identificador UUID da Solicitação de MFA previamente realizada.

​
codigoMFA
string | null

Código MFA gerado pela autenticação multifator.

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.

​
codigoReivindicacao
string

Código UUID identificador da reivindicação gerada.

Esta página foi útil?