Pular para o conteúdo principal

​
Visão Geral

Verifica e consulta os dados atualizados de um boleto através do código de barras ou linha digitável, sem efetuar o pagamento. Útil para mostrar ao usuário final o valor atualizado com juros/multas antes de confirmar a operação.
Este endpoint NÃO efetua o pagamento do boleto. Ele apenas consulta as informações atualizadas. Para realizar o pagamento, utilize o endpoint Pagar Boleto.

​
Casos de Uso

  • Exibir valor atualizado do boleto (com juros/multa) antes do pagamento
  • Validar se o boleto é válido e está disponível para pagamento
  • Verificar data de vencimento e condições de pagamento
  • Obter dados do cedente (empresa que emitiu o boleto)

​
Parâmetros da Requisição

​
barcode
string
required
Código de barras ou linha digitável do boleto (apenas números)Formatos aceitos:
  • Código de barras: 44 dígitos
  • Linha digitável: 47 dígitos
Exemplo: 34191091000000150001234567880000012345678901

​
Resposta de Sucesso

​
assignor
string
Nome do cedente (empresa que emitiu o boleto)
​
originalValue
number
Valor original do boleto (sem juros/multas)
​
totalUpdated
number
Valor total atualizado para pagamento (com juros/multas se aplicável)
​
dueDate
string
Data de vencimento do boleto (formato ISO 8601)
​
type
integer
Tipo de boleto:
  • 0: Compensação bancária (boletos comuns)
  • 1: Concessionária/Tributo (água, luz, telefone, impostos)
​
allowChangeValue
boolean
Indica se o boleto permite pagamento parcial
​
interestValueCalculated
number
Valor dos juros calculados (se boleto vencido)
​
fineValueCalculated
number
Valor da multa calculada (se boleto vencido)
​
minValue
number
Valor mínimo permitido para pagamento (se pagamento parcial permitido)
​
maxValue
number
Valor máximo permitido para pagamento
​
settleDate
string
Data prevista de liquidação do pagamento
​
endHour
string
Horário limite para pagamento no dia (formato HH:MM)
​
initeHour
string
Horário inicial para pagamento no dia (formato HH:MM)
​
nextSettle
string
Indica se liquidação será no mesmo dia ou próximo dia útil (“S” ou “N”)

​
Exemplo de Requisição

cURL
curl -X POST https://api-gateway.firebanking.com.br/bank-slip/v1/payment/withdraw/verify-data \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "barcode": "34191091000000150001234567880000012345678901"
  }'
JavaScript
const response = await fetch('https://api-gateway.firebanking.com.br/bank-slip/v1/payment/withdraw/verify-data', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY'
  },
  body: JSON.stringify({
    barcode: '34191091000000150001234567880000012345678901'
  })
});

const data = await response.json();
Python
import requests

response = requests.post(
    'https://api-gateway.firebanking.com.br/bank-slip/v1/payment/withdraw/verify-data',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': 'YOUR_API_KEY'
    },
    json={
        'barcode': '34191091000000150001234567880000012345678901'
    }
)

data = response.json()

​
Exemplo de Resposta

{
  "assignor": "EMPRESA DE LUZ LTDA",
  "documentRecipient": "12345678901234",
  "recipient": "Empresa Fornecedora",
  "originalValue": 150.00,
  "totalUpdated": 152.50,
  "dueDate": "2024-01-15T03:00:00.000Z",
  "type": 1,
  "digitable": "34191234567880000012345678901091000000150001",
  "minValue": 50.00,
  "maxValue": 152.50,
  "allowChangeValue": false,
  "interestValueCalculated": 1.50,
  "fineValueCalculated": 1.00,
  "discountValue": 0,
  "settleDate": "2024-01-16T03:00:00.000Z",
  "endHour": "22:00",
  "initeHour": "06:00",
  "nextSettle": "N"
}

​
Códigos de Resposta

​
200
success
Dados do boleto consultados com sucesso
​
400
error
Código de barras inválido ou boleto não encontradoPossíveis causas:
  • Código de barras com formato inválido
  • Boleto não existe ou já foi pago
  • Boleto vencido há mais de 60 dias
​
401
error
API key inválida ou ausente
​
500
error
Erro interno do servidor ou falha na comunicação com o provedor

​
Erros Comuns

{
  "statusCode": 400,
  "message": "Bank slip has already been paid",
  "error": "Bad Request"
}
O boleto consultado já foi quitado anteriormente.
{
  "statusCode": 400,
  "message": "Invalid barcode format",
  "error": "Bad Request"
}
O código de barras fornecido não possui o formato correto (44 ou 47 dígitos numéricos).
{
  "statusCode": 400,
  "message": "Bank slip is expired and cannot be paid",
  "error": "Bad Request"
}
O boleto está vencido há mais de 60 dias e não pode ser pago.

​
Próximos Passos

Após verificar os dados do boleto, você pode:
  1. Efetuar o pagamento: Use o endpoint Pagar Boleto
  2. Consultar status: Verifique o status do pagamento com Consultar Status
  3. Listar pagamentos: Veja o histórico com Listar Pagamentos
Importante: Este endpoint apenas consulta informações. O saldo da conta NÃO será debitado. Para efetuar o pagamento, use o endpoint de criação de pagamento.