19 - Contract Cancellation

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "textoMotivoCancelamento": "<string>",
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ]
}
'

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar"

payload = {
    "dto": {
        "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoOperacao": "<string>",
        "numeroProposta": 123
    },
    "textoMotivoCancelamento": "<string>",
    "parametros": [
        {
            "nome": "<string>",
            "valor": "<string>"
        }
    ]
}
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>',
      numeroProposta: 123
    },
    textoMotivoCancelamento: '<string>',
    parametros: [{nome: '<string>', valor: '<string>'}]
  })
};

fetch('https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar', 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/Proposta/Cancelar",
  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>',
        'numeroProposta' => 123
    ],
    'textoMotivoCancelamento' => '<string>',
    'parametros' => [
        [
                'nome' => '<string>',
                'valor' => '<string>'
        ]
    ]
  ]),
  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/Proposta/Cancelar"

	payload := strings.NewReader("{\n  \"dto\": {\n    \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"codigoOperacao\": \"<string>\",\n    \"numeroProposta\": 123\n  },\n  \"textoMotivoCancelamento\": \"<string>\",\n  \"parametros\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\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/Proposta/Cancelar")
  .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    \"numeroProposta\": 123\n  },\n  \"textoMotivoCancelamento\": \"<string>\",\n  \"parametros\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar")

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    \"numeroProposta\": 123\n  },\n  \"textoMotivoCancelamento\": \"<string>\",\n  \"parametros\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\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>"
    }
  ]
}

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "textoMotivoCancelamento": "<string>",
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ]
}
'

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar"

payload = {
    "dto": {
        "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoOperacao": "<string>",
        "numeroProposta": 123
    },
    "textoMotivoCancelamento": "<string>",
    "parametros": [
        {
            "nome": "<string>",
            "valor": "<string>"
        }
    ]
}
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>',
      numeroProposta: 123
    },
    textoMotivoCancelamento: '<string>',
    parametros: [{nome: '<string>', valor: '<string>'}]
  })
};

fetch('https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar', 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/Proposta/Cancelar",
  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>',
        'numeroProposta' => 123
    ],
    'textoMotivoCancelamento' => '<string>',
    'parametros' => [
        [
                'nome' => '<string>',
                'valor' => '<string>'
        ]
    ]
  ]),
  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/Proposta/Cancelar"

	payload := strings.NewReader("{\n  \"dto\": {\n    \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"codigoOperacao\": \"<string>\",\n    \"numeroProposta\": 123\n  },\n  \"textoMotivoCancelamento\": \"<string>\",\n  \"parametros\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\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/Proposta/Cancelar")
  .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    \"numeroProposta\": 123\n  },\n  \"textoMotivoCancelamento\": \"<string>\",\n  \"parametros\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Proposta/Cancelar")

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    \"numeroProposta\": 123\n  },\n  \"textoMotivoCancelamento\": \"<string>\",\n  \"parametros\": [\n    {\n      \"nome\": \"<string>\",\n      \"valor\": \"<string>\"\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>"
    }
  ]
}

Through this endpoint, the partner can cancel a previously established proposal. To use this functionality, consider the following requirements:

The proposal cannot have a paid status or be linked to a payment batch;
The proposal cannot be ceded or linked to a cession batch;
The maximum cancellation period for the proposal is up to seven days.

Show Messaging - Proposta Cancelar

Category	Operation	Action	Code	Detailed Code	Message
Proposta	PropostaCancelar	Cancelar	C0067	V0001	Não é permitido o cancelamento da proposta por este parceiro
Proposta	PropostaCancelar	Cancelar	C0067	V0002	Situação da Proposta não permite Cancelamento
Proposta	PropostaCancelar	Cancelar	C0067	V0003	Situação da Proposta não permite Cancelamento
Proposta	PropostaCancelar	Cancelar	C0067	V0004	Prazo para cancelamento de `{nroDiasCancelamento}` dias foi ultrapassado
Proposta	PropostaCancelar	Cancelar	C0067	V0005	Situação da Proposta não permite Cancelamento
Proposta	PropostaCancelar	Cancelar	C0067	V0006	Situação da Proposta não permite Cancelamento
Proposta	PropostaCancelar	Cancelar	C0067	V0007	Situação da Proposta não permite Cancelamento
Proposta	PropostaCancelar	Cancelar	C0067	V0008	Proposta não pode ser aprovada, pois sua situação é `{SituacaoPropostaEnum.GetDescricao(proposta.Situacao)}`
Proposta	PropostaCancelar	Cancelar	C0112	V0001	Proposta não encontrada
Proposta	PropostaCancelar	Cancelar	C0112	V0002	A Proposta não pertence à esta Integração
Proposta	PropostaCancelar	Cancelar	C0194	V0001	Proposta não localizada
Proposta	PropostaCancelar	Cancelar	C0194	V0002	Proposta já foi cancelada
Proposta	PropostaCancelar	Cancelar	C0194	V0003	Proposta está em uma Cessão, não é possível cancelar
Proposta	PropostaCancelar	Cancelar	C0194	V0004	Informe o motivo de cancelamento
Proposta	PropostaCancelar	Cancelar	C0194	V0005	Proposta foi enviada na remessa de pagamento
Proposta	PropostaCancelar	Cancelar	C0185	V0001	Informe o valor aprovado e a quantidade de parcelas
Proposta	PropostaCancelar	Cancelar	C0185	V0002	Valor aprovado não pode ser superior ao valor solicitado
Proposta	PropostaCancelar	Cancelar	C0185	V0003	Valor/Prazo aprovado não pode ser diferente do Valor/Prazo solicitado
Proposta	PropostaCancelar	Cancelar	C0185	V0004	A Proposta deve ter pelo menos 1(um) Assinante cadastrado
Proposta	PropostaCancelar	Cancelar	C0185	V0005	É necessário informar o E-mail e Celular de todos os Assinantes
Proposta	PropostaCancelar	Cancelar	C0185	V0006	Proposta não deve ter boletos.
Proposta	PropostaCancelar	Cancelar	C0185	V0007	Motivo de Rejeição deve ser informado
Proposta	PropostaCancelar	Cancelar	C0185	V0008	Valor e Prazo não podem ser alterados quando o cálculo da parcela é sem juros
Proposta	PropostaCancelar	Cancelar	C0185	V0009	Percentual de Juros deve ser informado
Proposta	PropostaCancelar	Cancelar	C0185	V0010	Valor da Parcela deve ser informado
Proposta	PropostaCancelar	Cancelar	C0185	V0011	Proposta deve ter parcelas geradas antes de ser finalizada.

Authorizations

Authorization

string

header

required

Informe o token

Headers

IdempotencyKey

string

required

Body

dto

object

Show child attributes

textoMotivoCancelamento

string | null

Campo para inserção do motivo do cancelamento

parametros

object[] | null

Show child attributes

Response

msg

string | null

hasError

boolean

messages

object[] | null

Show child attributes

parametros

object[] | null

Show child attributes

18 - Contract Generation 20 - Approve

Initial Guide

Signature Methods

Developer's Guide

APIs Reference

Use Cases

19 - Contract Cancellation

Authorizations

Headers

Body

Response