Cresium
  1. Webhooks
Cresium
  • Cresium - V3 Partners
    • API
      • Auth Information for V3 API Partners
      • V3 - Health
        • Health check
      • V3 - Transaction
        • Get Transaction data
        • Search transactions
        • Make a transfer
        • Confirm a transaction
        • Reverse a deposit transaction
      • V3 - BankAddress
        • Get Address
      • V3 - CompanyFeature
        • Get Company Features
        • Update Feature Enabled State
      • V3 - Rate
        • Get TNA rate
      • V3 - DepositAddress
        • Update Deposit Address
        • Create Deposit Address
      • V3 - Partner
        • Search partner transactions
      • V3 - Auth
        • Generate change password ID for partner user
      • V3 - CompanyTax
        • Upsert Company Tax
      • V3 - Balance
        • Get all wallets for Company
    • Webhooks
      • Auth Information for Webhooks
      • Configuring Webhooks
      • Transactions Events - DEPOSIT
    • Schemas
      • Transaction
  1. Webhooks

Configuring Webhooks

Configuring Partner Webhooks#

To receive webhook events from our system, Partners must configure webhook endpoints.

Steps to Configure Webhooks#

1.
Contact your account manager
Currently, webhook configuration must be coordinated through your Partner account representative. They will register your webhook endpoints in our system.
2.
Provide a URL for each webhook type
The URL must accept HTTP POST requests.
The system will send events to this URL in real-time.
Each webhook type requires a separate URL.
3.
Supported webhook types
DEPOSIT: Triggered when a deposit occurs.
(Future webhook types will be communicated as they become available.)
4.
Security
All webhook requests include the headers x-api-key, x-company-id, x-timestamp, and x-signature.
Partners must verify the HMAC signature on every incoming webhook.
Only URLs under the Partner’s control should be registered.
5.
Retries
If your endpoint does not respond with a successful 2xx HTTP status code, the system will retry up to 5 times.
The retry count is included in the retry field of the webhook payload.

Example#

For a DEPOSIT webhook, you would provide a URL like:
https://your-server.com/webhooks/deposit
Our system will send a POST request to this URL every time a deposit occurs for one of your associated companies.
Modified at 2025-09-23 14:56:39
Previous
Auth Information for Webhooks
Next
Transactions Events - DEPOSIT
Built with