Atualizar cobrança existente
Atualize o título, a descrição e os dados de integração de uma cobrança.
Atualiza o título, a descrição, a referência externa e os dados de metadata
de uma cobrança existente.
Use o identificador recebido na criação ou na consulta da cobrança,
na empresa e no ambiente da
sua chave de API.
Envie apenas os campos que deseja alterar. Campos omitidos mantêm o valor
atual; nos campos de texto, null ou texto vazio limpa o campo enviado. Um corpo vazio ({})
preserva os dados. Valor, vencimento e cliente vinculado permanecem como
definidos na criação.
O mapa metadata é atualizado por chave. Veja como acrescentar ou remover
valores em Dados adicionais da integração.
A edição aceita cobranças que permanecem abertas, inclusive após o vencimento.
Cobranças pagas, canceladas, devolvidas ou em outros estados finais permitem
alterar somente metadata. Se você misturar esses dados com os outros
campos em um pedido recusado pelo estado, nada será alterado.
Veja as regras de edição e substituição em
Atualizar uma cobrança.
Para relacionar a cobrança ao seu sistema, consulte
Referência no seu sistema.
Parâmetros de caminho
Identificador público da cobrança na Raims, recebido na criação ou na listagem de cobranças.
Até 100 caracteres
Parâmetros do corpo
Título da cobrança. Omita para manter o título atual; envie null ou texto vazio para removê-lo.
Até 512 caracteres
Descrição da cobrança. Omita para manter a descrição atual; envie null ou texto vazio para removê-la.
Até 512 caracteres
Referência do pedido ou da cobrança no seu sistema. Omita para manter o valor atual; envie null ou texto vazio para removê-lo. Pode ser repetida em outras cobranças e é independente da referência do cliente.
Até 120 caracteres
Dados de integração associados ao recurso. Informe pares de chave e texto. Chaves diferenciam maiúsculas de minúsculas. Omitir ou enviar {} preserva os dados; null remove todos os pares, e null em uma chave remove somente essa chave. Texto vazio é um valor válido.
Até 32 entradas, Chaves: até 40 caracteres, Valores: até 500 caracteres, JSON: até 8192 bytes UTF-8
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.