--- title: "Criar/Alterar lote de cobranças com vencimento." method: PUT path: "/lotecobv/{id}" tags: ["LoteCobV"] --- # Criar/Alterar lote de cobranças com vencimento. `PUT /lotecobv/{id}` Endpoint utilizado para criar ou alterar um lote de cobranças com vencimento. Para o caso de uso de alteração de cobranças, o array a ser atribuído na requisicão deve ser composto pelas exatas requisições de criação de cobranças que constaram no array atribuído na requisição originária. Não se pode utilizar este endpoint para _alterar_ um lote de cobranças com vencimento agregando ou removendo cobranças já existentes dentro do conjunto de cobranças criadas na requisição originária do lote. Em outras palavras, se originalmente criou-se um lote, por exemplo, com as cobranças [`a`, `b` e `c`], não se pode _alterar_ esse conjunto de cobranças original que o lote representa para [`a`, `b`, `c`, `d`], ou para [`a`, `b`]. Por outro lado, pode-se alterar, _em lote_ as cobranças [`a`, `b`, `c`], conforme originalmente constam na requisição originária do lote. Uma solicitação de __criação__ de cobrança com status "EM_PROCESSAMENTO" ou "NEGADA" está associada a uma cobrança não _existe_ de fato, portanto não será listada em `GET /cobv` ou `GET /cobv/{txid}`. Uma cobrança, uma vez criada via `PUT /cobv/{txid}`, não pode ser associada a um lote posteriormente. Uma cobrança, uma vez criada via `PUT /lotecobv/{id}`, não pode ser associada a um novo lote posteriormente. ## Request body - object - `descricao` string, required - `cobsv` object[], required - `txid` string, required — # Identificador da transação O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos. Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`. Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix. - `calendario` CobDataDeVencimento, required - `dataDeVencimento` string, date, required — Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia. - `validadeAposVencimento` integer — Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga. Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador, ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir essa prorrogação, quando for o caso. Para ilustrar o funcionamento, seguem alguns exemplos, onde: - ``(#)`` representa a data de vencimento; - ``(*)`` representa a data ajustada em função de dias não úteis; - os ``()`` correspondem aos dias adicionais de validade para o pagamento. Exemplo A: ```txt dataDeVencimento: 2020-10-20, terça-feira. validadeAposVencimento: 4 Tenta-se pagar no dia 2020-10-20, terça: aceito. (#)(*) Tenta-se pagar no dia 2020-10-21, quarta: aceito. (1) Tenta-se pagar no dia 2020-10-22, quinta: aceito. (2) Tenta-se pagar no dia 2020-10-23, sexta: aceito. (3) Tenta-se pagar no dia 2020-10-24, sábado: aceito. Tenta-se pagar no dia 2020-10-25, domingo: aceito. (Feriado) Tenta-se pagar no dia 2020-10-26, segunda: aceito. (4) Tenta-se pagar no dia 2020-10-27, terça: negado. ``` Exemplo B: ```txt dataDeVencimento: 2020-12-25, sexta-feira, feriado. validadeAposVencimento: 0 Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado) Tenta-se pagar no dia 2020-12-26, sábado: aceito. Tenta-se pagar no dia 2020-12-27, domingo: aceito. Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*) Tenta-se pagar no dia 2020-12-29, terça: negado. ``` Exemplo C: ```txt dataDeVencimento: 2020-12-25, sexta-feira, feriado. validadeAposVencimento: 1 Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado) Tenta-se pagar no dia 2020-12-26, sábado: aceito. Tenta-se pagar no dia 2020-12-27, domingo: aceito. Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*) Tenta-se pagar no dia 2020-12-29, terça: aceito. (1) Tenta-se pagar no dia 2020-12-30, quarta: negado. ``` Exemplo D: ```txt dataDeVencimento: 2020-12-25, sexta-feira, feriado. validadeAposVencimento: 3 Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado) Tenta-se pagar no dia 2020-12-26, sábado: aceito. Tenta-se pagar no dia 2020-12-27, domingo: aceito. Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*) Tenta-se pagar no dia 2020-12-29, terça: aceito. (1) Tenta-se pagar no dia 2020-12-30, quarta: aceito. (2) Tenta-se pagar no dia 2020-12-31, quinta: aceito. (3) Tenta-se pagar no dia 2021-01-01, sexta: negado. ``` Exemplo E: ```txt dataDeVencimento: 2020-12-25, sexta-feira, feriado. validadeAposVencimento: 4 Tenta-se pagar no dia 2020-12-25, sexta: aceito. (#)(Feriado) Tenta-se pagar no dia 2020-12-26, sábado: aceito. Tenta-se pagar no dia 2020-12-27, domingo: aceito. Tenta-se pagar no dia 2020-12-28, segunda: aceito. (*) Tenta-se pagar no dia 2020-12-29, terça: aceito. (1) Tenta-se pagar no dia 2020-12-30, quarta: aceito. (2) Tenta-se pagar no dia 2020-12-31, quinta: aceito. (3) Tenta-se pagar no dia 2021-01-01, sexta: aceito. (Feriado) Tenta-se pagar no dia 2021-01-02, sábado: aceito. Tenta-se pagar no dia 2021-01-03, domingo: aceito. Tenta-se pagar no dia 2021-01-04, segunda: aceito. (4) Tenta-se pagar no dia 2021-01-05, terça: negado. ``` Exemplo F: ```txt dataDeVencimento: 2021-08-27, sexta-feira. validadeAposVencimento: 5 Tenta-se pagar no dia 2021-08-27, sexta: aceito. (#)(*) Tenta-se pagar no dia 2021-08-28, sábado: aceito. (1) Tenta-se pagar no dia 2021-08-29, domingo: aceito. (2) Tenta-se pagar no dia 2021-08-30, segunda: aceito. (3) Tenta-se pagar no dia 2021-08-31, terça: aceito. (4) Tenta-se pagar no dia 2021-09-01, quarta: aceito. (5) Tenta-se pagar no dia 2021-09-02, quinta: negado. ``` Exemplo G: ```txt dataDeVencimento: 2021-08-28, sábado. validadeAposVencimento: 5 Tenta-se pagar no dia 2021-08-28, sábado: aceito. (#) Tenta-se pagar no dia 2021-08-29, domingo: aceito. Tenta-se pagar no dia 2021-08-30, segunda: aceito. (*) Tenta-se pagar no dia 2021-08-31, terça: aceito. (1) Tenta-se pagar no dia 2021-09-01, quarta: aceito. (2) Tenta-se pagar no dia 2021-09-02, quinta: aceito. (3) Tenta-se pagar no dia 2021-09-03, sexta: aceito. (4) Tenta-se pagar no dia 2021-09-04, sabado: aceito. Tenta-se pagar no dia 2021-09-05, domingo: aceito. Tenta-se pagar no dia 2021-09-06, segunda: aceito. (5) ``` - `devedor` union, required - object - `cpf` string, required — CPF do usuário. - `nome` string, required — Nome do usuário. - `email` string — Email do usuário. - `logradouro` string — Logradouro do usuário. - `cidade` string — Cidade do usuário. - `uf` string — UF do usuário. - `cep` string — CEP do usuário. - object - `cnpj` string, required — CNPJ do usuário. - `nome` string, required — Nome do usuário. - `email` string — Email do usuário. - `logradouro` string — Logradouro do usuário. - `cidade` string — Cidade do usuário. - `uf` string — UF do usuário. - `cep` string — CEP do usuário. - `loc` PayloadLocationCob — Identificador da localização do payload. - `id` integer, required — Identificador da location a ser informada na criação da cobrança . - `valor` object, required — Valores monetários. - `original` string, required — Valor original da cobrança. - `multa` object — Multa aplicada à cobrança - `modalidade` integer, required — ##### Modalidade da multa, conforme tabela de domínios.
DescriçãoDomínio
Valor Fixo1
Percentual2
- `valorPerc` string, required — Multa do documento em valor absoluto ou percentual, conforme "valor.multa.modalidade". - `juros` object — Juro aplicado à cobrança - `modalidade` integer, required — ##### Modalidade de juros, conforme tabela de domínios.
DescriçãoDomínio
Valor (dias corridos)1
Percentual ao dia (dias corridos)2
Percentual ao mês (dias corridos)3
Percentual ao ano (dias corridos)4
Valor (dias úteis)5
Percentual ao dia (dias úteis)6
Percentual ao mês (dias úteis)7
Percentual ao ano (dias úteis)8
- `valorPerc` string, required - `abatimento` object — Abatimento aplicado à cobrança - `modalidade` integer, required — ##### Modalidade de abatimentos, conforme tabela de domínios.
DescriçãoDomínio
Valor Fixo1
Percentual2
- `valorPerc` string, required — Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento. - `desconto` union — Descontos aplicados à cobrança - object - `descontoDataFixa` object[] — Descontos absolutos aplicados à cobrança. - `data` string, date, required — Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par "data e valorPerc", para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor ou igual à data de vencimento da cobrança. - `valorPerc` string, required — Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme valor.desconto.modalidade - `modalidade` integer, required — ##### Modalidade de desconto, conforme tabela de domínios.
DescriçãoDomínio
Valor Fixo até a[s] data[s] informada[s]1
Percentual até a data informada2
Valor por antecipação dia corrido3
Valor por antecipação dia útil4
Percentual por antecipação dia corrido5
Percentual por antecipação dia útil6
- object - `valorPerc` string, required — Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento. - `modalidade` integer, required — ##### Modalidade de desconto, conforme tabela de domínios.
DescriçãoDomínio
Valor Fixo até a[s] data[s] informada[s]1
Percentual até a data informada2
Valor por antecipação dia corrido3
Valor por antecipação dia útil4
Percentual por antecipação dia corrido5
Percentual por antecipação dia útil6
- `chave` string, required — # Formato do campo chave * O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança. * Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP. * O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do [Manual de Padrões para iniciação do Pix](https://www.bcb.gov.br/estabilidadefinanceira/pix). - `solicitacaoPagador` string — O campo solicitacaoPagador, opcional, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. Esse texto será preenchido, na pacs.008, pelo PSP do pagador, no campo RemittanceInformation . O tamanho do campo na pacs.008 está limitado a 140 caracteres. - `infoAdicionais` object[] — Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador. - `nome` string, required — Nome do campo. - `valor` string, required — Dados do campo. ## Response `202` Lote de cobranças com vencimento solicitado para criação. ## Other responses - `400` — Requisição com formato inválido. - `403` — Requisição de participante autenticado que viola alguma regra de autorização. - `404` — Recurso solicitado não foi encontrado. - `503` — Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento. ## Changes > 35 revisions in range; 28 could not be searched. - **2020-06-29** `5967a4b6f934` — 1 breaking - api path removed without deprecation [Change history](https://skmtc.dev/bacen/apis/api-pix/changes/lotecobv/:id/put.md) --- [API](https://skmtc.dev/bacen/apis/api-pix.md) · [All operations](https://skmtc.dev/bacen/apis/api-pix/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bacen/api-pix/revisions/5c39d7116745/schema)