Atualizar boleto

POST https://api-stg.tbanks.com.br/bank-slip/{identifier}

Endpoint usado para atualizar um boleto emitido e não pago.

Introdução

Endpoint disponível para alteração de um boleto pelo campo nosso número(ourNumber) ou pelo código do identificador do boleto(identifier).

Detalhe importante: É possível alterar a data de vencimento de um boleto ou realizar a sua baixa.

Corpo da Requisição (Body)

Alteração de vencimento

Para que uma alteração de vencimento de boleto seja realizada com sucesso, é preciso que sejam informados os seguintes parâmetros no momento do envio da requisição:

• Tipo da alteração (updateType): Informe o tipo de alteração desejada no caso de alteração de vencimento: "DUE_DATE" (Obrigatório);

• Data de vencimento (dueDate): Informe a nova data de vencimento do boleto no padrão : "AAAA-MM-DD" (Obrigatório);

Detalhe importante: no caso da alteração de vencimento o campo dueDate é obrigatório.

OBSERVAÇÕES

1. Não é possível alterar data de vencimento de um boleto já baixado ou pago;
2. Nova data de vencimento tem que ser maior que a data de emissão do boleto.

JSON

{
  "updateType": "DUE_DATE",
  "dueDate": "2022-08-04"
}

Snippet 1: Exemplo de JSON para o alterar data de vencimento de um boleto.

Baixa de boletos

Para que uma baixa de boleto seja realizada com sucesso, é preciso que sejam informados os seguintes parâmetros no momento do envio da requisição:

• Tipo da alteração (updateType): Informe o tipo da alteração desejada no caso de baixa de boleto: "WRITE_OFF" (Obrigatório);

Detalhe importante: no caso de baixa de boletos o campo dueDate é opcional, não informar.

OBSERVAÇÕES

1. Não é possível baixar um boleto já baixado ou cancelado
2. Não é possível baixar um boleto que já foi liquidado

JSON

{
  "updateType": "WRITE_OFF"
  "dueDate": null
}

Snippet 2: Exemplo de JSON para realização de uma baixa de boleto.