Solicitação de transação associada à transação

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 solicitação de transação muda.

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.
Configure a URL do webhook na página de configurações da conta.

topic

enum<string>

obrigatório

Tópico do webhook para roteamento (sempre TRANSACTION_REQUEST para webhooks de solicitação de transação)

Opções disponíveis:

TRANSACTION_REQUEST

Exemplo:

"TRANSACTION_REQUEST"

eventType

enum<string>

obrigatório

Tipo de evento dentro do tópico

Opções disponíveis:

status_change,

transaction_associated

Exemplo:

"status_change"

string<uuid>

obrigatório

ID interno da transação

Exemplo:

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

externalID

string

obrigatório

ID externo informado ao criar a transação

Exemplo:

"TXN-2024-001234"

amount

string

obrigatório

Valor da transação como string decimal

Exemplo:

"15000.50"

currency

string

obrigatório

Código de moeda ISO 4217

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

Exemplo:

"ARS"

direction

enum<string>

obrigatório

Direção da transação

Opções disponíveis:

Inbound,

Outbound

Exemplo:

"Inbound"

status

enum<string>

obrigatório

Status atual da solicitação de transação

Opções disponíveis:

PENDING,

AWAITING_REVIEW,

PROCESSING,

DONE,

ERROR,

CANCELLED

Exemplo:

"PENDING"

type

string

obrigatório

Tipo de notificação. Sempre "request" para solicitações de transação

Exemplo:

"request"

accountId

string<uuid>

obrigatório

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

Exemplo:

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

date

string<date-time>

obrigatório

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

Exemplo:

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

timezone

string

obrigatório

Identificador de fuso horário IANA usado para interpretar date

Exemplo:

"America/Argentina/Buenos_Aires"

transactionId

string<uuid>

obrigatório

ID da transação no ledger vinculada (incluído em webhooks transaction_associated)

error

string

Mensagem de erro opcional quando o status é ERROR

Exemplo:

"Insufficient funds on destination account"

errorCode

enum<string>

Código de erro legível por máquina quando o status é ERROR

Opções disponíveis:

INSUFFICIENT_BALANCE,

DESTINATION_ERROR

Exemplo:

"INSUFFICIENT_BALANCE"

fromName

string

Nome do remetente

Exemplo:

"Juan Pérez"

toName

string

Nome do destinatário

Exemplo:

"María García"

fromCBU

string

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

Pattern: ^\d{22}$

Exemplo:

"1700015400000000000010"

toCBU

string

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

Pattern: ^\d{22}$

Exemplo:

"1100015400000000000021"

toCVU

string

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

Pattern: ^\d{22}$

Exemplo:

"0000003100012345678901"

fromCUIT

string

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

Pattern: ^\d{11}$

Exemplo:

"20123456789"

toCUIT

string

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

Pattern: ^\d{11}$

Exemplo:

"27987654321"

concept

string

Conceito ou descrição da transação

Exemplo:

"Payment for services"

coelsaCode

string

Código de transação Coelsa

Exemplo:

"COELSA123456"

data

object

Metadados JSON opcionais da solicitação de transação

isSecurityFlagged

boolean

Quando true, a solicitação foi retida para revisão de segurança antes do processamento

securityFlagReason

string

Motivo opcional legível por máquina quando sinalizada para revisão de segurança