Receive Webhook Event

Receives and processes event notifications from third-party services. Events are processed asynchronously and may trigger updates to KYC/KYB/onramp/offramp flows or transaction statuses.

Behavior and validations:

  • Required fields: referenceId (string), eventType (enum), status (string).
  • eventType must be one of: KYC, ONRAMP, OFFRAMP, KYB.
  • Optional metadata can carry provider-specific details.
  • The endpoint responds quickly and delegates processing to background workers; callers should expect asynchronous updates.

Example usage: POST /third-party-service/penny/webhooks Body: { "referenceId": "txn_123", "eventType": "ONRAMP", "status": "FIAT_DEPOSIT_RECEIVED", "metadata": {"provider": "x"} }

Supported Event Types:

  • KYC, ONRAMP, OFFRAMP, KYB.

Notes:

  • Requests must include api-key and api-secret headers for authentication.
  • Processing is asynchronous; for immediate status checks use the appropriate transaction or entity endpoints.
Language
URL
Click Try It! to start a request and see the response here!