Pular para o conteúdo principal
cURL
curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/GerarMultiplasCobrancas \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>"
  },
  "dtoGerarMultiplasLiquidacoes": {
    "descricaoLiquidacao": "<string>",
    "notificarCliente": true,
    "tipoRegistro": 123,
    "pagamentoViaBoleto": true,
    "pagamentoViaPIX": true,
    "parcelas": [
      {
        "nroParcela": 123,
        "dtVencimento": "2023-11-07T05:31:56Z",
        "dtExpiracao": "2023-11-07T05:31:56Z",
        "vlrDesconto": 123,
        "permiteDescapitalizacao": true
      }
    ]
  }
}
'
{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "cobrancas": [
    {
      "codigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parcelas": [
        123
      ]
    }
  ]
}
Este endpoint possibilita a emissão simultânea de múltiplas cobranças, sendo ideal para contratos que possuem várias parcelas ou quando há necessidade de gerar diversas cobranças ao mesmo tempo. Ele automatiza o processo de emissão de cobrança para múltiplas parcelas, tornando o processo mais ágil e reduzindo o tempo gasto com operações manuais. Assim como o endpoint AgendaRecebivelGerarUnicaCobranca, este também suporta os seguintes tipos de cobrança:
  • Boleto;
  • Boleto Híbrido (com PIX);
  • PIX Cobrança.
Este recurso é útil especialmente para parceiros que precisam gerar faturas em massa de forma simples e eficiente, com as mesmas opções de pagamento.
O campo codigoLiquidacao, gerado na resposta deste endpoint, precisa ser salvo. Esse valor é necessário para solicitar o cancelamento das cobranças emitidas para as parcelas, no endpoint 6 - Cancelar Cobranças de Parcela.

Autorizações

​
Authorization
string
header
obrigatório

Informe o token

Cabeçalhos

​
IdempotencyKey
string
obrigatório

Corpo

​
dto
object
​
dtoGerarMultiplasLiquidacoes
object

Resposta

OK

​
msg
string | null
​
hasError
boolean
​
messages
object[] | null
​
cobrancas
object[] | null