Skip to main content
WEBHOOK

Autorizações

X-HG-Webhook-Signature
string
header
obrigatório

Assinatura HMAC-SHA256 do corpo JSON bruto. Formato: sha256=<hex>. Quando você configura um segredo de assinatura de webhook nas configurações da conta, a HG.Cash inclui este cabeçalho em cada POST de webhook. Verifique a assinatura no seu endpoint para garantir que a requisição é autêntica.

Corpo

application/json

Payload enviado quando uma sessão de checkout hospedado muda de estado. Em checkout.completed, quando há uma transação de ledger vinculada, inclui um objeto transaction aninhado com os mesmos campos dos webhooks de movimentação de conta, exceto topic e eventType.

topic
enum<string>
obrigatório

Tópico do webhook para roteamento

Opções disponíveis:
CHECKOUT
Exemplo:

"CHECKOUT"

eventType
enum<string>
obrigatório

Tipo de evento (corresponde a event)

Opções disponíveis:
checkout.completed,
checkout.awaiting_manual_review,
checkout.rejected
Exemplo:

"checkout.completed"

id
string<uuid>
obrigatório

ID da sessão de checkout

status
string
obrigatório

Status do checkout após o evento

event
enum<string>
obrigatório
Opções disponíveis:
checkout.completed,
checkout.awaiting_manual_review,
checkout.rejected
amount
string
obrigatório

Valor decimal como string

currency
string
obrigatório

Código de moeda ISO 4217

country
enum<string>
obrigatório
Opções disponíveis:
AR,
BR,
CL,
BO
transactionId
string<uuid> | null

Transação de entrada vinculada, quando disponível

transaction
object

Presente em checkout.completed quando há uma transação de ledger vinculada. Omitido quando não há transação vinculada.

metadata
object

Metadados opacos da criação do checkout

completedAt
string<date-time> | null