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>"
    }
  ]
}'
{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<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.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

​
dto
object
​
textoMotivoCancelamento
string | null

Campo para inserção do motivo do cancelamento

​
parametros
object[] | null

Response

200
text/plain
OK
​
msg
string | null
​
hasError
boolean
​
messages
object[] | null
​
parametros
object[] | null

Was this page helpful?