Skip to main content
POST
Criar endpoint de webhook
Cadastra uma URL HTTPS para receber eventos da Liquerapay e gera a secret — a chave de assinatura usada para validar as requisições.

Obrigatório

url (HTTPS válido) e events (de 1 a 8 eventos que você quer receber — ver a lista completa).
Exemplo:
O secret retornado é mostrado apenas uma vez. Salve imediatamente em variável de ambiente / cofre. Sem ele você não consegue validar a assinatura (Liquera-Signature) dos eventos recebidos.

Recomendações

Endpoints http:// ou com certificado autoassinado/expirado serão rejeitados.
O endpoint recebe apenas os eventos listados em events — não é mais “recebe tudo por padrão”. Cadastre um novo endpoint (ou peça ajuste) se precisar de um evento novo depois.
Faça apenas o mínimo no handler (validar assinatura, registrar evento) e processe o resto em fila assíncrona. Endpoints lentos sofrem retry e, em excesso, são desativados automaticamente.
O mesmo evento pode chegar múltiplas vezes. Use o id do topo do payload (evt_...) como chave única.

Authorizations

Authorization
string
header
required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Body

application/json
url
string<uri>
required

URL HTTPS pública que receberá os eventos via POST.

Maximum string length: 2048
Example:

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

events
enum<string>[]
required

Eventos aos quais este endpoint será inscrito (de 1 a 8).

Required array length: 1 - 8 elements
  • CHARGE_PAID: cobrança PIX (Checkout Transparente) foi paga
  • CHARGE_EXPIRED: reservado — nenhum job dispara este evento hoje
  • REFUND_COMPLETED: devolução confirmada pelo PSP
  • REFUND_FAILED: devolução falhou
  • WITHDRAWAL_COMPLETED: saque concluído
  • WITHDRAWAL_FAILED: saque falhou ou foi devolvido
  • CHECKOUT_PAID: cobrança de Checkout Hospedado / link de pagamento foi paga
  • CHECKOUT_REFUNDED: cobrança de Checkout Hospedado / link de pagamento foi devolvida
Available options:
CHARGE_PAID,
CHARGE_EXPIRED,
REFUND_COMPLETED,
REFUND_FAILED,
WITHDRAWAL_COMPLETED,
WITHDRAWAL_FAILED,
CHECKOUT_PAID,
CHECKOUT_REFUNDED
Example:

Response

Endpoint criado — guarde o secret.

data
object
required
error
null
required
Example:

null

success
enum<boolean>
required
Available options:
true
Example:

true