Consulta os dados do registro de um boleto bancário.
curl --request GET \
--url https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro \
--header 'Authorization: <api-key>'import requests
url = "https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro', 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/Boleto/ConsultarRegistro",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>",
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numeroCedente": 123,
"dtInclusao": "2023-11-07T05:31:56Z",
"tpPessoaPagdr": "<string>",
"cnpJ_CPFPagdr": "<string>",
"nom_RzSocPagdr": "<string>",
"nomFantsPagdr": "<string>",
"logradPagdr": "<string>",
"cidPagdr": "<string>",
"ufPagdr": "<string>",
"cepPagdr": "<string>",
"codCartTit": "<string>",
"codMoedaCNAB": "<string>",
"identdNossoNum": "<string>",
"numCodBarras": "<string>",
"numLinhaDigtvl": "<string>",
"dtVencTit": "2023-11-07T05:31:56Z",
"vlrTit": 123,
"numDocTit": "<string>",
"numeroDocumento": "<string>",
"codEspTit": "<string>",
"dtEmsTit": "2023-11-07T05:31:56Z",
"dtLimPgtoTit": "2023-11-07T05:31:56Z",
"indrBloqPgto": "<string>",
"vlrAbattTit": 123,
"tpAutcRecbtVlrDivgte": "<string>",
"dtMovto": "2023-11-07T05:31:56Z",
"numIdentcTit": "<string>",
"dtHrDDA": "2023-11-07T05:31:56Z",
"codOperacaoCli": "<string>",
"dtSituacao": "2023-11-07T05:31:56Z",
"msgSituacao": "<string>",
"situacaoBoleto": 1,
"dadosJuros": {
"dtJurosTit": "2023-11-07T05:31:56Z",
"codJurosTit": "<string>",
"vlr_PercJurosTit": 123
},
"sacadorAvalista": {
"tipo": 0,
"identificador": "<string>",
"nomeSacadorAvalista": "<string>"
},
"dadosDesconto": {
"dtDesctTit": "2023-11-07T05:31:56Z",
"codDesctTit": "<string>",
"vlr_PercDesctTit": 123
},
"dadosDescontos": [
{
"dtDesctTit": "2023-11-07T05:31:56Z",
"codDesctTit": "<string>",
"vlr_PercDesctTit": 123
}
],
"dadosBaixa": {
"dtCreditoBoleto": "2023-11-07T05:31:56Z",
"codigoMovto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vlrBaixaOperacTit": 123,
"dtHrDDA": "2023-11-07T05:31:56Z"
},
"hibrido": true,
"emv": "<string>",
"imagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}Boletos
56 - Consultar Registro de Boleto
Scopes:
api.ext api.boleto.consultarRegistroConsulta os dados do registro de um boleto bancário.
curl --request GET \
--url https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro \
--header 'Authorization: <api-key>'import requests
url = "https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro', 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/Boleto/ConsultarRegistro",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.dbs.moneyp.dev.br/api/Boleto/ConsultarRegistro")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>",
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numeroCedente": 123,
"dtInclusao": "2023-11-07T05:31:56Z",
"tpPessoaPagdr": "<string>",
"cnpJ_CPFPagdr": "<string>",
"nom_RzSocPagdr": "<string>",
"nomFantsPagdr": "<string>",
"logradPagdr": "<string>",
"cidPagdr": "<string>",
"ufPagdr": "<string>",
"cepPagdr": "<string>",
"codCartTit": "<string>",
"codMoedaCNAB": "<string>",
"identdNossoNum": "<string>",
"numCodBarras": "<string>",
"numLinhaDigtvl": "<string>",
"dtVencTit": "2023-11-07T05:31:56Z",
"vlrTit": 123,
"numDocTit": "<string>",
"numeroDocumento": "<string>",
"codEspTit": "<string>",
"dtEmsTit": "2023-11-07T05:31:56Z",
"dtLimPgtoTit": "2023-11-07T05:31:56Z",
"indrBloqPgto": "<string>",
"vlrAbattTit": 123,
"tpAutcRecbtVlrDivgte": "<string>",
"dtMovto": "2023-11-07T05:31:56Z",
"numIdentcTit": "<string>",
"dtHrDDA": "2023-11-07T05:31:56Z",
"codOperacaoCli": "<string>",
"dtSituacao": "2023-11-07T05:31:56Z",
"msgSituacao": "<string>",
"situacaoBoleto": 1,
"dadosJuros": {
"dtJurosTit": "2023-11-07T05:31:56Z",
"codJurosTit": "<string>",
"vlr_PercJurosTit": 123
},
"sacadorAvalista": {
"tipo": 0,
"identificador": "<string>",
"nomeSacadorAvalista": "<string>"
},
"dadosDesconto": {
"dtDesctTit": "2023-11-07T05:31:56Z",
"codDesctTit": "<string>",
"vlr_PercDesctTit": 123
},
"dadosDescontos": [
{
"dtDesctTit": "2023-11-07T05:31:56Z",
"codDesctTit": "<string>",
"vlr_PercDesctTit": 123
}
],
"dadosBaixa": {
"dtCreditoBoleto": "2023-11-07T05:31:56Z",
"codigoMovto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vlrBaixaOperacTit": 123,
"dtHrDDA": "2023-11-07T05:31:56Z"
},
"hibrido": true,
"emv": "<string>",
"imagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}Por meio desse endpoint, o parceiro pode consultar o registro de um determinado boleto junto ao órgão responsável.
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/Boleto/ConsultarRegistro | Parâmetro inválido |
| /api/Boleto/ConsultarRegistro | Somente um parâmetro deve ser informado |
| /api/Boleto/ConsultarRegistro | O código de barras não pode exceder 44 caracteres |
| /api/Boleto/ConsultarRegistro | Registro não encontrado |
| /api/Boleto/ConsultarRegistro | Registro não encontrado |
Autorizações
Copie 'Bearer ' + token
Parâmetros de consulta
Código UUID de registro do boleto.
Observação:
- Quando o 'código UUID de registro do boleto' (
CodigoRegistroBoleto) for informado, o 'código de barras do boleto' (CodigoBarras) não deve ser preenchido.
Código de barras do boleto.
Observação:
- Quando o 'código de barras do boleto' (
CodigoBarras) for informado, o 'código UUID de registro do boleto' (CodigoRegistroBoleto) não deve ser preenchido.
Resposta
Success
Opções disponíveis:
1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Esta página foi útil?

