Reenviar webhook de transação

POST /api/resend-webhook/{transactionIdentifier}

POST https://api.avista.global/api/resend-webhook/{transactionIdentifier}

Requer um Bearer token no header Authorization. Veja Gerar Token para obter um.

Reenvia o webhook de uma transação específica para a URL configurada ou para uma URL temporária (override).

O identificador da transação pode ser:

ID numérico da transação: O ID retornado pela Avista (campo transactionId nos webhooks)
Seu ID de referência: O identificador que você forneceu ao criar a transação (externalId)
End-to-End ID do PIX: O e2eId retornado nos webhooks (formato: E/D + 32 chars)

Autenticação

Requer token Bearer no header Authorization.

Path Parameters

Parâmetro	Tipo	Obrigatório	Descrição
`transactionIdentifier`	string	Sim	Identificador da transação: id numérico, externalId ou endToEndId

Request Body (opcional)

Campo	Tipo	Obrigatório	Descrição
`url`	string	Não	URL temporária para este reenvio específico. Se não fornecida, usa a URL configurada no webhook da conta. A URL não é persistida

{
  "url": "https://meu-servidor.com/webhooks/avista"
}

Comportamento de URL

Se url for fornecido no body, usa essa URL temporáriamente (não persiste)
Se url não for fornecido, usa a URL configurada no webhook da conta para o tipo da operação
Se nenhuma URL estiver disponível, retorna erro 400

Exemplos de Código

cURL

curl -X POST "https://api.avista.global/api/resend-webhook/PAG-2024-0001" \
  -H "Authorization: Bearer $AVISTA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://meu-servidor.com/webhooks/avista"
}'

const axios = require('axios');

const response = await axios.post('https://api.avista.global/api/resend-webhook/PAG-2024-0001',
  {
  "url": "https://meu-servidor.com/webhooks/avista"
},
  {
    headers: {
      'Authorization': `Bearer ${process.env.AVISTA_TOKEN}`,
      'Content-Type': 'application/json',
    },
  }
);
console.log(response.data);

import os, requests

response = requests.post(
    'https://api.avista.global/api/resend-webhook/PAG-2024-0001',
    headers={
        'Authorization': f'Bearer {os.environ["AVISTA_TOKEN"]}',
        'Content-Type': 'application/json',
    },
    json={
  "url": "https://meu-servidor.com/webhooks/avista"
},
)
print(response.json())

$ch = curl_init('https://api.avista.global/api/resend-webhook/PAG-2024-0001');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('AVISTA_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{
  "url": "https://meu-servidor.com/webhooks/avista"
}',
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

String body = """
    {
      "url": "https://meu-servidor.com/webhooks/avista"
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.avista.global/api/resend-webhook/PAG-2024-0001"))
    .header("Authorization", "Bearer " + System.getenv("AVISTA_TOKEN"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response (200)

Campo	Tipo	Descrição
`message`	string	Mensagem descritiva do resultado
`webhookLogId`	number	ID do log de webhook gerado para auditoria
`sentAt`	string	Data/hora do envio do webhook (ISO 8601)
`statusCode`	number	Código de status HTTP retornado pela URL de destino

{
  "message": "Webhook resent successfully",
  "webhookLogId": 12345,
  "sentAt": "2024-01-15T10:30:00.000Z",
  "statusCode": 200
}

Erros

Status	Descrição
400	Nenhuma URL de webhook disponível. Configure um webhook para o tipo de operação desta transação ou forneca uma URL temporária no campo `url`
401	Token inválido, expirado ou não fornecido
404	Transação não encontrada ou não pertence a conta autenticada
429	Rate limit excedido (max 60 req/min)

Reenviar webhook de transação

Nesta página