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 '{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "nroParcelas": [
      123
    ]
  },
  "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
  }
}'
{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "cobrancas": [
    {
      "codigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parcelas": [
        123
      ]
    }
  ]
}

This endpoint allows the individual issuance of charges for specific contracts or installments.

It facilitates the creation of a custom bill, where parameters such as amount, due date, and payment method are provided, meeting the different needs of each customer.

Endpoint functionality encompasses three billing modalities:

  • Boleto: for generating traditional boletos;
  • Boleto Híbrido (with PIX): combination of traditional boleto with the option of payment via PIX;
  • PIX Collection: generation of collection exclusively via PIX. With this flexibility, the partner can create varied charges efficiently and tailored to customer needs.
The SettlementID field, generated in the response of this endpoint, needs to be saved. This amount is required to request cancellation of the charges issued for the installments, in endpoint 6 - Cancel Installment Charges.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

Response

200
text/plain

OK

The response is of type object.