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 ao seu endpoint de webhook quando o status de uma reclamação muda (atualização de um administrador ou autoconciliação por COELSA).

Cabeçalhos: Quando você configura um segredo de assinatura de webhook nas configurações da conta, a HG.Cash envia o cabeçalho X-HG-Webhook-Signature: sha256=<hex>, cujo valor é o HMAC-SHA256 do corpo JSON bruto usando seu segredo. Verifique-o para garantir que a solicitação é autêntica.

Notas:

  • Valores numéricos (como amount) são enviados como strings para preservar a precisão.
  • fileUrl não é incluído (as URLs assinadas expiram).
  • Webhooks não são enviados na criação da reclamação nem em atualizações que apenas adicionam um comentário.
  • Configure a URL do seu webhook nas configurações de usuário.
​
topic
enum<string>
obrigatório

Tópico do webhook para roteamento (sempre CLAIM para webhooks de reclamações)

Opções disponíveis:
CLAIM
Exemplo:

"CLAIM"

​
eventType
enum<string>
obrigatório

Tipo de evento dentro do tópico

Opções disponíveis:
status_change
Exemplo:

"status_change"

​
id
string<uuid>
obrigatório

ID da reclamação

​
status
enum<string>
obrigatório
Opções disponíveis:
OPEN,
UNDER_REVIEW,
RESOLVED,
REJECTED
​
operationNumber
string
obrigatório
​
coelsaCode
string
obrigatório
​
amount
string | null
obrigatório

Valor decimal com 2 casas decimais

​
currency
enum<string>
obrigatório
Opções disponíveis:
ARS,
USD,
USDT
​
extractedData
object
obrigatório
​
originalFilename
string | null
obrigatório
​
mimeType
string | null
obrigatório
​
createdAt
string<date-time>
obrigatório
​
updatedAt
string<date-time>
obrigatório
​
accountId
string<uuid> | null
​
transactionId
string<uuid> | null

ID da transação vinculada quando a conciliação encontrou um match

​
comment
string

Texto do último comentário quando a atualização de status incluiu um comentário (o prefixo de timestamp ISO é removido)