/getBatchDetails

https://[domain]/ws/eca/getBatchDetails

Service to get BatchID Details of one or more accounts
HTTP Request Type: POST

Request Parameters

Name	Value	Description	Usage
CSID	Client Service ID	Unique identifier issued by Interactive Brokers.	Required
accountIds	IBKR Client Account Number	List of one or more accounts	Required

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

Required

accountIds

IBKR Client Account Number

List of one or more accounts

Required

JSON Request

Copy

{
  "CSID":"<client-service-id>",
  "accountIds":[“<ID1>","<ID2>","<ID3>",...]
}

Sample

Copy

curl -k -H "Content-Type:application/json" -X POST https://[domain]/ws/eca/getBatchDetails -d '{"CSID":"testerCSID", "accountIds":["U111118"]}'

Response Parameters

Name	Value	Description
Account ID	IBKR Client Account Number	Account Number associated with the BatchID
BatchID	BatchId associated with the account.	When you receive the response, you will receive a batch ID.
Date Begun	YYYY-MM-DD HH:MM:SS	Date/Time which the account was created
Clearing Status	A=Abandoned N= New Account O= Open C= Closed P= Pending R= Rejected	A= Abandoned (i.e. application was deleted) N= New Account / Not Yet Open (pending online steps/pending agreements & disclosures on the account) O= Open (Considered active accounts) C= Closed (considered accounts that were once active OR open accounts that were and then closed.) P= Pending (application steps are completed- pending approval or pending POI/POA submission) R= Rejected (meaning account was never approved/opened- rejected by Compliance)
isError	Boolean	Indicates if there was an error when processing the request.
Error	String AND only populated if isError="true"	Description of error.

JSON Response

Copy

{
  "result" : [ {
    "Account ID" : "<ID1>",
    “BatchID":"<Batch Id>",       
    "Date Begun" : "<Date Begun>",
    "Clearing Status" : "<Status>"
  }, {
    "Account ID" : "<ID2>",       
    "isError" : true,
    "error" : "<Error Description>."
  } ]
}

Sample

Copy

Success

{"result":[{"Account ID":"U111118","Date Begun":"2019-11-26 03:07:59","BatchID":"722514","Clearing Status":"O"}]}

Copy

Error

{"result":[{"Account ID":"U1234567","isError":true,"error":"U1234567 is not associated with your Advisor/iBroker Account."}]}Error - Invalid Account ID