Create a batch of COBV charges (Bacen /lotecobv)

​

Registers a batch of due-date charges for async processing. Bacen contract: responds 202 without a body; poll GET /lotecobv/{id} for per-item status.

Path Parameters
  • id
    Type: string
    required
Headers
  • x-branch
    Type: string
    required

    Branch of the charge owner account

  • x-account-number
    Type: string
    required

    Number of the charge owner account

  • Idempotency-Key
    Type: string
    required
Body·
required
application/json

Corpo para criação/alteração de lote de cobranças com vencimento (COBV) — Bacen LoteCobVBody

  • cobsv
    Type: array object[] · …200
    required

    Cobranças do lote, cada uma com seu txid fornecido pelo cliente

    Item de um lote COBV: txid fornecido pelo cliente + dados da cobrança com vencimento

  • descricao
    Type: string
    max length:  
    140
    required

    Descrição do lote

Responses
  • 200

    OK

Request Example for put/lotecobv/{id}
curl 'http://localhost/lotecobv/{id}' \
  --request PUT \
  --header 'x-branch: ' \
  --header 'x-account-number: ' \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "descricao": "Cobranças dos alunos do mês de julho",
  "cobsv": [
    {
      "txid": "txid12345678901234567890123456",
      "chave": "",
      "calendario": {
        "dataDeVencimento": "",
        "validadeAposVencimento": 0,
        "validAfterDueDaysOrDefault": 1
      },
      "valor": {
        "original": "",
        "multa": {
          "modalidade": "1",
          "valorPerc": ""
        },
        "juros": {
          "modalidade": "1",
          "valorPerc": ""
        },
        "abatimento": {
          "modalidade": "1",
          "valorPerc": ""
        },
        "desconto": {
          "modalidade": "1",
          "descontoDataFixa": [
            {
              "data": "",
              "valorPerc": ""
            }
          ],
          "valorPerc": ""
        }
      },
      "devedor": {
        "cpf": "",
        "cnpj": "",
        "nome": ""
      },
      "recebedor": {
        "nome": "",
        "cidade": "",
        "taxId": "",
        "endereco": {
          "logradouro": "",
          "cidade": "",
          "uf": "",
          "cep": ""
        }
      },
      "solicitacaoPagador": "",
      "infoAdicionais": [
        {
          "nome": "",
          "valor": ""
        }
      ],
      "locationId": "",
      "emitImage": true
    }
  ]
}'
No Body

OK