4 - Generate an Installment Charge

cURL

cURL

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": {
    "nroParcelas": [
      123
    ],
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>"
  },
  "dtoGerarUnicaLiquidacao": {
    "liquidacao": true,
    "descricaoLiquidacao": "<string>",
    "dtVencimento": "2023-11-07T05:31:56Z",
    "dtExpiracao": "2023-11-07T05:31:56Z",
    "pagamentoViaBoleto": true,
    "pagamentoViaPIX": true,
    "vlrLiquidacao": 123,
    "vlrDesconto": 123,
    "permiteDescapitalizacao": true,
    "tipoRegistro": 123
  }
}
'

200

{
  "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

dto · object

Show child attributes

dto. nroParcelas · integer<int32>[] | null · required

Array contendo o número das parcelas a serem consultadas.

dto. codigoProposta · string<uuid> | null

Código identificador da proposta na BMP.

dto. codigoOperacao · string | null

Código identificador da proposta (valor exclusivo do integrador).

Maximum string length: 50

dtoGerarUnicaLiquidacao · object

Show child attributes

dtoGerarUnicaLiquidacao. liquidacao · boolean · required

Indica se a cobrança gerada deve liquidar a parcela.

dtoGerarUnicaLiquidacao. descricaoLiquidacao · string | null · required

Define uma descrição para a cobrança gerada.

dtoGerarUnicaLiquidacao. dtVencimento · string<date-time> | null

Data de vencimento da cobrança.

dtoGerarUnicaLiquidacao. dtExpiracao · string<date-time> | null

Define a data limite de pagamento da cobrança.

dtoGerarUnicaLiquidacao. pagamentoViaBoleto · boolean

Define se a cobrança gerada será um boleto.

dtoGerarUnicaLiquidacao. pagamentoViaPIX · boolean

Define se a cobrança gerada será um Pix Cobrança.

dtoGerarUnicaLiquidacao. vlrLiquidacao · number<double> | null

Define o valor da cobrança gerada. Obs.: Caso 'Liquidacao' seja verdadeiro, não deve ser informado.

dtoGerarUnicaLiquidacao. vlrDesconto · number<double> | null

Define um valor de desconto para a cobrança gerada.

dtoGerarUnicaLiquidacao. permiteDescapitalizacao · boolean | null

Define se o valor da parcela deve ser descapitalizado para a data de vencimento da cobrança.

dtoGerarUnicaLiquidacao. tipoRegistro · integer<int32> | null

Define a modalidade de registro automático: 1 - Online; 2 - Offline.

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

messages. messageType · enum<integer>

Available options: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

cobrancas · object[] | null

Show child attributes

cobrancas. codigoLiquidacao · string<uuid>

cobrancas. parcelas · integer<int32>[] | null