curl --request PUT \
--url https://api.ext.dbs.moneyp.dev.br/api/Favorecido \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
'import requests
url = "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"
payload = {
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contaDto: {
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPgto: '<string>'
},
codigoFavorecido: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
nome: '<string>',
documentoFederal: '<string>',
numeroBanco: 123,
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPagamento: '<string>'
})
};
fetch('https://api.ext.dbs.moneyp.dev.br/api/Favorecido', 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.dbs.moneyp.dev.br/api/Favorecido",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'contaDto' => [
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPgto' => '<string>'
],
'codigoFavorecido' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'nome' => '<string>',
'documentoFederal' => '<string>',
'numeroBanco' => 123,
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPagamento' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.dbs.moneyp.dev.br/api/Favorecido"
payload := strings.NewReader("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"codigoFavorecido\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"codigoFavorecido\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"codigoFavorecido\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}52 - Atualizar Favorecido
Scopes:
api.pix api.favorecidopix.atualizarcurl --request PUT \
--url https://api.ext.dbs.moneyp.dev.br/api/Favorecido \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
'import requests
url = "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"
payload = {
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contaDto: {
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPgto: '<string>'
},
codigoFavorecido: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
nome: '<string>',
documentoFederal: '<string>',
numeroBanco: 123,
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPagamento: '<string>'
})
};
fetch('https://api.ext.dbs.moneyp.dev.br/api/Favorecido', 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.dbs.moneyp.dev.br/api/Favorecido",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'contaDto' => [
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPgto' => '<string>'
],
'codigoFavorecido' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'nome' => '<string>',
'documentoFederal' => '<string>',
'numeroBanco' => 123,
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPagamento' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.dbs.moneyp.dev.br/api/Favorecido"
payload := strings.NewReader("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"codigoFavorecido\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"codigoFavorecido\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"codigoFavorecido\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}Mostrar Mensagens de requisições com erro
Mostrar Mensagens de requisições com erro
| Endpoint | Mensagem de erro |
|---|---|
| /api/Favorecido | Operador não configurado para esta integração |
| /api/Favorecido | Necessário informar Conta + ContaDigito ou ContaPgto |
| /api/Favorecido | Conta inválida |
| /api/Favorecido | Situação da conta inválida |
| /api/Favorecido | Conta != Ativa |
| /api/Favorecido | Operador não encontrado |
| /api/Favorecido | Parceiro não autorizado para esta conta |
| /api/Favorecido | É necessário informar o número banco |
| /api/Favorecido | Conta inexistente |
| /api/Favorecido | Banco inexistente |
| /api/Favorecido | Não foi possível cadastrar o favorecido. A conta está bloqueada |
| /api/Favorecido | É necessário informar o Nome |
| /api/Favorecido | É necessário informar um Tipo Conta |
| /api/Favorecido | É necessário informar uma Agência |
| /api/Favorecido | É necessário informar uma Conta Pagamento |
| /api/Favorecido | É necessário informar uma Conta - Dígito” |
| /api/Favorecido | Documento federal inválido |
| /api/Favorecido | Tipo Chave inválido |
| /api/Favorecido | Informe uma chave válida! |
| /api/Favorecido | É necessário informar um Tipo Cadastro Pix |
| /api/Favorecido | Documento Federal inválido |
| /api/Favorecido | Parceiro não encontrado |
| /api/Favorecido | Não foi possível concluir a transferência. \nO destinatário informado não é válido para este tipo de operação |
| /api/Favorecido | O código do banco deve ser informado |
| /api/Favorecido | A conta informada não existe ou está inativa |
| /api/Favorecido | Correntista do favorecido não encontrado |
| /api/Favorecido | O nome informado é diferente ao titular da conta |
| /api/Favorecido | O documento federal informado é diferente ao titular da conta |
| /api/Favorecido | Documento está em cadastro restritivo |
| /api/Favorecido | Favorecido já está cadastrado |
| /api/Favorecido | Favorecido está pendente aprovação |
| /api/Favorecido | Não foi possível inserir ou atualizar o Favorecido |
| /api/Favorecido | Favorecido encaminhado para análise |
| /api/Favorecido | Favorecido cadastrado com sucesso |
| /api/Favorecido | Favorecido encaminhado para análise |
| /api/Favorecido | Favorecido cadastrado com sucesso |
| /api/Favorecido | Operador não configurado para esta integração |
| /api/Favorecido | Necessário informar Conta + ContaDigito ou ContaPgto |
| /api/Favorecido | Conta inválida |
| /api/Favorecido | Situação da conta inválida |
| /api/Favorecido | Conta != Ativa |
| /api/Favorecido | Operador não encontrado |
| /api/Favorecido | Parceiro não autorizado para esta conta |
| /api/Favorecido | É necessário informar o Código Favorecido |
| /api/Favorecido | É necessário informar o número banco |
| /api/Favorecido | Conta inexistente |
| /api/Favorecido | Banco inexistente |
| /api/Favorecido | Não foi possível cadastrar o favorecido. A conta está bloqueada |
| /api/Favorecido | É necessário informar o Nome |
| /api/Favorecido | É necessário informar um Tipo Conta |
| /api/Favorecido | É necessário informar uma Agência |
| /api/Favorecido | É necessário informar uma Conta Pagamento |
| /api/Favorecido | É necessário informar uma Conta - Dígito” |
| /api/Favorecido | Documento federal inválido |
| /api/Favorecido | Tipo Chave inválido |
| /api/Favorecido | Informe uma chave válida! |
| /api/Favorecido | É necessário informar um Tipo Cadastro Pix |
| /api/Favorecido | Documento Federal inválido |
| /api/Favorecido | Parceiro não encontrado |
| /api/Favorecido | Não foi possível concluir a transferência. \nO destinatário informado não é válido para este tipo de operação |
| /api/Favorecido | O código do banco deve ser informado |
| /api/Favorecido | A conta informada não existe ou está inativa |
| /api/Favorecido | Correntista do favorecido não encontrado |
| /api/Favorecido | O nome informado é diferente ao titular da conta |
| /api/Favorecido | O documento federal informado é diferente ao titular da conta |
| /api/Favorecido | Documento está em cadastro restritivo |
| /api/Favorecido | Favorecido já está cadastrado |
| /api/Favorecido | Favorecido está pendente aprovação |
| /api/Favorecido | Não foi possível inserir ou atualizar o Favorecido |
Autorizações
Copie 'Bearer ' + token
Corpo
Objeto detalhado da conta bancária.*
Show child attributes
Show child attributes
Código UUID identificador do favorecido que está sendo atualizado.*
Nome completo do favorecido.*
Observação:
- O nome completo do favorecido pode ter no máximo 100 caracteres.
CPF ou CNPJ do favorecido.*
Observação:
- O CPF ou CNPJ do favorecido pode ter no máximo 14 caracteres.
Código identificador do banco. Exemplo: 001 para Banco do Brasil, 104 para Caixa Econômica Federal, etc.*
Número da agência da conta bancária.*
Observação:
- O número da agência da conta bancária pode ter no máximo 10 caracteres.
Dígito verificador da agência da conta bancária.*
Observação:
- O dígito verificador da agência da conta bancária pode ter no máximo 1 caracter.
Número da conta bancária.
Observações:
- Para conta do tipo pagamento, informar o 'número da conta com dígito' (
contaPagamento). - Para conta de outros tipos, informar o 'número da conta' (
conta) e o 'dígito verificador' (contaDigito). - Caso nenhum dos campos referentes ao número da conta sejam informados, ocorrerá erro na requisição devido à falta de informação vital.
- O número da conta bancária pode ter no máximo 12 caracteres.
Dígito verificador da conta bancária.
Observação:
- O dígito verificador da conta bancária pode ter no máximo 1 caracter.
Número da conta bancária seguido do dígito verificador, sem espaços ou caracteres especiais.
Observação:
- O número da conta bancária seguido do dígito verificador pode ter no máximo 20 caracteres.
Tipo de conta.*
Valores: -1 - CACC 2 - SVGS 3 - TRAN 4 - SLRY
1, 2, 3, 4 Resposta
Success
Esta página foi útil?

