Atualizar endpoint de webhook
curl --request PUT \
--url https://api.alphagateway.com.br/v1/webhook-endpoints/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"events": [
"PIX_IN_PAYED",
"PIX_IN_REFUNDED",
"PIX_OUT_PAID"
]
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({events: ['PIX_IN_PAYED', 'PIX_IN_REFUNDED', 'PIX_OUT_PAID']})
};
fetch('https://api.alphagateway.com.br/v1/webhook-endpoints/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/webhook-endpoints/{id}"
payload = { "events": ["PIX_IN_PAYED", "PIX_IN_REFUNDED", "PIX_OUT_PAID"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/webhook-endpoints/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
'PIX_IN_PAYED',
'PIX_IN_REFUNDED',
'PIX_OUT_PAID'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Webhook endpoint atualizado com sucesso",
"response": {
"id": "01961234-abcd-7000-8000-0000000000e1",
"url": "https://meusistema.com.br/webhooks/alpha",
"description": "Pagamentos e saques",
"enabled": true,
"events": [
"PIX_IN_PAYED",
"PIX_IN_REFUNDED",
"PIX_OUT_PAID"
],
"createdAt": "2026-10-22T13:00:00.000Z",
"updatedAt": "2026-10-23T09:00:00.000Z",
"secret": null
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Transação não encontrada"
]
}{
"response": null,
"errors": [
"Já existe um link de pagamento com este idempotency"
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Webhooks
Atualizar endpoint de webhook
Altera a URL, a descrição, os eventos ou pausa/reativa um endpoint de webhook. Envie só os campos que vão mudar (ao menos um). A lista de eventos enviada substitui a anterior. A mudança vale para as próximas notificações; as já criadas seguem para a URL de quando foram geradas. Trocar a URL gera uma credencial de assinatura nova, retornada em secret só nesta resposta.
PUT
/
v1
/
webhook-endpoints
/
{id}
Atualizar endpoint de webhook
curl --request PUT \
--url https://api.alphagateway.com.br/v1/webhook-endpoints/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"events": [
"PIX_IN_PAYED",
"PIX_IN_REFUNDED",
"PIX_OUT_PAID"
]
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({events: ['PIX_IN_PAYED', 'PIX_IN_REFUNDED', 'PIX_OUT_PAID']})
};
fetch('https://api.alphagateway.com.br/v1/webhook-endpoints/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/webhook-endpoints/{id}"
payload = { "events": ["PIX_IN_PAYED", "PIX_IN_REFUNDED", "PIX_OUT_PAID"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/webhook-endpoints/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
'PIX_IN_PAYED',
'PIX_IN_REFUNDED',
'PIX_OUT_PAID'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Webhook endpoint atualizado com sucesso",
"response": {
"id": "01961234-abcd-7000-8000-0000000000e1",
"url": "https://meusistema.com.br/webhooks/alpha",
"description": "Pagamentos e saques",
"enabled": true,
"events": [
"PIX_IN_PAYED",
"PIX_IN_REFUNDED",
"PIX_OUT_PAID"
],
"createdAt": "2026-10-22T13:00:00.000Z",
"updatedAt": "2026-10-23T09:00:00.000Z",
"secret": null
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Transação não encontrada"
]
}{
"response": null,
"errors": [
"Já existe um link de pagamento com este idempotency"
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Autorizações
API Key da organização
Parâmetros de caminho
ID do endpoint de webhook.
Minimum string length:
1Corpo
application/json
Nova URL pública do endpoint (opcional).
Maximum string length:
2048Nova descrição; null remove a descrição (opcional).
Maximum string length:
255Nova lista de eventos, que substitui a atual (opcional, ao menos um).
Minimum array length:
1Evento assinado (valor de value em GET /v1/webhook-event-types, ex.: PIX_IN_PAYED).
Opções disponíveis:
PIX_IN_PAYED, PIX_IN_REFUNDED, PIX_OUT_ANALYSIS, PIX_OUT_PAID, PIX_OUT_REJECTED, PIX_OUT_ERROR, PIX_OUT_REFUNDED, CHECKOUT_PAID, CHECKOUT_CANCELED, CHECKOUT_REJECTED, CHECKOUT_REFUNDED, INVOICE_INSTALLMENT_PAID, INVOICE_INSTALLMENT_CHARGE_FAILED, INVOICE_INSTALLMENT_OVERDUE, INVOICE_FULLY_PAID, INFRACTION_OPENED, INFRACTION_RESOLVED, BOLETO_CREATED, BOLETO_PAID, BOLETO_CANCELED, BOLETO_REFUNDED false pausa o endpoint; true volta a enviar as notificações (opcional).