/callback

https://[YourDomain]/eca/callback

  • IBKR will send notifications via RESTful Web API when status of a request changes.

  • The notifications provided via the callback service have the same format as polling for a status (ie. /getAccountStatus, /getAmRequestStatus)

  • Notifications are only sent for requests that are initiated using DAM.

  1. Callback service is available by request only. To configure the service, provide the following information to dam@ibkr.com:

    • URL which callback notifications should be sent to

    • Master account ID which the callback service should be configured for

    *Callback service is only available for PROD, service is not available in QA.

  2. IBKR will register the URL and configure the callback service for your account. Configuration takes 3-4 weeks.

    • Clients enabled for Callback Notification can still use Polling for Status without any restrictions.

HTTP codes: 200 indicates the request was successfully processed; in this case we will not retry to deliver the same data again.

For errors, the corresponding HTTP error codes should be returned.

JSON Response

Copy 
{
  "timestamp": "<2020-02-10 10:19:28>", "data":" hQIMA/mOMVbs3nc3ARAAn39g5AhKKwNVnWjzOSCpH1e+d7FJ2rb6aBMB/e 8X8oTxiA2PXvl8POLNWcu3Ka1tDMpuC9b47FM8g3/UjGDqP+/GRrLj9tJz89/R5BNmrcrAn5YUmRcYcsJx3EL B7G/Tc FqI8XML"
  }
}

Decrypted Response

Service

request_type

Sample Notification (Accepted)

Sample Notification (Rejected)

/create

ACCT_OPENING
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ACCT_OPENING",
  "ref_acct_id":"U3519306",
  "status":"OPENED"
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ACCT_OPENING",
  "ref_acct_id":"U3519306",
  "status":"REJECTED"
}

/update 'AddCLPCapability'

ADD_CLP
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ADD_CLP",
  "status": "ACCEPTED",
  "ref_acct_id":"U3519306"
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ADD_CLP",
   "status":"REJECTED"
  "ref_acct_id":"U3519306"
}

/update 'AddLEVFXCapability'

ADD_LEVFX
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ADD_LEVFX",
  "status": "ACCEPTED",
  "ref_acct_id":"U3519306"
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ADD_LEVFX",
   "status":"REJECTED"
  "ref_acct_id":"U3519306"
}

/update 'AddTradingPermissions'

ADD_TRADING
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ADD_TRADING",
  "ref_acct_id":"U3519306",
  "details": {
    "bundle": "US-Sec",
    "status": "ACCEPTED"
  }
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "ADD_TRADING",
  "ref_acct_id":"U3519306",
  "details": {
    "bundle": "US-Sec",
   "status":"REJECTED"
  }
}

/update 'ChangeFinancialInformation'

CHANGE_FIN_INFO
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "CHANGE_FIN_INFO",
  "status": "ACCEPTED",
  "ref_acct_id":"U3519306"
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "CHANGE_FIN_INFO",
   "status":"REJECTED"
  "ref_acct_id":"U3519306"
}

/update 'ChangeMarginType'

CHANGE_MARGIN

 
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "CHANGE_MARGIN",
  "status": "ACCEPTED",
  "ref_acct_id":"U3519306"
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "CHANGE_MARGIN",
   "status":"REJECTED"
  "ref_acct_id":"U3519306"
}

/update 'DocumentSubmission'

DOC_SUBMISSION
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "DOC_SUBMISSION",
  "ref_acct_id":"U3519306",
  "details": {
    "form_number": "9490",
    "status": "ACCEPTED",
    "external_id": "ext_id_first_holder"
  }
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "DOC_SUBMISSION",
  "ref_acct_id":"U3519306",
  "details": {
    "form_number": "9490",
   "status":"REJECTED"
    "external_id": "ext_id_first_holder"
  }
}

/update 'RemoveTradingPermissions'

REMOVE_TRADING
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "REMOVE_TRADING",
  "ref_acct_id":"U3519306",
  "details": {
    "bundle": "US-Sec",
    "status": "REMOVED"
  }
}
Copy 
{
  "timestamp":"2021-08-18 12:07:31",
  "request_type": "REMOVE_TRADING",
  "ref_acct_id":"U3519306",
  "details": {
    "bundle": "US-Sec",
   "status":"REJECTED"
  }
}