cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"auth": {},
"dto": {
"CodigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CodigoOperacao": "<string>",
"NroParcelas": [
1,
2,
3
]
},
"dtoGerarUnicaLiquidacao": {
"DtVencimento": "2023-11-07T05:31:56Z",
"DtExpiracao": "2023-11-07T05:31:56Z",
"Liquidacao": true,
"PagamentoViaBoleto": true,
"PagamentoViaPix": true,
"DescricaoLiquidacao": "<string>",
"VlrLiquidacao": 123,
"VlrDesconto": 123,
"PermiteDescapitalizacao": true,
"TipoRegistro": 123
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca"
payload = {
"auth": {},
"dto": {
"CodigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CodigoOperacao": "<string>",
"NroParcelas": [1, 2, 3]
},
"dtoGerarUnicaLiquidacao": {
"DtVencimento": "2023-11-07T05:31:56Z",
"DtExpiracao": "2023-11-07T05:31:56Z",
"Liquidacao": True,
"PagamentoViaBoleto": True,
"PagamentoViaPix": True,
"DescricaoLiquidacao": "<string>",
"VlrLiquidacao": 123,
"VlrDesconto": 123,
"PermiteDescapitalizacao": True,
"TipoRegistro": 123
}
}
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({
auth: {},
dto: {
CodigoProposta: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
CodigoOperacao: '<string>',
NroParcelas: [1, 2, 3]
},
dtoGerarUnicaLiquidacao: {
DtVencimento: '2023-11-07T05:31:56Z',
DtExpiracao: '2023-11-07T05:31:56Z',
Liquidacao: true,
PagamentoViaBoleto: true,
PagamentoViaPix: true,
DescricaoLiquidacao: '<string>',
VlrLiquidacao: 123,
VlrDesconto: 123,
PermiteDescapitalizacao: true,
TipoRegistro: 123
}
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca', 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/GerarUnicaCobranca",
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([
'auth' => [
],
'dto' => [
'CodigoProposta' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'CodigoOperacao' => '<string>',
'NroParcelas' => [
1,
2,
3
]
],
'dtoGerarUnicaLiquidacao' => [
'DtVencimento' => '2023-11-07T05:31:56Z',
'DtExpiracao' => '2023-11-07T05:31:56Z',
'Liquidacao' => true,
'PagamentoViaBoleto' => true,
'PagamentoViaPix' => true,
'DescricaoLiquidacao' => '<string>',
'VlrLiquidacao' => 123,
'VlrDesconto' => 123,
'PermiteDescapitalizacao' => true,
'TipoRegistro' => 123
]
]),
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/GerarUnicaCobranca"
payload := strings.NewReader("{\n \"auth\": {},\n \"dto\": {\n \"CodigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"CodigoOperacao\": \"<string>\",\n \"NroParcelas\": [\n 1,\n 2,\n 3\n ]\n },\n \"dtoGerarUnicaLiquidacao\": {\n \"DtVencimento\": \"2023-11-07T05:31:56Z\",\n \"DtExpiracao\": \"2023-11-07T05:31:56Z\",\n \"Liquidacao\": true,\n \"PagamentoViaBoleto\": true,\n \"PagamentoViaPix\": true,\n \"DescricaoLiquidacao\": \"<string>\",\n \"VlrLiquidacao\": 123,\n \"VlrDesconto\": 123,\n \"PermiteDescapitalizacao\": true,\n \"TipoRegistro\": 123\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/GerarUnicaCobranca")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auth\": {},\n \"dto\": {\n \"CodigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"CodigoOperacao\": \"<string>\",\n \"NroParcelas\": [\n 1,\n 2,\n 3\n ]\n },\n \"dtoGerarUnicaLiquidacao\": {\n \"DtVencimento\": \"2023-11-07T05:31:56Z\",\n \"DtExpiracao\": \"2023-11-07T05:31:56Z\",\n \"Liquidacao\": true,\n \"PagamentoViaBoleto\": true,\n \"PagamentoViaPix\": true,\n \"DescricaoLiquidacao\": \"<string>\",\n \"VlrLiquidacao\": 123,\n \"VlrDesconto\": 123,\n \"PermiteDescapitalizacao\": true,\n \"TipoRegistro\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca")
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 \"auth\": {},\n \"dto\": {\n \"CodigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"CodigoOperacao\": \"<string>\",\n \"NroParcelas\": [\n 1,\n 2,\n 3\n ]\n },\n \"dtoGerarUnicaLiquidacao\": {\n \"DtVencimento\": \"2023-11-07T05:31:56Z\",\n \"DtExpiracao\": \"2023-11-07T05:31:56Z\",\n \"Liquidacao\": true,\n \"PagamentoViaBoleto\": true,\n \"PagamentoViaPix\": true,\n \"DescricaoLiquidacao\": \"<string>\",\n \"VlrLiquidacao\": 123,\n \"VlrDesconto\": 123,\n \"PermiteDescapitalizacao\": true,\n \"TipoRegistro\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"cobrancas": [
{
"codigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parcelas": [
123
]
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Cobranças
4 - Gerar uma Cobrança de Parcela
cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"auth": {},
"dto": {
"CodigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CodigoOperacao": "<string>",
"NroParcelas": [
1,
2,
3
]
},
"dtoGerarUnicaLiquidacao": {
"DtVencimento": "2023-11-07T05:31:56Z",
"DtExpiracao": "2023-11-07T05:31:56Z",
"Liquidacao": true,
"PagamentoViaBoleto": true,
"PagamentoViaPix": true,
"DescricaoLiquidacao": "<string>",
"VlrLiquidacao": 123,
"VlrDesconto": 123,
"PermiteDescapitalizacao": true,
"TipoRegistro": 123
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca"
payload = {
"auth": {},
"dto": {
"CodigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CodigoOperacao": "<string>",
"NroParcelas": [1, 2, 3]
},
"dtoGerarUnicaLiquidacao": {
"DtVencimento": "2023-11-07T05:31:56Z",
"DtExpiracao": "2023-11-07T05:31:56Z",
"Liquidacao": True,
"PagamentoViaBoleto": True,
"PagamentoViaPix": True,
"DescricaoLiquidacao": "<string>",
"VlrLiquidacao": 123,
"VlrDesconto": 123,
"PermiteDescapitalizacao": True,
"TipoRegistro": 123
}
}
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({
auth: {},
dto: {
CodigoProposta: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
CodigoOperacao: '<string>',
NroParcelas: [1, 2, 3]
},
dtoGerarUnicaLiquidacao: {
DtVencimento: '2023-11-07T05:31:56Z',
DtExpiracao: '2023-11-07T05:31:56Z',
Liquidacao: true,
PagamentoViaBoleto: true,
PagamentoViaPix: true,
DescricaoLiquidacao: '<string>',
VlrLiquidacao: 123,
VlrDesconto: 123,
PermiteDescapitalizacao: true,
TipoRegistro: 123
}
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca', 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/GerarUnicaCobranca",
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([
'auth' => [
],
'dto' => [
'CodigoProposta' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'CodigoOperacao' => '<string>',
'NroParcelas' => [
1,
2,
3
]
],
'dtoGerarUnicaLiquidacao' => [
'DtVencimento' => '2023-11-07T05:31:56Z',
'DtExpiracao' => '2023-11-07T05:31:56Z',
'Liquidacao' => true,
'PagamentoViaBoleto' => true,
'PagamentoViaPix' => true,
'DescricaoLiquidacao' => '<string>',
'VlrLiquidacao' => 123,
'VlrDesconto' => 123,
'PermiteDescapitalizacao' => true,
'TipoRegistro' => 123
]
]),
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/GerarUnicaCobranca"
payload := strings.NewReader("{\n \"auth\": {},\n \"dto\": {\n \"CodigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"CodigoOperacao\": \"<string>\",\n \"NroParcelas\": [\n 1,\n 2,\n 3\n ]\n },\n \"dtoGerarUnicaLiquidacao\": {\n \"DtVencimento\": \"2023-11-07T05:31:56Z\",\n \"DtExpiracao\": \"2023-11-07T05:31:56Z\",\n \"Liquidacao\": true,\n \"PagamentoViaBoleto\": true,\n \"PagamentoViaPix\": true,\n \"DescricaoLiquidacao\": \"<string>\",\n \"VlrLiquidacao\": 123,\n \"VlrDesconto\": 123,\n \"PermiteDescapitalizacao\": true,\n \"TipoRegistro\": 123\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/GerarUnicaCobranca")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auth\": {},\n \"dto\": {\n \"CodigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"CodigoOperacao\": \"<string>\",\n \"NroParcelas\": [\n 1,\n 2,\n 3\n ]\n },\n \"dtoGerarUnicaLiquidacao\": {\n \"DtVencimento\": \"2023-11-07T05:31:56Z\",\n \"DtExpiracao\": \"2023-11-07T05:31:56Z\",\n \"Liquidacao\": true,\n \"PagamentoViaBoleto\": true,\n \"PagamentoViaPix\": true,\n \"DescricaoLiquidacao\": \"<string>\",\n \"VlrLiquidacao\": 123,\n \"VlrDesconto\": 123,\n \"PermiteDescapitalizacao\": true,\n \"TipoRegistro\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarUnicaCobranca")
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 \"auth\": {},\n \"dto\": {\n \"CodigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"CodigoOperacao\": \"<string>\",\n \"NroParcelas\": [\n 1,\n 2,\n 3\n ]\n },\n \"dtoGerarUnicaLiquidacao\": {\n \"DtVencimento\": \"2023-11-07T05:31:56Z\",\n \"DtExpiracao\": \"2023-11-07T05:31:56Z\",\n \"Liquidacao\": true,\n \"PagamentoViaBoleto\": true,\n \"PagamentoViaPix\": true,\n \"DescricaoLiquidacao\": \"<string>\",\n \"VlrLiquidacao\": 123,\n \"VlrDesconto\": 123,\n \"PermiteDescapitalizacao\": true,\n \"TipoRegistro\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"cobrancas": [
{
"codigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parcelas": [
123
]
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Este endpoint permite a emissão individual de cobranças para contratos ou parcelas específicas.
Ele facilita a criação de uma cobrança personalizada, onde são fornecidos parâmetros como valor, data de vencimento e forma de pagamento, atendendo a diferentes necessidades de cada cliente.
A funcionalidade do endpoint abrange três modalidades de cobrança:
- Boleto: para geração de boletos tradicionais;
- Boleto Híbrido (com PIX): combinação de boleto tradicional com a opção de pagamento via PIX;
- PIX Cobrança: geração de cobrança exclusivamente via PIX.
O campo
codigoLiquidacao, gerado na resposta deste endpoint, precisa ser salvo. Esse valor é necessário para solicitar o cancelamento das cobranças emitidas para as parcelas, no endpoint 6 - Cancelar Cobranças de Parcela.Autorizações
Informe o token
Cabeçalhos
Corpo
application/jsontext/jsonapplication/*+json
Esta página foi útil?