Criar endpoint de webhook
curl --request POST \
--url https://api.alphagateway.com.br/v1/webhook-endpoints \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "https://meusistema.com.br/webhooks/alpha",
"description": "Pagamentos e saques",
"events": [
"PIX_IN_PAYED",
"PIX_OUT_PAID"
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://meusistema.com.br/webhooks/alpha',
description: 'Pagamentos e saques',
events: ['PIX_IN_PAYED', 'PIX_OUT_PAID']
})
};
fetch('https://api.alphagateway.com.br/v1/webhook-endpoints', 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"
payload = {
"url": "https://meusistema.com.br/webhooks/alpha",
"description": "Pagamentos e saques",
"events": ["PIX_IN_PAYED", "PIX_OUT_PAID"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://meusistema.com.br/webhooks/alpha',
'description' => 'Pagamentos e saques',
'events' => [
'PIX_IN_PAYED',
'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 criado 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_OUT_PAID"
],
"createdAt": "2026-10-22T13:00:00.000Z",
"updatedAt": "2026-10-22T13:00:00.000Z",
"secret": "whsec_4f1c2b7e9a0d4c6b8e2f1a3c5d7e9b0a2c4e6f8a1b3d5c7e9f0a2b4c6d8e0f1a"
}
}{
"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": [
"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
Criar endpoint de webhook
Cadastra uma URL para receber os eventos escolhidos. A URL precisa ser pública (http ou https) e única na organização. A credencial de assinatura HMAC é retornada só nesta resposta.
POST
/
v1
/
webhook-endpoints
Criar endpoint de webhook
curl --request POST \
--url https://api.alphagateway.com.br/v1/webhook-endpoints \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "https://meusistema.com.br/webhooks/alpha",
"description": "Pagamentos e saques",
"events": [
"PIX_IN_PAYED",
"PIX_OUT_PAID"
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://meusistema.com.br/webhooks/alpha',
description: 'Pagamentos e saques',
events: ['PIX_IN_PAYED', 'PIX_OUT_PAID']
})
};
fetch('https://api.alphagateway.com.br/v1/webhook-endpoints', 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"
payload = {
"url": "https://meusistema.com.br/webhooks/alpha",
"description": "Pagamentos e saques",
"events": ["PIX_IN_PAYED", "PIX_OUT_PAID"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://meusistema.com.br/webhooks/alpha',
'description' => 'Pagamentos e saques',
'events' => [
'PIX_IN_PAYED',
'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 criado 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_OUT_PAID"
],
"createdAt": "2026-10-22T13:00:00.000Z",
"updatedAt": "2026-10-22T13:00:00.000Z",
"secret": "whsec_4f1c2b7e9a0d4c6b8e2f1a3c5d7e9b0a2c4e6f8a1b3d5c7e9f0a2b4c6d8e0f1a"
}
}{
"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": [
"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
Corpo
application/json
URL pública que receberá as notificações (POST com corpo JSON).
Maximum string length:
2048Eventos que o endpoint vai receber (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 Descrição livre do endpoint (opcional).
Maximum string length:
255