6 - Cancel Proposal

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/FGTS/CancelarProposta \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{}'

200

{
  "Msg": "<string>",
  "HasError": true,
  "Messages": [
    {
      "Code": "<string>",
      "Context": "<string>",
      "Description": "<string>",
      "Field": "<string>"
    }
  ],
  "Boleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

It is not possible to call the cancellation endpoint within 7 days of the proposal being disbursed or if it is in the assigned status (ID = 10).

Through this endpoint, the partner cancels an FGTS transaction, respecting the following rules:

• The transaction cannot exceed the 7-day period from the moment of disbursement;
• If the transaction is disbursed, the amount will need to be returned to us.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

Response

200

text/plain

OK

Msg · string | null

HasError · boolean

Messages · object[] | null

Show child attributes

Boleto · string<uuid> | null