Skip to main content
WEBHOOK

Authorizations

X-HG-Webhook-Signature
string
header
required

HMAC-SHA256 signature of the raw JSON body. Format: sha256=<hex>. When you configure a webhook signing secret in account settings, HG.Cash includes this header on every webhook POST. Verify the signature in your endpoint to ensure the request is authentic.

Body

application/json

Payload sent when a hosted checkout session changes state

topic
enum<string>
required

Webhook topic for routing

Available options:
CHECKOUT
Example:

"CHECKOUT"

eventType
enum<string>
required

Event kind (matches event)

Available options:
checkout.completed,
checkout.awaiting_manual_review,
checkout.rejected
Example:

"checkout.completed"

id
string<uuid>
required

Checkout session ID

status
string
required

Checkout status after the event

event
enum<string>
required
Available options:
checkout.completed,
checkout.awaiting_manual_review,
checkout.rejected
amount
string
required

Decimal amount as string

currency
string
required

ISO 4217 currency code

country
enum<string>
required
Available options:
AR,
BR,
CL,
BO
transactionId
string<uuid> | null

Linked inbound transaction when available

metadata
object

Opaque metadata from checkout create

completedAt
string<date-time> | null