Skip to content

Withdrawals

OpenFX provides a webhook to notify when a withdrawal is made. This webhook can be used to automate withdrawal processing.

Webhook Payload (Fiat)

{
  "eventId": "ba8dbff0-6d7b-45b1-961b-84de15d9158f", // Unique identifier for the webhook event
  "type": "withdrawals", // Type of the webhook event
  "message": "Completed Withdrawals", // Message of the webhook event
  "timestamp": "2025-03-19T10:39:52.891Z" // Timestamp of the webhook event
  "data": [
    {
      "id": "d67191dc-8bab-4335-96fa-85d59d0168ec", // Unique identifier for the withdrawal
      "orgId": "4638f9df-8a2b-44f4-a31c-d0477fd03e87", // Unique identifier for the organization
      "amount": 10000, // Amount of the withdrawal
      "currency": "USD", // Currency of the withdrawal
      "status": "COMPLETED", // Status of the withdrawal
      "network": "FIAT", // Network of the withdrawal
      "actorEmail": "user@company.com", // Email of the user that initiated the withdrawal
      "transactionHash": null, // Transaction Hash of the withdrawal, if exists
      "completedAt": "2025-03-19T10:39:50.618Z" // Timestamp of the withdrawal
    }
  ]
}

Webhook Payload (Stablecoin)

{
  "eventId": "ba8dbff0-6d7b-45b1-961b-84de15d9158f", // Unique identifier for the webhook event
  "type": "withdrawals", // Type of the webhook event
  "message": "Completed withdrawals", // Message of the webhook event
  "timestamp": "2025-03-19T10:39:52.891Z" // Timestamp of the webhook event
  "data": [
    {
      "id": "d67191dc-8bab-4335-96fa-85d59d0168ec", // Unique identifier for the withdrawal
      "orgId": "4638f9df-8a2b-44f4-a31c-d0477fd03e87", // Unique identifier for the organization
      "amount": 10000, // Amount of the withdrawal
      "currency": "USDT", // Currency of the withdrawal
      "status": "COMPLETED", // Status of the withdrawal
      "network": "ETHEREUM", // Network of the withdrawal
      "referenceId": null, // Reference ID of the withdrawal, if exists
      "comments": null, // Comments of the withdrawal, if exists
      "transactionHash": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060", // Transaction Hash of the withdrawal, if exists
      "completedAt": "2025-03-19T10:39:50.618Z", // Timestamp of the withdrawal
    }
  ]
}
Previous page