Saltar al contenido principal
WEBHOOK

Autorizaciones

X-HG-Webhook-Signature
string
header
requerido

Firma HMAC-SHA256 del cuerpo JSON sin procesar. Formato: sha256=<hex>. Cuando configura un secreto de firma de webhooks en la configuración de la cuenta, HG.Cash incluye este encabezado en cada POST de webhook. Verifique la firma en su endpoint para asegurar que la solicitud es auténtica.

Cuerpo

application/json

Carga enviada a su endpoint de webhook cada vez que entra o sale dinero de una de sus cuentas HG.Cash.

Encabezados: Cuando configura un secreto de firma de webhooks en la configuración de la cuenta, HG.Cash envía el encabezado X-HG-Webhook-Signature: sha256=<hex> donde el valor es HMAC-SHA256 del cuerpo JSON sin procesar usando su secreto. Verifíquelo para asegurar que la solicitud es auténtica.

Notas:

  • Los valores numéricos (como amount, CBU/CUIT) se envían como cadenas para preservar precisión y formato.
  • date es una fecha y hora local y debe interpretarse usando timezone.
topic
enum<string>
requerido

Tema del webhook para enrutamiento

Opciones disponibles:
TRANSACTION
Ejemplo:

"TRANSACTION"

eventType
enum<string>
requerido

Tipo de evento dentro del tema

Opciones disponibles:
created,
status_change
Ejemplo:

"created"

id
string<uuid>
requerido

ID interno del movimiento

externalID
string
requerido

Identificador externo del proveedor o banco para el movimiento

amount
string
requerido

Monto del movimiento como cadena decimal

currency
string
requerido

Código de moneda ISO 4217

Pattern: ^[A-Z]{3}$
direction
enum<string>
requerido

Dirección del movimiento respecto a su cuenta

Opciones disponibles:
Inbound,
Outbound
status
string
requerido

Estado actual del movimiento

type
string
requerido

Tipo de movimiento (por ejemplo inbound o outbound)

accountId
string<uuid>
requerido

ID de cuenta HG.Cash asociado al movimiento

date
string<date-time>
requerido

Fecha y hora local del movimiento en la zona horaria proporcionada

timezone
string
requerido

Identificador de zona horaria IANA usado para interpretar date

fromName
string

Nombre del remitente

toName
string

Nombre del destinatario

fromCBU
string

CBU del remitente (22 dígitos). Enviado como cadena.

Pattern: ^\d{22}$
toCBU
string

CBU del destinatario (22 dígitos). Enviado como cadena.

Pattern: ^\d{22}$
fromCUIT
string

CUIT/CUIL del remitente (11 dígitos). Enviado como cadena.

Pattern: ^\d{11}$
toCUIT
string

CUIT/CUIL del destinatario (11 dígitos). Enviado como cadena.

Pattern: ^\d{11}$
coelsaCode
string

Código de transacción Coelsa