Pular para o conteúdo principal
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": {
    "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
      ]
    }
  ]
}
Este endpoint permite a emissão individual de cobranças para contratos ou parcelas específicas. Ele facilita a criação de uma cobrança personalizada, onde são fornecidos parâmetros como valor, data de vencimento e forma de pagamento, atendendo a diferentes necessidades de cada cliente. A funcionalidade do endpoint abrange três modalidades de cobrança:
  • Boleto: para geração de boletos tradicionais;
  • Boleto Híbrido (com PIX): combinação de boleto tradicional com a opção de pagamento via PIX;
  • PIX Cobrança: geração de cobrança exclusivamente via PIX.
Com essa flexibilidade, o parceiro pode criar cobranças variadas de forma eficiente e adaptada às necessidades dos clientes.
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.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

​
dto
object
​
dtoGerarUnicaLiquidacao
object

Response

OK

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