Home B2Core IB API Operations

Operations

On this page:

THE DEPOSIT OBJECT	A detailed description of the JSON object
THE WITHDRAWAL OBJECT	A detailed description of the JSON object
GET[base]/operations/deposits	Get a deposits list
GET[base]/operations/deposits/{depositId}	Get deposit details
GET[base]/operations/withdrawals	Get a withdrawals list
GET[base]/operations/withdrawals/{withdrawalId}	Get withdrawal details

---

The Deposit object

This object provides the following data about a deposit operation:

accountId string

The account identifier.

accountNumber string

The account number.

amount string

The amount of a deposit operation.

createTime string

The date and time when the object has been created.

currencyCode string

The alphabetic code of operation currency (such as USD).

depositId string

The identifier of a deposit operation.

platformUniqueValue string

The unique value of a deposit operation on a trading platform.

THE DEPOSIT OBJECT

{
  "accountId": "6006dda272f002519c3eb505",
  "accountNumber": "9",
  "amount": "1.000000000000000000",
  "createTime": "2021-01-01T00:00:00+00:00",
  "currencyCode": "BTC",
  "depositId": "6006dda272f002519c3eb506",
  "platformUniqueValue": "9"
}

---

The Withdrawal object

This object provides the following data about a withdrawal operation:

accountId string

The account identifier.

accountNumber string

The account number.

amount string

The amount of a withdrawal operation.

createTime string

The date and time when the object has been created.

currencyCode string

The alphabetic code of operation currency (such as USD).

withdrawalId string

The identifier of a withdrawal operation.

platformUniqueValue string

The unique value of a withdrawal operation on a trading platform.

THE WITHDRAWAL OBJECT

{
  "accountId": "6006dda272f002519c3eb505",
  "accountNumber": "9",
  "amount": "1.000000000000000000",
  "createTime": "2021-01-01T00:00:00+00:00",
  "currencyCode": "BTC",
  "withdrawalId": "6006dda272f002519c3eb506",
  "platformUniqueValue": "9"
}

---

Get a deposits list

Use this method to obtain a list of all deposit operations.

To obtain detailed information about a specified deposit operation, use a separate method to get deposit details.

Request

Header parameters:

• Authorization: Bearer <token>

Query parameters:

This method supports pagination, sorting, and filtering. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering and sorting are listed below. For values description, refer to the Deposit object.

Possible values for the filter parameter:

• accountId

• profileId

Possible values for the sort_by parameter:

• createTime (default)

GET[base]/operations/deposits

curl --location -g --request GET 'https://your.base-url.here/operations/deposits?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[accountId]=6006dda272f002519c3eb505&filter[profileId]=6006dda272f002519c3eb505' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Deposit objects providing information about all deposit operations that correspond to the query parameters specified in the request.

---

Get deposit details

Use this method to obtain detailed information about a specified deposit operation.

To obtain a list of deposit operations, use a separate method to get a list of deposits.

Request

Header parameters:

• Authorization: Bearer <token>

Path parameters:

depositId required

The deposit operation identifier.

GET[base]/operations/deposits/{depositId}

curl --location --request GET 'https://your.base-url.here/operations/deposits/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Deposit object providing information about the specified deposit operation.

---

Get a withdrawals list

Use this method to obtain a list of all withdrawal operations.

To obtain detailed information about a specified withdrawal operation, use a separate method to get withdrawal details.

Request

Header parameters:

• Authorization: Bearer <token>

Query parameters:

This method supports pagination, sorting, and filtering. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering and sorting are listed below. For values description, refer to the Withdrawal object.

Possible values for the filter parameter:

• accountId

• profileId

Possible values for the sort_by parameter:

• createTime (default)

GET[base]/operations/withdrawals

curl --location -g --request GET 'https://your.base-url.here/operations/withdrawals?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[accountId]=6006dda272f002519c3eb505&filter[profileId]=6006dda272f002519c3eb505' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Withdrawal objects providing information about all withdrawal operations that correspond to the query parameters specified in the request.

---

Get withdrawal details

Use this method to obtain detailed information about a specified withdrawal operation.

To obtain a list of withdrawal operations, use a separate method to get a list of withdrawals.

Request

Header parameters:

• Authorization: Bearer <token>

Path parameters:

withdrawalId required

The withdrawal operation identifier.

GET[base]/operations/withdrawals/{withdrawalId}

curl --location --request GET 'https://your.base-url.here/operations/withdrawals/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Withdrawal object providing information about the specified withdrawal operation.