CRM Open API DocumentationCRM Open API Documentation
REST API
Webhooks
PSP Open API
External Exchange Rates
REST API
Webhooks
PSP Open API
External Exchange Rates
  • Webhook Introduction
  • Securing your Webhooks
  • Events - Approval

    • Withdrawal

      • Approve Withdrawal Requests
      • Reject Withdrawal Requests
    • Prop Trading

      • Approve Prop Trading Requests
      • Reject Prop Trading Live Requests
    • Prop Trading Live

      • Approve Prop Trading Live Requests
      • Reject Prop Trading Live Requests

Approve Withdrawal Requests

Event

Event SlugDescription
crm.webhooks.requests.withdrawal.approve.node.1Triggers when multi-step approval is disabled, or multi-step approval is installed and approved on the 1st node
crm.webhooks.requests.withdrawal.approve.node.2Triggers when approved on the 2nd node
crm.webhooks.requests.withdrawal.approve.node.3Triggers when approved on the 3rd node
crm.webhooks.requests.withdrawal.approve.node.4Triggers when approved on the 4th node
crm.webhooks.requests.withdrawal.approve.node.5Triggers when approved on the 5th node
crm.webhooks.requests.withdrawal.approve.node.6Triggers when approved on the 6th node
crm.webhooks.requests.withdrawal.approve.node.7Triggers when approved on the 7th node
crm.webhooks.requests.withdrawal.approve.node.8Triggers when approved on the 8th node
crm.webhooks.requests.withdrawal.approve.node.9Triggers when approved on the 9th node
crm.webhooks.requests.withdrawal.approve.node.10Triggers when approved on the 10th node

Data

KeyTypeDescription
idstringrequest id
typestringrequest type: withdrawal
statusstringrequest status: approved | pending
user_idstringrequest user id
request_timestringdate and time of the request. UTC+0
trading_idnumber | stringtrading account id | WALLET
trading_platformstringtrading platform
trading_connection_idstringtrading platform server id
trading_currencystringtrading acount currency
trading_amountstringamount deducted from user's trading account or wallet
withdrawal_methodstringwithdrawal method name
withdrawal_currencystringwithdrawal target currency
exchange_ratestringwithdrawal exchange rate
converted_amountnumberconverted amount after exchange rate
withdrawal_feestringwithdrawal fee
withdrawal_amountstringfinal withdrawal amount after adding fee
external_order_idstringonly for integrated automatic withdrawal methods
custom_fieldsarraycustomized fields in the dynamic form
custom_fields[].keystringSystem unique key of the field
custom_fields[].typestringType of the field
custom_fields[].labelstringLabel of the field
custom_fields[].label.[language-code]stringLabel of the field in different languages
custom_fields[].valuestring/object/arrayValue of the field
withdrawal_flowobjectshow current withdrawal stage when multi-step approval is configured
withdrawal_flow.total_stepsobjecttotal number of steps for this withdrawal
withdrawal_flow.current_stepsobjectcurrent step that has been approved

Example

This is an example of the full JSON payload while approving a withdrawal request on node 1

{
  "source": {
    "service": "requests",
    "group": "crm.webhooks.groups.requests.withdrawal",
    "event": "crm.webhooks.requests.withdrawal.approve.node.1"
  },
  "target": {
    "name": "Webhook-Withdraw"
  },
  "version": "1.0.0",
  "data": {
    "id": "********",
    "type": "withdrawal",
    "status": "pending",
    "user_id": "********",
    "request_time": "2023-08-21 03:37:29",
    "trading_id": 60050,
    "trading_platform": "mt4",
    "trading_connection_id": "****",
    "trading_currency": "USD",
    "trading_amount": "10",
    "withdrawal_method": "****",
    "withdrawal_currency": "BTC",
    "converted_amount": 0.00039,
    "withdrawal_fee": "0",
    "exchange_rate": "0.000039",
    "withdrawal_amount": "0.00039000",
    "external_order_id": "*****",
    "custom_fields": [
      {
        "key": "walletaddress",
        "type": "text",
        "label": {
          "en-us": "Wallet Address"
        },
        "value": "********"
      }
    ],
    "withdrawal_flow": {
      "total_steps": 3,
      "current_step": 1
    }
  }
}
Last Updated:: 8/26/24, 7:57 AM
Next
Reject Withdrawal Requests