PATCH
/api/v1/BankSlip/UpdateBatchCobrança · Boletos
Método de atualização em lote dos boletos
Atualiza parcialmente um registro de api.
Visão geral
Método de atualização em lote dos boletos
Autenticação e pré-requisitos
Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.
Request
Parâmetros
Nenhum parâmetro de rota, query ou header.
Corpo da requisição
Envie no formato application/json. Corpo obrigatório.
Campos
| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
barCodes | array de string | opcional | — | — | [ … ] |
walletCode | integer (int64) | opcional | — | — | 0 |
interestMonthPercent | number (decimal) | opcional | — | — | 1.99 |
finePercent | number (decimal) | opcional | — | — | 1.99 |
deduction | integer | opcional | — | — | 0 |
Exemplo de corpo
{
"barCodes": [
"texto"
],
"walletCode": 0,
"interestMonthPercent": 1.99,
"finePercent": 1.99,
"deduction": 0
}Response
Sem resposta de sucesso documentada no contrato.
Códigos de retorno
| Código | Significado | Detalhe do contrato |
|---|---|---|
401 | Não autenticado — token ausente, inválido ou expirado. | — |
Exemplos
curl -X PATCH "{{baseUrl}}/api/v1/BankSlip/UpdateBatch" \
-H "Authorization: Bearer {{token}}" \
-H "Content-Type: application/json" \
-d '{
"barCodes": [
"texto"
],
"walletCode": 0,
"interestMonthPercent": 1.99,
"finePercent": 1.99,
"deduction": 0
}'var baseUrl = "{{baseUrl}}";
var token = "{{token}}";
using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", token);
var rota = "/api/v1/BankSlip/UpdateBatch";
var corpo = new StringContent(
"""
{
"barCodes": [
"texto"
],
"walletCode": 0,
"interestMonthPercent": 1.99,
"finePercent": 1.99,
"deduction": 0
}
""",
Encoding.UTF8, "application/json");
var resp = await http.PatchAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
// Sem corpo de resposta neste endpoint.const baseUrl = '{{baseUrl}}';
const token = '{{token}}';
const payload = {
"barCodes": [
"texto"
],
"walletCode": 0,
"interestMonthPercent": 1.99,
"finePercent": 1.99,
"deduction": 0
};
const resp = await fetch(`${baseUrl}/api/v1/BankSlip/UpdateBatch`, {
method: 'PATCH',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(payload),
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
// Sem corpo de resposta neste endpoint.Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.
Downloads
Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.
Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →
Guia de importação: Como importar no Postman · Todos os downloads: Downloads