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 cuando cambia el estado de una solicitud de transacción.

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.
  • Configure su URL de webhook en la página de configuración de la cuenta.
topic
enum<string>
requerido

Tema del webhook para enrutamiento (siempre TRANSACTION_REQUEST para webhooks de solicitudes de transacción)

Opciones disponibles:
TRANSACTION_REQUEST
Ejemplo:

"TRANSACTION_REQUEST"

eventType
enum<string>
requerido

Tipo de evento dentro del tema

Opciones disponibles:
status_change,
transaction_associated
Ejemplo:

"status_change"

id
string<uuid>
requerido

ID interno de la transacción

Ejemplo:

"789e0123-e89b-12d3-a456-426614174999"

externalID
string
requerido

ID externo proporcionado al crear la transacción

Ejemplo:

"TXN-2024-001234"

amount
string
requerido

Monto de la transacción como cadena decimal

Ejemplo:

"15000.50"

currency
string
requerido

Código de moneda ISO 4217

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

"ARS"

direction
enum<string>
requerido

Dirección de la transacción

Opciones disponibles:
Inbound,
Outbound
Ejemplo:

"Inbound"

status
enum<string>
requerido

Estado actual de la solicitud de transacción

Opciones disponibles:
PENDING,
AWAITING_REVIEW,
PROCESSING,
DONE,
ERROR,
CANCELLED
Ejemplo:

"PENDING"

type
string
requerido

Tipo de notificación. Siempre "request" para solicitudes de transacción

Ejemplo:

"request"

accountId
string<uuid>
requerido

ID de cuenta HG.Cash asociado a la transacción

Ejemplo:

"550e8400-e29b-41d4-a716-446655440123"

date
string<date-time>
requerido

Fecha y hora local de la transacción en la zona horaria proporcionada

Ejemplo:

"2024-06-19T10:30:00"

timezone
string
requerido

Identificador de zona horaria IANA usado para interpretar date

Ejemplo:

"America/Argentina/Buenos_Aires"

error
string

Mensaje de error opcional cuando el estado es ERROR

Ejemplo:

"Insufficient funds on destination account"

errorCode
enum<string>

Código de error legible por máquina cuando el estado es ERROR

Opciones disponibles:
INSUFFICIENT_BALANCE,
DESTINATION_ERROR
Ejemplo:

"INSUFFICIENT_BALANCE"

fromName
string

Nombre del remitente

Ejemplo:

"Juan Pérez"

toName
string

Nombre del destinatario

Ejemplo:

"María García"

fromCBU
string

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

Pattern: ^\d{22}$
Ejemplo:

"1700015400000000000010"

toCBU
string

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

Pattern: ^\d{22}$
Ejemplo:

"1100015400000000000021"

toCVU
string

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

Pattern: ^\d{22}$
Ejemplo:

"0000003100012345678901"

fromCUIT
string

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

Pattern: ^\d{11}$
Ejemplo:

"20123456789"

toCUIT
string

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

Pattern: ^\d{11}$
Ejemplo:

"27987654321"

concept
string

Concepto o descripción de la transacción

Ejemplo:

"Payment for services"

coelsaCode
string

Código de transacción Coelsa

Ejemplo:

"COELSA123456"

data
object

Metadatos JSON opcionales de la solicitud de transacción

isSecurityFlagged
boolean

Cuando es true, la solicitud fue retenida para revisión de seguridad antes del procesamiento

securityFlagReason
string

Motivo legible por máquina opcional cuando se marca para revisión de seguridad

transactionId
string<uuid>

ID de transacción del libro mayor vinculado (incluido en webhooks transaction_associated)