Lista webhooks cadastrados para a chave Pix. Cada item inclui id (necessário para PATCH/DELETE). Filtro opcional eventos (array): pagamento, pagamento-falha, recebimento, devolucao. Sem filtro, retorna todos os eventos.
Define o formato esperado na resposta. Deve ser application/json
stringToken de acesso no formato Bearer {access_token} para autenticação
stringChave Pix para filtrar os webhooks
stringTipos de eventos para filtrar. Omita para listar todos.
string[]| Nome | Tipo | Descrição |
|---|---|---|
webhooks | Array | Lista dos webhooks registrados para a chave especificada. |
webhooks.chave | String | Chave Pix vinculada ao webhook. |
webhooks.webhookUrl | String | URL configurada para receber notificações do webhook. |
webhooks.evento | String | Evento monitorado: recebimento ou pagamento. |
webhooks.criacao | String | Data e hora de criação do webhook (formato ISO 8601). |
correlationId | String | Identificador único da requisição para rastreabilidade. |
currentPage | Inteiro | Página atual na paginação dos resultados. |
lastPage | Inteiro | Número da última página disponível. |
perPage | Inteiro | Número de itens por página. |
from | Inteiro | Primeiro item exibido na página atual. |
to | Inteiro | Último item exibido na página atual. |
total | Inteiro | Total de itens disponíveis. |
path | String | URL base para consulta do recurso. |
firstPageUrl | String | URL para a primeira página de resultados. |
prevPageUrl | String | URL para a página anterior (ou null se não houver). |
nextPageUrl | String | URL para a próxima página (ou null se não houver). |
| Código | Significado | Descrição |
|---|---|---|
| 200 | OK | Consulta realizada com sucesso. |
| 400 | Bad Request | Parâmetros inválidos ou faltando na requisição. |
| 401 | Unauthorized | Token de autenticação inválido ou expirado. |
| 404 | Not Found | Nenhum webhook encontrado para a chave especificada. |
| 500 | Internal Server Error | Erro interno no servidor. Contate o suporte se o problema persistir. |
curl --location 'https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{ access_token }}'
const axios = require("axios");
const config = {
method: "get",
url: "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}",
headers: {
Accept: "application/json",
Authorization: "Bearer {{ access_token }}",
},
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
import requests
url = "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}"
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {{ access_token }}'
}
response = requests.get(url, headers=headers)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/{{ chave }}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Bearer {{ access_token }}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
{
"webhooks": [
{
"chave": "e3fe4462-4c8e-42c1-8360-b41b404ae557",
"webhookUrl": "https://integrador.exemplo.com.br/pix/recebimento",
"evento": "recebimento",
"criacao": "2024-12-26T15:17:24.000000Z"
}
],
"correlationId": "3b6b1583-144d-46c7-b333-44dceb1be344",
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"from": 1,
"to": 1,
"total": 1,
"path": "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/e3fe4462-4c8e-42c1-8360-b41b404ae557",
"firstPageUrl": "https://api-h.nuvende.com.br/api/v2/cobranca/webhooks/e3fe4462-4c8e-42c1-8360-b41b404ae557?page=1",
"prevPageUrl": null,
"nextPageUrl": null
}