Skip to main content
POST
Cadastrar webhook do lojista

Authorizations

Authorization
string
header
required

Token JWT obtido em /auth/login, enviado no cabeçalho Authorization no formato Bearer <token>.

Body

application/json
url
string
required
Example:

"https://meusite.com/webhooks/v4pay"

name
string

Nome para identificar na lista

events
enum<string>[]

Eventos a receber. Omitido ou vazio = todos.

Available options:
charge.created,
charge.paid,
subscription.charged,
withdrawal.completed,
withdrawal.rejected
secret
string

Opcional — segredo de assinatura gerado do SEU lado (ex.: no navegador, para o lojista ver antes de salvar). Só no formato exato whsec_ + 32 hexadecimais minúsculos; fora disso, ou com os 32 caracteres iguais, 400. IMPORTANTE: a API confere o FORMATO, não a aleatoriedade — este valor assina o X-V4Pay-Signature dos seus eventos, então gere-o com um gerador criptográfico (crypto.getRandomValues/randomBytes), nunca um valor fixo ou derivado de senha: secret previsível é evento forjável. Omitido, a API gera (com entropia garantida).

Pattern: ^whsec_[0-9a-f]{32}$

Response

Endpoint cadastrado (o secret vem na resposta).

data
object

Endpoint do lojista que recebe eventos da V4 Pay.