GET/api/v2/baas/bankslip-payments/review/{reference}

Revisar

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
referenceObrigatório
path

reference retornado no GET barcode (formato barcode_data_documento).

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

CampoRegra
{reference}Valor retornado na consulta por código de barras

Resposta de sucesso

200 OK: resumo do pagamento em payment e janela horária (canPayToday, minPaymentTime, maxPaymentTime, nextUtilDay).

Erros comuns

SituaçãoHTTP
reference inválida ou sessão expirada422
Boleto não encontrado422

Códigos

CódigoDescrição
200Revisão disponível
401Token ou HMAC inválido
403Scope ausente
422Validação ou regra de negócio

Notas

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/review/23793381286008301352856000063330894325100000015200_2026-07-15_43587980000107' \
  --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");

const reference = "23793381286008301352856000063330894325100000015200_2026-07-15_43587980000107";

axios({
  method: "get",
  url: `https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/review/${reference}`,
  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

reference = "23793381286008301352856000063330894325100000015200_2026-07-15_43587980000107"
url = f"https://api-h.nuvende.com.br/api/v2/baas/bankslip-payments/review/{reference}"
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/review/23793381286008301352856000063330894325100000015200_2026-07-15_43587980000107',
  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;
{
  "payment": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "reference": "23793381286008301352856000063330894325100000015200_2026-07-15_43587980000107",
    "status": "consulted",
    "total": 15200,
    "beneficiary_name": "Loja Exemplo LTDA",
    "beneficiary_document": "43587980000107",
    "scheduled_for": null
  },
  "canPayToday": true,
  "nextUtilDay": "16/07/2026",
  "minPaymentTime": "07:00",
  "maxPaymentTime": "16:00"
}
{
  "message": "Boleto não encontrado ou inválido."
}