v1

latestOpenAPI 3.0.02026-07-14664396.8 KB

SETUP

Receive Webhook Event

Receives and processes event notifications from third-party services.

post/webhooks

Headers

api-keystring

Example:alfredpay.T+QdhCoMofy8.gGKO5KdB7M+B/9jLFef

API Key for service authentication (alternative to JWT Bearer token). Optional.

api-secretstring

Example:PwF+cDGZd37eHYZ.CVvF1/zbHCBosSo1

API Secret for service authentication (alternative to JWT Bearer token). Optional.

Request body

referenceIdstring uuid required

Unique reference identifier (UUID) for the transaction or entity

eventType'KYC' | 'ONRAMP' | 'OFFRAMP' | 'KYB' required

Type of event being processed

statusstring required

Current status of the event or transaction

metadataobject

Additional metadata or provider-specific information

Example request

{
  "referenceId": "123e4567-e89b-12d3-a456-426614174000",
  "eventType": "ONRAMP",
  "status": "FIAT_DEPOSIT_RECEIVED",
  "metadata": {
    "provider": "circle",
    "transactionId": "tx_abc123",
    "timestamp": "2025-01-01T00:00:00Z"
  }
}