Movimentação de conta

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 sempre que dinheiro entra ou sai de uma das suas contas HG.Cash.

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>, em que o valor é HMAC-SHA256 do corpo JSON bruto usando o seu segredo. Verifique isso para garantir que a requisição é autêntica.

Observações:

Valores numéricos (como amount, CBU/CUIT) são enviados como strings para preservar precisão e formatação.
date é uma data-hora local e deve ser interpretada usando timezone.

string<uuid>

obrigatório

ID interno da movimentação

externalID

string

obrigatório

Identificador externo do provedor ou banco para a movimentação

amount

string

obrigatório

Valor da movimentação como string decimal

currency

string

obrigatório

Código de moeda ISO 4217

Pattern: ^[A-Z]{3}$

direction

enum<string>

obrigatório

Direção da movimentação em relação à sua conta

Opções disponíveis:

Inbound,

Outbound

status

string

obrigatório

Status atual da movimentação

type

string

obrigatório

Tipo de movimentação (por exemplo inbound ou outbound)

accountId

string<uuid>

obrigatório

ID da conta HG.Cash associada à movimentação

date

string<date-time>

obrigatório

Data-hora local da movimentação no fuso horário informado

timezone

string

obrigatório

Identificador de fuso horário IANA usado para interpretar date

topic

enum<string>

obrigatório

Tópico do webhook para roteamento

Opções disponíveis:

TRANSACTION

Exemplo:

"TRANSACTION"

eventType

enum<string>

obrigatório

Tipo de evento dentro do tópico

Opções disponíveis:

created,

status_change

Exemplo:

"created"

fromName

string

Nome do remetente

toName

string

Nome do destinatário

fromCBU

string

CBU do remetente (22 dígitos). Enviado como string.

Pattern: ^\d{22}$

toCBU

string

CBU do destinatário (22 dígitos). Enviado como string.

Pattern: ^\d{22}$

fromCUIT

string

CUIT/CUIL do remetente (11 dígitos). Enviado como string.

Pattern: ^\d{11}$

toCUIT

string

CUIT/CUIL do destinatário (11 dígitos). Enviado como string.

Pattern: ^\d{11}$

coelsaCode

string

Código de transação Coelsa