cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>"
},
"dtoCancelarCobrancas": {
"codigosLiquidacoes": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas"
payload = {
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>"
},
"dtoCancelarCobrancas": { "codigosLiquidacoes": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
}
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({
dto: {
codigoProposta: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
codigoOperacao: '<string>'
},
dtoCancelarCobrancas: {codigosLiquidacoes: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']}
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas', 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/CancelarCobrancas",
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([
'dto' => [
'codigoProposta' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'codigoOperacao' => '<string>'
],
'dtoCancelarCobrancas' => [
'codigosLiquidacoes' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
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/CancelarCobrancas"
payload := strings.NewReader("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\"\n },\n \"dtoCancelarCobrancas\": {\n \"codigosLiquidacoes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\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/CancelarCobrancas")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\"\n },\n \"dtoCancelarCobrancas\": {\n \"codigosLiquidacoes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas")
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 \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\"\n },\n \"dtoCancelarCobrancas\": {\n \"codigosLiquidacoes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"parametros": [
{
"nome": "<string>",
"valor": "<string>"
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Charges
6 - Cancel Installment Charges
cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>"
},
"dtoCancelarCobrancas": {
"codigosLiquidacoes": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas"
payload = {
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>"
},
"dtoCancelarCobrancas": { "codigosLiquidacoes": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
}
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({
dto: {
codigoProposta: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
codigoOperacao: '<string>'
},
dtoCancelarCobrancas: {codigosLiquidacoes: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']}
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas', 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/CancelarCobrancas",
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([
'dto' => [
'codigoProposta' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'codigoOperacao' => '<string>'
],
'dtoCancelarCobrancas' => [
'codigosLiquidacoes' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
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/CancelarCobrancas"
payload := strings.NewReader("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\"\n },\n \"dtoCancelarCobrancas\": {\n \"codigosLiquidacoes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\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/CancelarCobrancas")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\"\n },\n \"dtoCancelarCobrancas\": {\n \"codigosLiquidacoes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas")
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 \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\"\n },\n \"dtoCancelarCobrancas\": {\n \"codigosLiquidacoes\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"parametros": [
{
"nome": "<string>",
"valor": "<string>"
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}This endpoint offers the possibility of canceling charges that were previously registered, either from PIX Cobrança or Boletos (common or hybrid).
It ensures that the charges associated with installments can be canceled and reissued, allowing for more precise control over the flow of payments.
The cancellation process is asynchronous, that is, the operation is performed in the background, and a callback is triggered to the partner as soon as the cancellation of the billing registration is complete, informing them that the ancellation was successful.
This process includes:
- Cancellation of Boleto;
- Cancellation of Hybrid Boleto;
- Cancellation of PIX Collection.
Use the value generated by the Settlement ID field, returned in the response from endpoints 4 - Generate a Charge and 5 - Generate Multiple Installment Charges, to cancel a collection negotiation.
Authorizations
Informe o token
Headers
Body
application/jsontext/jsonapplication/*+json
Was this page helpful?
⌘I

