cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"dtoConsultaDetalhes": {
"trazerBoleto": true,
"trazerAgendaDetalhada": true
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes"
payload = { "dtoConsultaDetalhes": {
"trazerBoleto": True,
"trazerAgendaDetalhada": True
} }
headers = {
"IdempotencyKey": "<idempotencykey>",
"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>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({dtoConsultaDetalhes: {trazerBoleto: true, trazerAgendaDetalhada: true}})
};
fetch('https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes', 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.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes",
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([
'dtoConsultaDetalhes' => [
'trazerBoleto' => true,
'trazerAgendaDetalhada' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$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.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes"
payload := strings.NewReader("{\n \"dtoConsultaDetalhes\": {\n \"trazerBoleto\": true,\n \"trazerAgendaDetalhada\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
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.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dtoConsultaDetalhes\": {\n \"trazerBoleto\": true,\n \"trazerAgendaDetalhada\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dtoConsultaDetalhes\": {\n \"trazerBoleto\": true,\n \"trazerAgendaDetalhada\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"numeroProposta": 123,
"dtInclusao": "2023-11-07T05:31:56Z",
"dtCancelamento": "2023-11-07T05:31:56Z",
"dtLiquidacao": "2023-11-07T05:31:56Z",
"descricaoSituacaoAgenda": "<string>",
"documentoFederalCliente": "<string>",
"nomeCliente": "<string>",
"nomeEmpresa": "<string>",
"ecCliente": "<string>",
"vlrFinanciado": 123,
"vlrRetencaoDiarioAprox": 123,
"vlrTotalPago": 123,
"qtdeParcelas": 123,
"situacaoProposta": 123,
"descricaoTipoContrato": "<string>",
"parcelas": [
{
"codigoParcela": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nroParcela": 123,
"situacao": 123,
"dtVencimento": "2023-11-07T05:31:56Z",
"vlrParcela": 123,
"nroOrdemPagamento": "<string>",
"vlrSaldoAtual": 123,
"vlrTotalPago": 123,
"vlrDesconto": 123,
"dtVencimentoAtual": "2023-11-07T05:31:56Z",
"boletos": [
{
"numeroBoleto": 123,
"liquidacao": true,
"dtCredito": "2023-11-07T05:31:56Z",
"dtExpiracao": "2023-11-07T05:31:56Z",
"linhaDigitavel": "<string>",
"operacaoBoletoRegistro": 123,
"situacaoBoletoRegistro": 123,
"descricaoBoletoRegistro": "<string>",
"urlImpressao": "<string>",
"qrCode": {
"emv": "<string>",
"imagem": "<string>"
}
}
],
"pix": [
{
"liquidacao": true,
"dtCredito": "2023-11-07T05:31:56Z",
"dtVencimento": "2023-11-07T05:31:56Z",
"dtExpiracao": "2023-11-07T05:31:56Z",
"emv": "<string>",
"imagem": "<string>"
}
],
"lancamentos": [
{
"dtVencimento": "2023-11-07T05:31:56Z",
"dtLancamento": "2023-11-07T05:31:56Z",
"vlrParcela": 123,
"vlrMulta": 123,
"vlrJuros": 123,
"vlrMora": 123,
"vlrIOF": 123,
"vlrTarifas": 123,
"vlrAbatimento": 123,
"vlrParcelaAtualizado": 123,
"vlrPagamento": 123,
"vlrSaldoParcela": 123,
"vlrDesconto": 123,
"informarFundo": true,
"descLancamento": "<string>",
"viaBoleto": true
}
]
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Consult
2 - Consult Details
cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"dtoConsultaDetalhes": {
"trazerBoleto": true,
"trazerAgendaDetalhada": true
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes"
payload = { "dtoConsultaDetalhes": {
"trazerBoleto": True,
"trazerAgendaDetalhada": True
} }
headers = {
"IdempotencyKey": "<idempotencykey>",
"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>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({dtoConsultaDetalhes: {trazerBoleto: true, trazerAgendaDetalhada: true}})
};
fetch('https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes', 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.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes",
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([
'dtoConsultaDetalhes' => [
'trazerBoleto' => true,
'trazerAgendaDetalhada' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$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.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes"
payload := strings.NewReader("{\n \"dtoConsultaDetalhes\": {\n \"trazerBoleto\": true,\n \"trazerAgendaDetalhada\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
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.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dtoConsultaDetalhes\": {\n \"trazerBoleto\": true,\n \"trazerAgendaDetalhada\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarDetalhes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dtoConsultaDetalhes\": {\n \"trazerBoleto\": true,\n \"trazerAgendaDetalhada\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"numeroProposta": 123,
"dtInclusao": "2023-11-07T05:31:56Z",
"dtCancelamento": "2023-11-07T05:31:56Z",
"dtLiquidacao": "2023-11-07T05:31:56Z",
"descricaoSituacaoAgenda": "<string>",
"documentoFederalCliente": "<string>",
"nomeCliente": "<string>",
"nomeEmpresa": "<string>",
"ecCliente": "<string>",
"vlrFinanciado": 123,
"vlrRetencaoDiarioAprox": 123,
"vlrTotalPago": 123,
"qtdeParcelas": 123,
"situacaoProposta": 123,
"descricaoTipoContrato": "<string>",
"parcelas": [
{
"codigoParcela": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nroParcela": 123,
"situacao": 123,
"dtVencimento": "2023-11-07T05:31:56Z",
"vlrParcela": 123,
"nroOrdemPagamento": "<string>",
"vlrSaldoAtual": 123,
"vlrTotalPago": 123,
"vlrDesconto": 123,
"dtVencimentoAtual": "2023-11-07T05:31:56Z",
"boletos": [
{
"numeroBoleto": 123,
"liquidacao": true,
"dtCredito": "2023-11-07T05:31:56Z",
"dtExpiracao": "2023-11-07T05:31:56Z",
"linhaDigitavel": "<string>",
"operacaoBoletoRegistro": 123,
"situacaoBoletoRegistro": 123,
"descricaoBoletoRegistro": "<string>",
"urlImpressao": "<string>",
"qrCode": {
"emv": "<string>",
"imagem": "<string>"
}
}
],
"pix": [
{
"liquidacao": true,
"dtCredito": "2023-11-07T05:31:56Z",
"dtVencimento": "2023-11-07T05:31:56Z",
"dtExpiracao": "2023-11-07T05:31:56Z",
"emv": "<string>",
"imagem": "<string>"
}
],
"lancamentos": [
{
"dtVencimento": "2023-11-07T05:31:56Z",
"dtLancamento": "2023-11-07T05:31:56Z",
"vlrParcela": 123,
"vlrMulta": 123,
"vlrJuros": 123,
"vlrMora": 123,
"vlrIOF": 123,
"vlrTarifas": 123,
"vlrAbatimento": 123,
"vlrParcelaAtualizado": 123,
"vlrPagamento": 123,
"vlrSaldoParcela": 123,
"vlrDesconto": 123,
"informarFundo": true,
"descLancamento": "<string>",
"viaBoleto": true
}
]
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Displays the essential information of a contract for the informed proposal, as well as:
- Installments;
- Bills;
- Entries made and status of the bill registration.
Authorizations
Informe o token
Headers
Body
application/jsontext/jsonapplication/*+json
Response
OK
Show child attributes
Show child attributes
Available options:
0, 1, 2 Show child attributes
Show child attributes
Was this page helpful?
⌘I

