Gerar Cobrança de Parcela(s)

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/FGTS/GerarUnicaCobranca \
  --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>"
    }
  ],
  "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, onde são fornecidos parâmetros como quantidade de parcelas e data de vencimento. Possibilitando a escolha da data e das parcelas que desejam ser liquidadas.

A funcionalidade do endpoint abrange apenas a modalidade de cobrança:

• PIX Cobrança: geração de cobrança exclusivamente via chave PIX.

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 Cancelar Cobranças de Parcela.

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

Dto · object

Show child attributes

Resposta

200

text/plain

OK

Msg · string | null

HasError · boolean

Messages · object[] | null

Show child attributes

Cobrancas · object[] | null

Show child attributes