Solicita uma reivindicação de Chave PIX.
curl --request POST \
--url https://api.ext.pix.dbs.moneyp.com.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>"
},
"chave": "<string>",
"codigoAutenticacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoMFA": "<string>"
}
'import requests
url = "https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar"
payload = {
"conta": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"chave": "<string>",
"codigoAutenticacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoMFA": "<string>"
}
headers = {
"IdempotencyKey": "<idempotencykey>",
"IgnoraHandshake": "<ignorahandshake>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
IgnoraHandshake: '<ignorahandshake>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
conta: {
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPgto: '<string>'
},
chave: '<string>',
codigoAutenticacao: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
codigoMFA: '<string>'
})
};
fetch('https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'conta' => [
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPgto' => '<string>'
],
'chave' => '<string>',
'codigoAutenticacao' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'codigoMFA' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>",
"IgnoraHandshake: <ignorahandshake>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar"
payload := strings.NewReader("{\n \"conta\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"chave\": \"<string>\",\n \"codigoAutenticacao\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoMFA\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar")
.header("IdempotencyKey", "<idempotencykey>")
.header("IgnoraHandshake", "<ignorahandshake>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"conta\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"chave\": \"<string>\",\n \"codigoAutenticacao\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoMFA\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conta\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"chave\": \"<string>\",\n \"codigoAutenticacao\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoMFA\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>",
"codigoReivindicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}PIX
21 - Solicitar Reivindicação
Scopes:
api.pix api.reivindicacao.solicitarreivindicacaoSolicita uma reivindicação de Chave PIX.
curl --request POST \
--url https://api.ext.pix.dbs.moneyp.com.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>"
},
"chave": "<string>",
"codigoAutenticacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoMFA": "<string>"
}
'import requests
url = "https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar"
payload = {
"conta": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"chave": "<string>",
"codigoAutenticacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoMFA": "<string>"
}
headers = {
"IdempotencyKey": "<idempotencykey>",
"IgnoraHandshake": "<ignorahandshake>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
IgnoraHandshake: '<ignorahandshake>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
conta: {
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPgto: '<string>'
},
chave: '<string>',
codigoAutenticacao: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
codigoMFA: '<string>'
})
};
fetch('https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'conta' => [
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPgto' => '<string>'
],
'chave' => '<string>',
'codigoAutenticacao' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'codigoMFA' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>",
"IgnoraHandshake: <ignorahandshake>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar"
payload := strings.NewReader("{\n \"conta\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"chave\": \"<string>\",\n \"codigoAutenticacao\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoMFA\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar")
.header("IdempotencyKey", "<idempotencykey>")
.header("IgnoraHandshake", "<ignorahandshake>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"conta\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"chave\": \"<string>\",\n \"codigoAutenticacao\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoMFA\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Solicitar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conta\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"chave\": \"<string>\",\n \"codigoAutenticacao\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoMFA\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>",
"codigoReivindicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}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.
Mostrar Mensagens de requisições com erro
Mostrar 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/Reivindicacao/Solicitar | Consulta de reivindicação expirada ou inválida, inicie o processo novamente |
| /api/Reivindicacao/Solicitar | Solicitação inválida, insira apenas os dados referentes à Chave PIX ou apenas os dados referentes à consulta prévia da reivindicação |
| /api/Reivindicacao/Solicitar | Reivindicação chave PIX indisponível para conta vinculada |
| /api/Reivindicacao/Solicitar | A chave PIX não foi encontrada |
| /api/Reivindicacao/Solicitar | Solicitação de reivindicação não permitida para esse tipo de chave |
Autorizações
Copie 'Bearer ' + token
Cabeçalhos
(somente em homologação)
Corpo
application/jsontext/jsonapplication/*+json
Objeto detalhado da conta bancária referente ao usuário que deseja reivindicar a chave Pix.*
Show child attributes
Show child attributes
Chave Pix relacionada à reivindicação.*
Tipo da chave.*
Valores: 0 - CPF 1 - CNPJ 2 - TELEFONE 3 - EMAIL 4 - EVP
Opções disponíveis:
0, 1, 2, 3, 4 Identificador UUID da solicitação de MFA previamente realizada.*
Código MFA gerado pela autenticação multifator.*
Esta página foi útil?
⌘I

