Acessar minha contaAbrir uma conta
GET/api/v2/baas/bankslip-payments/barcode/{barcode}

Consultar por código de barras

Produto BaaS (titular). Requer Bearer JWT do login da conta e assinatura HMAC obrigatória. Scope: baas.bankslip-payments.read. Guia: documentação técnica.

Parâmetros

AcceptObrigatório
header
Tipo:string
X-SignatureObrigatório
header

Assinatura HMAC-SHA256 da requisição (hex).

Tipo:string
X-TimestampObrigatório
header

Timestamp Unix (segundos, UTC) usado na assinatura.

Tipo:string
X-NonceObrigatório
header

Nonce único por requisição (anti-replay).

Tipo:string
barcodeObrigatório
path

Linha digitavel ou codigo de barras (44 a 48 digitos, somente numeros na URL).

Tipo:string
scheduled_dateOpcional
query

Data desejada para pagamento agendado (Y-m-d).

Tipo:string
digitableOpcional
query

Linha digitavel (44 a 48 digitos). Alternativa ao codigo de barras no path.

Tipo:string

Autenticação e headers

Requer Bearer token do login da conta e assinatura HMAC obrigatórios. Scope: baas.bankslip-payments.read.

Envie X-Signature, X-Timestamp e X-Nonce em todo pedido assinado. Veja Autenticação do parceiro.

HeaderObrigatórioDescrição
AuthorizationSimBearer {{access_token}}
AcceptSimapplication/json
X-SignatureSimAssinatura HMAC
X-TimestampSimTimestamp da assinatura
X-NonceSimNonce único por requisição

Path e query

CampoObrigatórioRegra
{barcode}Sim44 a 48 dígitos (linha digitável ou código de barras), somente números na URL
scheduled_dateNãoQuery Y-m-d para simular pagamento agendado

Em GET assinado com HMAC, o corpo na mensagem de assinatura costuma ser o literal [].

Resposta de sucesso

202 Accepted: boleto decodificado. Guarde reference para revisão, atualização e confirmação.

Valores amount, discount, penalty, interest e total vêm em centavos.

Erros comuns

SituaçãoHTTPEfeito
Boleto já pago422Mensagem de negócio no corpo
Fora do prazo422Pagamento não permitido
Saldo insuficiente (valor fixo)422Conta sem saldo para o total
Código inválido422Boleto não registrado

Códigos

CódigoDescrição
202Boleto consultado
401Token ou HMAC inválido
403Scope ausente
422Validação ou regra de negócio
500Erro interno

Notas

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/barcode/23793381286008301352856000063330894325100000015200' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}'

const axios = require("axios");

axios({
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/barcode/23793381286008301352856000063330894325100000015200",
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
  },
})
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error.response?.data || error.message));

import requests

url = "https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/barcode/23793381286008301352856000063330894325100000015200"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
}
response = requests.get(url, headers=headers)
print(response.text)

<?php
$curl = curl_init();
$opts = [
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/barcode/23793381286008301352856000063330894325100000015200',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Accept: application/json',
    'Authorization: Bearer {{access_token}}',
    'X-Timestamp: {{timestamp}}',
    'X-Nonce: {{nonce}}',
    'X-Signature: {{signature}}',
  ],
];
curl_setopt_array($curl, $opts);
$response = curl_exec($curl);
curl_close($curl);
echo $response;

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "reference": "23793381286008301352856000063330894325100000015200_2026-07-15_43587980000107",
  "method": "boleto",
  "status": "consulted",
  "amount": 15000,
  "discount": 0,
  "penalty": 150,
  "interest": 50,
  "total": 15200,
  "due_date": "2026-07-10T00:00:00Z",
  "beneficiary_name": "Loja Exemplo LTDA",
  "beneficiary_document": "43587980000107",
  "digitable_line": "23793.38128 60083.013528 56000.063330 8 94325100000015200",
  "barcode": "23793381286008301352856000063330894325100000015200",
  "canPayToday": true,
  "nextUtilDay": "16/07/2026",
  "minPaymentTime": "07:00",
  "maxPaymentTime": "16:00"
}

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/barcode/23793381286008301352856000063330894325100000015200?digitable=23793381286008301352856000063330894325100000015200' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}'

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/barcode/23793381286008301352856000063330894325100000015200?scheduled_date=2026-07-16' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}'

{
  "message": "Este boleto já foi pago."
}

{
  "message": "O boleto informado está fora do prazo permitido para pagamento."
}

{
  "message": "Este boleto não possui valor disponível para pagamento."
}

{
  "message": "Saldo insuficiente para o pagamento desse boleto."
}

{
  "message": "Boleto não registrado. Verifique o código informado."
}

{
  "message": "Este boleto não está habilitado para pagamento neste canal."
}