Back Office API objects
In this section, you can learn about the objects used in the Back Office API:
The Account object (Back Office)
This object provides the following data about a client account:
- accountId integer
The account identifier.
- accountNumber string
The account number displayed to a client.
- clientId integer
The identifier of a client who owns the account.
- caption string
The account name displayed in the B2Core UI.
- currency object
The details about a currency in which an account is denominated. See the Currency object to learn more.
- group object
The details about a group associated with the product for which an account is created:
Show object fields- id integer
The product group identifier.
- name string
The product group name.
- name string
The account name.
- permissions array
An array of string values specifying the permissions assigned to an account. Possible values:
deposit
enabled
exchange
trade
transferDeposit
transferWithdrawal
visible
withdrawal
- platform object
The details about a platform on which an account is created.
Show object fields- id integer
The platform identifier.
- name string
The platform name.
- product object
The details about a product for which an account is created:
Show object fields- id integer
The product identifier.
- name string
The localized product name.
- statement object
The details about an account statement. See the Statement object to learn more.
- type string
The account type. Possible values:
personal
trade
demo
partner
liquidity
exchange
external
bo
iisbo
system
- archiveTime string
The date and time when an account was archived.
- createTime string
The date and time when an account was created.
{
"accountId": 1,
"accountNumber": "2100242175",
"clientId": 1,
"caption": "USD",
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"group": {
"id": 1,
"name": "Fiat"
},
"name": "USD",
"permissions": [
"deposit",
"trade",
"withdrawal"
],
"platform": {
"id": 1,
"name": "MetaTrader 5"
},
"product": {
"id": 1,
"name": "Forex"
},
"statement": {
"availableBalance": "1.000000000000000000",
"currentBalance": "1.000000000000000000",
"credit": "1.000000000000000000",
"equity": "1.000000000000000000",
"freeMargin": "1.000000000000000000",
"hold": "1.000000000000000000",
"margin": "1.000000000000000000",
"marginLevel": "1.000000000000000000",
"pnl": "1.000000000000000000",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"type": "trade",
"archiveTime": "2022-01-01T00:00:00+00:00",
"createTime": "2022-01-01T00:00:00+00:00"
}
The Address object (Back Office)
This object provides the following data about a client address:
- id integer
The client address identifier.
- address string
The clientтАЩs street address.
- city string
The clientтАЩs city.
- country object
The details about a clientтАЩs country. See the Country object to learn more.
- postcode string
The clientтАЩs postal code.
- state string
The name of a state.
- type string
The type of a client address. Possible values:
residential
billing
mailing
- clientId integer
The client identifier.
- createTime string
The date and time when a client address was added.
- updateTime string
The date and time when a client address was last updated.
{
"id": 1,
"address": "47 W 13th St, New York, NY 10011, USA",
"city": "New York",
"country": {
"countryId": 8,
"alpha2Code": "US",
"alpha3Code": "USA",
"countryName": "United States",
"numericCode": "840"
},
"postcode": "0200 - 9729",
"state": "New York",
"type": "residential",
"clientId": 1,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Client object (Back Office)
This object provides the following data about a client:
- analytics array
An array of objects providing data about UTM parameters added to a referral link if a client has registered in the B2Core UI after clicking it.
UTM parameters and their values can be passed within the
utm
object when using the Initialize the Sign Up Wizard and then Sign up methods to register a client.Show object fields- property string
The UTM tag.
- value string
The value assigned to a UTM tag.
- clientId integer
The client identifier.
- birthday string
The clientтАЩs date of birth.
- city string
The clientтАЩs city.
- country object
The details about a clientтАЩs country of residence. See the Country object to learn more.
- company object
The details about a client company.
Show object fields- fullName string
The full company name.
- shortName string
The short company name.
- email string
The client email address.
- internalType string
The internal category assigned to a client. Possible values:
agent
b2b
default
demo
exchange
- firstName string
The client first name.
- lastName string
The client last name.
- middleName string
The client middle name.
- name string
The client full name.
- nickname string
The client nickname.
- locale string
The client locale.
- manager object
The details about a manager to whom a client is assigned.
Show object fields- id integer
The client manager identifier.
- officeId integer
The office identifier.
- enabled boolean
If
true
, a client manager profile is enabled; otherwise,false
.- email string
The client manager email address.
- name string
The client manager full name.
- title string
The client manager title (such as
Mr.
orMs.
).- createTime string
The date and time when a client manager was registered.
- phone string
The client phone number.
- riskLevel string
The risk level assigned to a client. Possible values:
low
middle
high
- status string
The status of a client profile. Possible values:
active
banned
deleted
inactive
- tags array
An array of string values identifying the tags assigned to a client.
- type object
The details about a category assigned to a client:
Show object fields- id integer
The client category identifier.
- name string
The client category name (such as
Individual
).
- verificationLevel object
The details about the verification level obtained by a client:
Show object fields- id integer
The verification level identifier.
- name string
The verification level name (for example,
Level 1
).
- loggedAt string
The date and time when a client last signed in.
- createTime string
The date and time when a client was registered.
- updateTime string
The date and time when client-related data was last modified.
{
"analytics": [
{
"property": "utm_campaign",
"value": "summer_program"
}
],
"clientId": 1,
"birthday": "2022-01-01T00:00:00+00:00",
"city": "New York",
"country": {
"countryId": 8,
"alpha2Code": "US",
"alpha3Code": "USA",
"countryName": "United States",
"numericCode": "840"
},
"company": {
"fullName": "full name company",
"shortName": "short name company"
},
"email": "foo@bar.com",
"internalType": "default",
"firstName": "Mary",
"lastName": "Smith",
"middleName": "Jane",
"name": "Mary Jane Smith",
"nickname": "Voronov",
"locale": "ja_JP",
"manager": {
"id": 1,
"officeId": 1,
"enabled": false,
"email": "foo@bar.com",
"name": "John Smith",
"title": "mr.",
"createTime": "2022-01-01T00:00:00+00:00"
},
"phone": "+7 999 200 00 00",
"riskLevel": "low",
"status": "active",
"tags": [
"cupidatat veniam est",
"nulla sunt"
],
"type": {
"id": 1,
"name": "Individual"
},
"verificationLevel": {
"id": 1,
"name": "Level 1"
},
"loggedAt": "2022-01-01T00:00:00+00:00",
"createTime": "2022-01-01T00:00:00+00:00"
}
The Profile Change object (Back Office)
This object provides the following data about changes made to a client profile:
- id integer
The identifier of a change record.
- clientId integer
The client identifier.
- currentValue string
The current email address that is used by a client to sign in to the B2Core UI.
- previousValue string
The previous client email address.
- type string
The change type. Possible values:
email
- userId integer
The identifier of an admin user who has made a change.
- createTime string
The date and time when a change was made to a client profile.
{
"id": 1,
"clientId": 1,
"currentValue": "jdoe@example.com",
"previousValue": "john@example.com",
"type": "email",
"userId": 1,
"createTime": "2022-01-01T00:00:00+00:00"
}
The Client Type object (Back Office)
This object provides the following data about a client type:
- id integer
The client type identifier.
- default boolean
If
true
, this is the default type assigned to all newly registered clients; otherwise,false
.- enabled boolean
If
true
, this type can be assigned to clients; otherwise,false
.- name string
The client type name.
- group string
The group to which a client type is assigned. Possible values:
individual
тАФ indicates an individual clientcorporative
тАФ indicates a corporate client
- wizard boolean
If
true
, wizard pages are displayed to clients with the assigned type.
- resources array
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
{
"id": 1,
"default": true,
"enabled": true,
"name": "Individual",
"group": "individual",
"wizard": true,
"resources": [
{
"resourceId": "6006dda272f002519c3eb505",
"locale": "ja_JP",
"key": "name",
"value": "хРНхЙН",
},
{
"resourceId": "6006ffa272f002449c3eb303",
"locale": "ja_JP",
"key": "type",
"value": "уВ┐уВдуГЧ",
}
],
}
The Country object (Back Office)
This object provides the following data about a country:
- countryId integer
The country identifier.
- alpha2Code string
A two-letter country code (as per ISO 3166-2).
- alpha3Code string
A three-letter country code (as per ISO 3166-3).
- countryName string
The localized country name.
- callingCode string
The international country dialing code.
- numericCode string
A numeric country code (as per ISO 3166).
- currency object
The details about a national currency. See the Currency object to learn more.
- enabled boolean
If
true
, a country is available for selection when clients sign up to the B2Core UI.
{
"countryId": 840,
"alpha2Code": "US",
"alpha3Code": "USA",
"countryName": "United States",
"callingCode": "+1",
"numericCode": "840",
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"enabled": true
}
The Currency object (Back Office)
This object provides the following data about a currency:
- alphabeticCode string
The alphabetic code of a currency (such as
BTC
).- blockExplorer string
Applicable only for cryptocurrencies.
The cryptocurrency block explorer.
- enabled boolean
If
true
, a currency can be used for financial operations; otherwise,false
.- markupBuy number
The buy commission markup, as a percentage.
- markupSell number
The sell commission markup, as a percentage.
- minorUnit integer
The number of decimal places displayed when representing amounts in a currency.
- name string
The currency name.
- numericCode integer
The numeric code of a currency.
- resources array
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when a currency was added to the Back Office.
- updateTime string
The date and time when the currency configuration was last updated.
{
"alphabeticCode": "BTC",
"blockExplorer": "https://live.blockcypher.com/btc/tx/{address}",
"enabled": true,
"markupBuy": 50.55,
"markupSell": 50.55,
"minorUnit": 8,
"name": "Bitcoin",
"numericCode": 1000,
"resources": [
{
"key": "caption",
"locale": "ja_JP",
"value": "уГУуГГуГИуВ│уВдуГ│"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Currency Alias object (Back Office)
This object provides the following data about a currency alias:
- id integer
The identifier of a currency alias.
- alphabeticCode string
The alphabetic code of a currency alias.
- name string
The name of a currency alias.
- numericCode integer
The numeric code of a currency for which an alias is set up.
- createTime string
The date and time when a currency alias was set up
{
"id": 14,
"alphabeticCode": "USXF",
"name": "X Dollar",
"numericCode": 8980,
"createTime": "2022-01-01T00:00:00+00:00"
}
The Currency Pair object (Back Office)
This object provides the following data about a currency pair:
- id integer
The identifier of a currency pair.
- fromCurrency object
The details about the base currency. See the Currency object to learn more.
- toCurrency object
The details about the quote currency. See the Currency object to learn more.
- isEnabled boolean
If
true
, a currency pair can be exchanged by clients in the B2Core UI; otherwise,false
.- step number
The minimum increment by which an amount can be changed at a time.
- isHedgingEnabled boolean
If
true
, exchange operations in this currency pair are hedged; otherwise,false
.- isEnabledForAdmin boolean
If
true
, a currency pair can be exchanged via the Back Office; otherwise,false
.- maxAmount number
The maximum allowed amount per exchange operation in a currency pair.
- createTime string
The date and time when a currency pair was added.
- updateTime string
The date and time when a currency pair was last updated.
- ratesCustomPriority array
An array of string values specifying the names of exchange rate providers, in the order in which their rates are obtained.
{
"id": 1,
"fromCurrency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"toCurrency": {
"alphabeticCode": "GBP",
"minorUnit": 2,
"name": "Pound Sterling",
"numericCode": 826
},
"isEnabled": true,
"step": 55.55,
"isHedgingEnabled": true,
"isEnabledForAdmin": true,
"maxAmount": 55.55,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00",
"ratesCustomPriority": [
{
"name": "CoinGecko"
},
{
"name": "coinmarket"
}
]
}
The Device object (Back Office)
This object provides the following data about a client device:
- id integer
The device identifier.
- fingerprint object
The device fingerprint data:
Show object fields- platform string
The device platform.
- userAgent string
The user agent data.
- webTimezone string
The time zone set in a client browser.
- hash string
The device hash.
- ipAddress string
The client IP address.
- lastSignIn string
The date and time when a client last signed in to the B2Core UI using this device.
- createTime string
The date and time when a device was added to a list of client devices.
{
"id": 1,
"fingerprint": {
"platform": "macIntel",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.1.2 Safari/605.1.15",
"webTimezone": "Europe/Moscow"
},
"hash": "wyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
"ipAddress": "127.0.0.1",
"lastSignIn": "2022-01-01T00:00:00+00:00",
"createTime": "2022-01-01T00:00:00+00:00"
}
The Document object (Back Office)
This object provides the following data about a client document submitted for passing a verification procedure:
- id integer
The identifier of a document.
- type object
The details about a type assigned to a document. See the Document Type object to learn more.
- status string
The status of a client request for document approval.
- applicationId integer
The identifier of a client request for document approval.
- files object
The details about a document file:
Show object fields- id integer
The identifier of a document file.
- file string
The path to a document file.
- createTime string
The date and time when a document was submitted.
{
"id": 1,
"type": {
"id": 1,
"description": "Document types available for corporate clients",
"enabled": true,
"ex╨░mple": "example",
"group": {
"id": 1,
"description": "The documents required for corporate clients",
"enabled": true,
"name": "corporate",
"priority": 1,
"type": "one"
},
"maxFiles": 10,
"name": "corporate",
"priority": 1
},
"status": "approved",
"applicationId": 1,
"files": [
{
"id": 8,
"file": "y/1662913861_photo_2022-09-08_11-23-06.jpg"
}
],
"createTime": "2022-01-01T00:00:00+00:00"
}
The Document Type object (Back Office)
This object provides the following data about a document type:
- id integer
The identifier of a document type.
- description string
The localized description of a document type.
- enabled boolean
If
true
, a document type can be used for client verification; otherwise,false
.- example string
The path to a sample document that can be uploaded for this document type.
- group object
The details about a document group in which a document type is included. See the Document Group object for details.
- maxFiles integer
The maximum number of files that can be uploaded for a document type.
- name string
The localized name of a document type.
- priority integer
The priority index assigned to a document type.
{
"id": 1,
"description": "Document types available for corporate clients",
"enabled": true,
"ex╨░mple": "example",
"group": {
"id": 1,
"description": "The documents required for corporate clients",
"enabled": true,
"name": "corporate",
"priority": 1,
"type": "one"
},
"maxFiles": 10,
"name": "corporate",
"priority": 1
}
The Document Group object (Back Office)
This object provides the following data about a document group:
- id integer
The identifier of a document group.
- description string
The localized description of a document group.
- enabled boolean
If
true
, a document group can be used for client verification; otherwise,false
.- name string
The localized name of a document group.
- priority integer
The priority index assigned to a document group.
- type string
The type of a document group. Possible values:
one
тАФ indicates that a single document type belongs to this document groupall
тАФ indicates that all available document types belong to this document group
{
"id": 1,
"description": "The documents required for corporate clients",
"enabled": true,
"name": "corporate",
"priority": 1,
"type": "one"
}
The Localization object (Back Office)
This object provides the following data about a localization option:
- id integer
The localization option identifier.
- caption string
The name of a language for which localization settings are configured.
- locale string
The locale identifier (such as
en_US
).- isEnabled boolean
If
true
, a language can be selected by clients in the B2Core UI; otherwise,false
.- isDefault boolean
If
true
, a language and the localization settings specified for it are applied by default; otherwise,false
.- isRightToLeft boolean
If
true
, text strings are displayed in the right-to-left direction; otherwise,false
.- priority integer
The priority index assigned to a localization option.
- format object
The details about format settings specified for a localization option.
Show object fields- decimal string
A character used as a decimal separator.
- fullDate string
The full date format (such as
l, F j, Y
).- fullTime string
The full time format (such as
h:i:s A T
).- longDate string
The long date format (such as
F j, Y
).- middleDate string
The middle date format starting with the month (such as
M j, Y
).- middleTime string
The middle time format (such as
h:i:s A
).- name string
The person name format (such as
{title} {givenName} {familyName}
)- shortDate string
The short date format (such as
h:i A
)- shortTime string
The short time format (such as
h:i A
).- thousands string
A character used as a thousands separator.
{
"id": 1,
"caption": "English",
"locale": "en_EN",
"languageCode": "en",
"isEnabled": true,
"isDefault": true,
"isRightToLeft": false,
"priority": 1,
"format": {
"decimal": ",",
"fullDate": "l, F j, Y",
"fullTime": "h:i:s A T",
"longDate": "F j, Y",
"middleDate": "M j, Y",
"middleTime": "h:i:s A",
"name": "{title} {givenName} {familyName}",
"shortDate": "d.m.Y",
"shortTime": "h:i A",
"thousands": " "
}
}
The Phone Number object (Back Office)
This object provides the following data about a client phone number:
- id integer
The identifier of a phone number.
- clientId integer
The client identifier.
- confirmed boolean
If
true
, a phone number is confirmed, otherwisefalse
.- default boolean
If
true
, a phone number is marked as the default one for a client, otherwisefalse
.- ext string
The phone number extension.
- number string
The client phone number.
- type string
The type of a phone number. Possible values:
fixed
mobile
fax
voip
pager
- createTime string
The date and time when a phone number was added to a client profile.
- updateTime string
The date and time when a phone number was last modified.
{
"id": 1,
"clientId": 1,
"confirmed": false,
"default": true,
"ext": "812",
"number": "+79992082113",
"type": "mobile",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Product object (Back Office)
This object provides the following data about a product:
- id integer
The product identifier.
- name string
The product name used in the Back Office.
- caption string
The product name displayed to clients in the B2Core UI.
- type string
The product type. Possible values:
personal
trade
demo
partner
liquidity
exchange
external
bo
iisbo
system
- status string
The product status. Possible values:
disabled
present
enabled
default
- defaultLeverage integer
The default leverage ratio specified for a product.
- leverages array
An array of integer values specifying optional leverage ratios specified for a product.
- maxAccounts integer
The maximum number of accounts that can be created for a client.
- sendMailSetting string
Indicates whether to notify a client about a created account via email. Possible values:
dontSend
default
send
- mailTemplate string
The email template used to notify clients about created accounts.
- startAmounts array
Applicable only for demo accounts.
An array of number values specifying the initial amounts to be deposited to demo accounts.
- priority
The priority index assigned to a product.
- linkInfo string
A link to an external resource providing additional information about a product.
- agreementLink string
A link to a document to which a client must consent in order to open a product-associated account.
- requestRequired boolean
If
true
, when opening a new account via the B2Core UI, a client request (which must be approved or rejected by an admin) is always created; otherwise,false
.- minDepositAmount integer
Applicable only for trading accounts.
The minimum required deposit amount.
- autoCreateOnLogin boolean
If
true
, a product-associated account is created automatically for each client upon initial sign in to the B2Core UI; otherwise,false
.- permissions array
An array of string values specifying permissions applied to a product. Possible values:
deposit
enabled
exchange
trade
transferDeposit
transferWithdrawal
visible
withdrawal
- resources array
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
- defaultAccountPermissions array
An array of string values specifying permissions applied to product-associated accounts. Possible values:
deposit
enabled
exchange
trade
transferDeposit
transferWithdrawal
visible
withdrawal
- platform object
The details about a platform for which a product is created.
Show object fields- id integer
The platform identifier.
- caption string
The platform name displayed to clients in the B2Core UI.
- group object
The details about a product group in which a product is included.
Show object fields- id integer
The product group identifier.
- caption string
The product group name.
- options object
The details specific to a platform for which a product is created.
- currencies object
The details about one or several currencies enabled for a product.
Show object fields- id integer
The currency identifier.
- caption string
The currency name.
- alphabeticCode string
The alphabetic code of a currency (such as
BTC
).- numericCode integer
The numeric code of a currency. (such as
1000
).
- createTime string
The date and time when a product was created.
- updateTime string
The date and time when a product was last updated.
{
"id": 36,
"name": "mt5_btc_live",
"caption": "MT5 Live",
"type": "trade",
"status": "enabled",
"group": {
"id": 6,
"caption": "MetaTrader5 Live"
},
"platform": {
"id": 8,
"caption": "MetaTrader5 Live"
},
"currencies": [
{
"id": 5,
"caption": "MT5 LiveL",
"alphabeticCode": "BTC",
"numericCode": 1000
},
{
"id": 24,
"caption": "MT ETH",
"alphabeticCode": "ETH",
"numericCode": 1002
},
{
"id": 35,
"caption": "",
"alphabeticCode": "LTC",
"numericCode": 1003
},
{
"id": 58,
"caption": "mt5_usd",
"alphabeticCode": "USD",
"numericCode": 840
}
],
"createTime": "2021-05-31T11:03:24+00:00",
"updateTime": "2022-11-24T07:35:02+00:00"
}
The Product Currency object (Back Office)
This object provides the following data about a product currency:
- id integer
The identifier of a product currency.
- caption string
The name specified for a product currency.
- isEnabled boolean
If
true
, a currency is enabled for a product; otherwise,false
.- platformGroups array
An array of string values specifying platform group names.
- priority integer
The priority index assigned to a product currency.
- currency object
The details about a product currency.
Show object fields- alphabeticCode integer
The alphabetic code of a currency (such as
EUR
).- minorUnit integer
The number of decimal places displayed when representing amounts in a currency.
- name string
The currency name.
- numericCode integer
The numeric code of a currency (such as
978
).
- factory integer
This parameter is set to
100
if product-associated accounts are denominated in currency subunits (for example, cents); otherwise, set to1
.- isHedgingEnabled boolean
If
true
, exchange operations in a product currency are hedged; otherwise,false
.- overwriteProductSettings boolean
If
true
, the settings specific to a product currency overwrite the settings of the product to which this currency is added.- permissions array
An array of string values specifying permissions applied to a product. Possible values:
deposit
enabled
exchange
trade
transferDeposit
transferWithdrawal
visible
withdrawal
- defaultAccountPermissions array
An array of string values specifying permissions applied to accounts denominated in a product currency. Possible values:
deposit
enabled
exchange
trade
transferDeposit
transferWithdrawal
visible
withdrawal
- defaultLeverage integer
The default leverage ratio specified for accounts denominated in a product currency.
- leverages array
An array of integer values specifying optional leverage ratios available to accounts denominated in a product currency.
- maxAccounts integer
The maximum number of accounts denominated in a product currency that can be created for a client.
- startAmounts array
Applicable only for demo accounts.
An array of string values specifying the initial amounts to be deposited to demo accounts denominated in a product currency.
- linkInfo string
A link to an external resource providing additional information about a product.
- agreementLink string
A link to a document to which a client must consent in order to open an account in a product currency.
- requestRequired boolean
If
true
, when opening a new account via the B2Core UI, a client request (which must be approved or rejected by an admin) is always created; otherwise,false
.- minDepositAmount integer
Applicable only for trading accounts.
The minimum deposit amount required for accounts denominated in a product currency.
- autoCreateOnLogin boolean
If
true
, an account denominated in a product currency is created automatically for each client upon initial sign in to the B2Core UI; otherwise,false
.- resources object
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
- createTime
The date and time when a currency was added to a product.
- updateTime
The date and time when a product currency was last updated.
{
"id": 1,
"caption": "EUR",
"isEnabled": true,
"platformGroups": [
"eWallet"
],
"priority": 1,
"currency": {
"alphabeticCode": "EUR",
"minorUnit": 2,
"name": "EUR",
"numericCode": 978
},
"factory": 1,
"isHedgingEnabled": true,
"overwriteProductSettings": false,
"permissions": [
"deposit",
"withdrawal"
],
"defaultAccountPermissions": [
"deposit",
"withdrawal"
],
"defaultLeverage": 1,
"leverages": [
1,
5
],
"maxAccounts": 1,
"startAmounts": [
"100.00",
"150.00"
],
"linkInfo": "https://example.url",
"agreementLink": "https://example.url",
"requestRequired": false,
"minDepositAmount": "100.00",
"autoCreateOnLogin": true,
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "Lorem"
},
{
"key": "caption",
"locale": "en_US",
"value": "Lorem"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Product Group object (Back Office)
This object provides the following data about a product group:
- id integer
The product group identifier.
- caption string
The product group name.
- description string
The product group description.
- status string
The status assigned to a product group. Possible values:
disabled
enabled
- type string
The product group type.
- priority integer
The priority index assigned to a product group.
- createTime string
The date and time when a product group was created.
- updateTime string
The date and time when a product group was last updated.
{
"id": 1,
"caption": "Stable Coins",
"description": "Stable Coins",
"status": "enabled",
"type": "default",
"priority": 1,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Request object (Back Office)
This object provides the following data about a client request:
- id integer
The request identifier.
- client object
The details about a client who submitted a request. See the Client object to learn more.
- ip string
The IP address from which a request was submitted.
- type string
The request type. Possible values:
account
address
archive
clientType
deposit
document
external
investment
partner
profile
transfer
verification
withdrawal
- resolution object
The details about a resolution added to a request if it was rejected. See the Resolution object to learn more.
- personalAccounts array
An array of objects providing details about client accounts of the personal type.
Show object fields- accountId integer
The account identifier.
- accountNumber string
The account number.
- tradeAccounts array
An array of objects providing details about client trading accounts.
Show object fields- accountId integer
The account identifier.
- accountNumber string
The account number.
- accountId integer
The account identifier.
- amount string
The transaction amount.
- method string
The localized name of a method by which a transaction was made.
- transactionId integer
The transaction identifier.
- currency string
The transaction currency.
- dealingApproved string
Applicable only for withdrawal-type transactions.
Indicates whether a transaction is approved by the Compliance Department. Possible values:
approved
declined
pending
- complianceApproved string
Applicable only for withdrawal-type transactions.
Indicates whether a transaction is approved by the Compliance Department. Possible values:
approved
declined
pending
- liquidityAccount string
The number of a client account of the liquidity type.
- createdAt string
The date and time when a request was submitted.
- processedAt string
The date and time when a request was resolved.
- interact array
An array of string values specifying various data that is specific to a request type.
{
"id": 1,
"client": {
"clientId": 1,
"birthday": "2022-01-01T00:00:00+00:00",
"city": "New York",
"country": {
"countryId": 8,
"alpha2Code": "US",
"alpha3Code": "USA",
"countryName": "United States",
"numericCode": "840"
},
"company": {
"fullName": "Full company name",
"shortName": "Short company name"
},
"email": "foo@bar.com",
"internalType": "default",
"firstName": "Mary",
"lastName": "Smith",
"middleName": "Jane",
"name": "Mary Jane Smith",
"nickname": "Voronov",
"locale": "ja_JP",
"manager": {
"id": 1,
"officeId": 1,
"enabled": false,
"email": "foo@bar.com",
"name": "John Smith",
"title": "mr.",
"createTime": "2022-01-01T00:00:00+00:00"
},
"phone": "+7 999 200 00 00",
"riskLevel": "low",
"status": "active",
"tags": [
"tag 1",
"tag 2"
],
"type": {
"id": 1,
"name": "Individual"
},
"verificationLevel": {
"id": 1,
"name": "Level 1"
},
"loggedAt": "2022-01-01T00:00:00+00:00",
"createTime": "2022-01-01T00:00:00+00:00"
},
"ip": "127.0 0.1",
"type": "Verification",
"resolution": {
"id": 1,
"enabled": true,
"name": "Document rejected",
"type": {
"id": 1,
"enabled": true,
"name": "PassBase Resolution Type"
}
},
"personalAccounts": [
{
"accountId": 6,
"accountNumber": "3"
},
{
"accountId": 6,
"accountNumber": "3"
}
],
"tradeAccounts": [
{
"accountId": 6,
"accountNumber": "3"
},
{
"accountId": 6,
"accountNumber": "3"
}
],
"accountId": 1,
"amount": "1.000000000000000000",
"method": "localizedCaption",
"transactionId": 1,
"currency": "USD",
"dealingApproved": "approved",
"complianceApproved": "approved",
"liquidityAccount": "4423423",
"createdAt": "2022-01-01T00:00:00+00:00",
"processedAt": "2022-01-01T00:00:00+00:00",
"interact": [
"String 1",
"String 2"
]
}
The Resolution object (Back Office)
This object provides the following data about a request resolution:
- id integer
The resolution identifier.
- enabled boolean
If
true
, a resolution can be used to resolve client requests; otherwise,false
.- name string
The resolution name.
- type object
The details about a resolution type. See the Resolution Type object to learn more.
{
"id": 1,
"enabled": true,
"name": "Document rejected",
"type": {
"id": 1,
"enabled": true,
"name": "SNS Resolution Type"
}
The Resolution Type object (Back Office)
This object provides the following data about a resolution type:
- id integer
The resolution type identifier.
- enabled boolean
If
true
, resolutions can be assigned this type; otherwise,false
.- name string
The resolution type name.
{
"id": 1,
"enabled": true,
"name": "SNS Resolution Type"
}
The Security Policy object (Back Office)
This object provides the following data about a security policy:
- id integer
The security policy identifier.
- active boolean
If
true
, a security policy is enabled; otherwise,false
.- comment string
The optional internal comment added to a security policy.
- ip string
The IP address to which a security policy is applied.
- permission string
The access permission. Possible values:
allow
тАФ indicates that access from a specified IP address is allowed.deny
тАФ indicates that access from a specified IP address is prohibited.
- rout string
The URL of a resource to which access from a specified IP address is either allowed or prohibited.
- createTime string
The date and time when a security policy was created.
{
"id": 1,
"active": true,
"comment": "Internal route for authenticating clients on platforms",
"ip": "127.0 0.1",
"permission": "allow",
"route": "platform_proxy",
"createTime": "2022-01-01T00:00:00+00:00"
}
The Transaction object (Back Office)
This object provides the following data about a transaction:
- clientId integer
The client identifier.
- transactionId integer
The transaction identifier.
- creditDetails object
The details about the credit side of a transaction:
Show object fields- account object
The details about the account to which funds were credited. See the Account object to learn more.
- amount string
The amount credited.
- commission string
The transaction fee amount.
- currency object
The details about a credit currency. See the Currency object to learn more.
- debitDetails object
The details about the debit side of a transaction:
Show object fields- account object
The details about the account from which funds were debited. See the Account object to learn more.
- amount string
The amount debited.
- commission string
The transaction fee amount.
- currency object
The details about a debit currency. See the Currency object to learn more.
- foreignExchangeRate string
The exchange rate at which a transaction was made.
- meta object
Applicable only for deposit- and withdrawal-type transactions.
For deposits, this object includes the
verificationStatus
field.For withdrawals, this object includes the
complianceStatus
anddealingStatus
fields.Show object fields- blockchainTransaction string
The transaction identifier in a blockchain.
- comment string
The text of an internal comment to a transaction.
- complianceStatus string
Applicable only for withdrawal-type transactions.
Indicates whether a transaction is approved by the Compliance Department. Possible values:
approved
declined
pending
- dealingStatus string
Applicable only for withdrawal-type transactions.
Indicates whether a transaction is approved by the Dealing Department. Possible values:
approved
declined
pending
- invoice string
The invoice identifier.
- providerCommission string
The commission amount charged by a payment system.
- providerOptions array
An array of key-value pairs providing details specific to a payment system used to make a transaction.
- verificationStatus string
Applicable only for deposit-type transactions.
Indicates whether a transaction is approved by the Financial Department. Possible values:
approved
new
pending
- createTime string
The date and time when a transaction was made.
- invoiceTime string
The date and time when an invoice was sent.
- updateTime string
The date and time when the transaction status has last been updated.
- method object
The details about a method by which the transaction was made.
Show object fields- id integer
The method identifier.
- name string
The localized method name.
- application object
The details about a transaction request.
Show object fields- id integer
The identifier of a client request.
- status string
The client request status. Possible values:
approved
inProgress
new
pending
rejected
- type string
The client request type. Possible values:
account
address
archive
clientType
deposit
document
external
investment
partner
profile
transfer
verification
withdrawal
- createTime string
The date and time when a client request was made.
- processedTime string
The date and time when a client request was processed.
- resolution object
Applicable only in the case of a failure.
Show object fields- id integer
The identifier of a particular failure.
- name string
The localized description of a failure.
- status string
The current transaction status. Possible values:
cancelled
done
failed
hold
holdFailed
inProgress
new
partial
pending
rejected
refund
refundFailed
trade
Transactions with the
new
status are not returned.- type string
The transaction type. Possible values:
deposit
exchange
external
partner
transfer
withdrawal
- createTime string
The date and time when a transaction was created in B2Core.
- updateTime string
The date and time when the transaction status has last been updated.
- processedTime string
The date and time when a transaction was processed.
{
"clientId": 1,
"transactionId": 1,
"creditDetails": {
"account": {
"accountId": 1,
"accountNumber": "12345678",
"clientId": 1,
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"group": {
"id": 1,
"name": "Fiat",
},
"name": "USD",
"permissions": [
"deposit",
"trade",
"withdrawal"
],
"platform": {
"id": 1,
"name": "MetaTrader 5"
},
"product": {
"id": 1,
"name": "Forex"
},
"statement": {
"availableBalance": "1.000000000000000000",
"currentBalance": "1.000000000000000000",
"credit": "1.000000000000000000",
"equity": "1.000000000000000000",
"freeMargin": "1.000000000000000000",
"hold": "1.000000000000000000",
"margin": "1.000000000000000000",
"marginLevel": "1.000000000000000000",
"pnl": "1.000000000000000000",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"type": "trade",
"archiveTime": "2022-01-01T00:00:00+00:00",
"createTime": "2022-01-01T00:00:00+00:00"
},
"amount": "1.000000000000000000",
"commission": "1.000000000000000000",
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
}
},
"debitDetails": {
"account": {
"accountId": 1,
"accountNumber": "12345678",
"clientId": 1,
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"group": {
"id": 1,
"name": "Fiat"
},
"name": "USD",
"permissions": [
"deposit",
"trade",
"withdrawal"
],
"platform": {
"id": 1,
"name": "MetaTrader 5"
},
"product": {
"id": 1,
"name": "Forex"
},
"statement": {
"availableBalance": "1.000000000000000000",
"currentBalance": "1.000000000000000000",
"credit": "1.000000000000000000",
"equity": "1.000000000000000000",
"freeMargin": "1.000000000000000000",
"hold": "1.000000000000000000",
"margin": "1.000000000000000000",
"marginLevel": "1.000000000000000000",
"pnl": "1.000000000000000000",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"type": "trade",
"archiveTime": "2022-01-01T00:00:00+00:00",
"createTime": "2022-01-01T00:00:00+00:00"
},
"amount": "1.000000000000000000",
"commission": "1.000000000000000000",
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
}
},
"foreignExchangeRate": "1.000000000000000000",
"meta": {
"blockchainTransaction": "d7f9ac778163a8d7be84db00b5448464",
"comment": "Optional comment",
"invoice": "gNqHzjlhrw",
"providerCommission": "1.000000000000000000",
"providerOptions": [
{
"key": "beneficiary_name",
"value": "John Smith"
},
{
"key": "bank_account_number",
"value": 12345678
},
{
"key": "bank_name",
"value": "Citibank"
},
{
"key": "bank_address",
"value": "388 Greenwich Street, New York, NY 10013, USA"
}
],
"verificationStatus": "approved",
"createTime": "2022-01-01T00:00:00+00:00",
"invoiceTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"method": {
"id": 1,
"name": "PayPal"
},
"application": {
"id": 1,
"status": "approved",
"type": "withdrawal",
"createTime": "2022-01-01T00:00:00+00:00",
"processedTime": "2022-01-01T00:00:00+00:00"
},
"resolution": {
"id": 1,
"name": "Failure description"
},
"status": "inProgress",
"type": "withdrawal",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00",
"processedTime": "2022-01-01T00:00:00+00:00"
}
The Transaction Type (Back Office)
This object provides the following data about a transaction type:
- id integer
The transaction type identifier.
- name string
The transaction type name.
- caption string
The transaction type description.
- options array
An array of objects indicating details specific to a transaction type (such as transaction statuses or restrictions applied to a transaction type).
- class string
The name of a class to which a transaction type is assigned.
- enabled boolean
If
true
, clients are allowed to make transactions of this type; otherwise,false
.
{
"id": 2,
"name": "transfer",
"caption": "transfer",
"options": [
"operation_status": [
1,
2,
3
],
"application": "2",
"operation_restrictions": [
1,
2,
3
]
],
"class": null,
"enabled": true
}
The Transaction Monitoring object (Back Office)
This object provides the following data about transaction monitoring results:
- id integer
The identifier of a transaction monitoring request.
- clientId string
The client identifier.
- transactionId string
The transaction identifier.
- transactionMeta object
This object provides the following data:
Show object fields- blockchainTransaction string
The transaction identifier in a blockchain.
- comment string
The text of an internal comment to a transaction.
- invoice string
The invoice identifier.
- providerCommission string
The commission amount charged by a payment system.
- providerOptions array
An array of key-value pairs providing details specific to a payment system used to make a transaction.
- verificationStatus string
Applicable only for deposit-type transactions.
Indicates whether a transaction is approved by the Financial Department. Possible values:
approved
new
pending
- createTime string
The date and time when a transaction was made.
- invoiceTime string
The date and time when an invoice was sent.
- updateTime string
The date and time when a transaction status has last been updated.
- direction string
The transaction type. Possible values:
deposit
withraw
- reviewResult string
The transaction monitoring result returned by a provider. Possible values:
red
green
error
- riskScore string
The transaction risk score calculated by a provider.
- provider
The name of a method by which a transaction was made.
- createTime string
The date and time when a transaction was created in B2Core.
- updateTime string
The date and time when a transaction has last been updated.
{
"id": 1,
"clientId": 1,
"transactionId": 1,
"transactionMeta": {
"blockchainTransaction": "d7f9ac778163a8d7be84db00b5448464",
"comment": "Optional comment",
"invoice": "gNqHzjlhrw",
"providerCommission": "1.000000000000000000",
"providerOptions": [
{
"key": "beneficiary_name",
"value": "John Smith"
},
{
"key": "bank_account_number",
"value": 12345678
},
{
"key": "bank_name",
"value": "Citibank"
},
{
"key": "bank_address",
"value": "388 Greenwich Street, New York, NY 10013, USA"
}
],
"verificationStatus": "approved",
"createTime": "2022-01-01T00:00:00+00:00",
"invoiceTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"direction": "deposit",
"reviewStatus": "red",
"riskScore": 1.00001,
"provider": "manual",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00",
"data": {}
}
The User object (Back Office)
This object provides the following data about a user registered in the Back Office:
- id integer
The user identifier.
- name string
The user name.
- email string
The user email address.
- phone string
The user phone number.
- active boolean
If
true
, a user profile is active; otherwise,false
.- tfa boolean
If
true
, two-factor authentication is enabled for a user; otherwise,false
.- ipWhitelist array
An array of string values indicating the user IP addresses included in a safelist.
- groups array
An array of objects indicating the user groups to which a user is added.
Show object fields- id integer
The identifier of a user group.
- name string
The name of a user group.
- clientTags array
An array of objects indicating the tags assigned to a user.
The following data is provided about each client tag:
Show object fields- id integer
The identifier of a client tag.
- name string
The title of a client tag.
- canViewMaskedData boolean
If
true
, a user is allowed to view sensitive information in the Back Office; otherwise,false
.- sendNotify boolean
If
true
, an email is sent to the specified user email notifying the user that their profile was created in the Back Office; otherwise,false
.
{
"id": 1,
"name": "Mary",
"email": "foo@bar.com",
"phone": "+18043257762",
"active": true,
"tfa": true,
"ipWhitelist": [
"79.24.241.198",
"20.65.174.119"
],
"groups": [
{
"id": 1,
"name": "Administrators"
}
],
"clientTags": [
{
"id": 1,
"name": "my_tag"
}
],
"canViewMaskedData": true
}
The User Group object (Back Office)
This object provides the following data about a user group:
- id integer
The identifier of a user group.
- name string
The name of a user group.
- permissions array
An array of string values specifying the user group permissions. An empty array indicates that no permissions are assigned to a group.
{
"id": 1,
"name": "Administrators",
"permissions": [
"accounts.create",
"accounts.read"
]
}
The Statement object (Back Office)
This object provides the following data about a client account statement:
- availableBalance string
The free funds available on an account.
- currentBalance string
The current balance on an account.
- credit string
The amount of credit funds on an account.
- equity string
The equity of an account.
- freeMargin string
The account free margin.
- hold string
The amount of funds currently on hold for an account.
- margin string
The account margin.
- marginLevel string
The account margin level, which is a ratio of equity to margin.
- pnl string
The profit-loss value calculated for an account.
- updateTime string
The date and time when an account statement has last been updated.
{
"availableBalance": "1.000000000000000000",
"currentBalance": "1.000000000000000000",
"credit": "1.000000000000000000",
"equity": "1.000000000000000000",
"freeMargin": "1.000000000000000000",
"hold": "1.000000000000000000",
"margin": "1.000000000000000000",
"marginLevel": "1.000000000000000000",
"pnl": "1.000000000000000000",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Tag object (Back Office)
This object provides the following data about a client tag:
- id integer
The tag identifier.
- name string
The name assigned to a tag.
{
"id": 1,
"name": "John's clients"
}
The Verification Level object (Back Office)
This object provides the following data about a verification level:
- id integer
The identifier of a verification level.
- name string
The name of a verification level.
- description string
The verification level description displayed in the B2Core UI.
- mailDescription string
The email text.
- nextLevel integer
The identifier of a next verification level that clients can be granted after obtaining this verification level.
- roleId integer
The identifier of a permission set specifying which actions clients are allowed to perform in the B2Core UI after obtaining this verification level.
- wizard string
The name of a wizard used to run a verification procedure in the B2Core UI.
- default boolean
If
true
, a verification level is the default one and assigned to all newly registered clients; otherwise,false
.- visible boolean
If
true
, a verification level is displayed to clients in the B2Core UI; otherwise,false
.- sustainable boolean
This field value must be set to
false
.- options array
An array of string values specifying the groups which include the documents that must be submitted by clients.
{
"id": 1,
"name": "Level 0",
"description": "Level description",
"mailDescription": "Mail description",
"nextLevel": 2,
"roleId": 1,
"wizard": "DocumentsWizard",
"default": true,
"visible": true,
"sustainable": false,
"options": [
"corporate",
"Funds Proof"
]
}
The Widget object (Back Office)
This object provides the following data about a widget:
- id integer
The widget identifier.
- caption string
The widget name displayed in the B2Core UI.
- name string
The widget name used in the Back Office.
- sort integer
The index indicating a sorting order for widgets in the B2Core UI.
- delete boolean
If
true
, the Close (тип) button is displayed on a widget, allowing clients to hide it from the dashboard in the B2Core UI; otherwise,false
.- showByDefault boolean
If
true
, a widget is displayed on the dashboard in the B2Core UI by default; otherwise,false
.- width integer
The widget width, in points.
- height integer
The widget height, in points.
- positionX integer
The
X
coordinate of the upper-right corner of a widget.- positionY integer
The
Y
coordinate of the upper-right corner of a widget.- entity object
The details about tickers added to the Ticker Widget.
Show object fields- id integer
The ticker identifier.
- platform string
The trading platform for which data is displayed.
- source string
The URL of a data source streaming data for updating tickers.
- symbols array
An array of objects providing data about ticker symbols.
Show object fields- id integer
The ticker symbol identifier.
- show boolean
If
true
, a ticker symbol is displayed in a widget by default.If
false
, a ticker symbol can be selected from a list and added to a widget.
- symbol string
The currency pair symbol (such as
BTCUSD
).
{
"id": 1,
"caption": "Ticker Widget",
"name": "TickerWidget",
"sort": 1,
"delete": true,
"showByDefault": true,
"width": 1,
"height": 1,
"positionX": 1,
"positionY": 1,
"entity": {
"id": 1,
"platform": "mt4",
"source": "https://example.website.org",
"symbols": [
{
"id": 1,
"show": true,
"symbol": "EURUSD"
},
{
"id": 2,
"show": true,
"symbol": "BTCUSD"
}
]
}
}
The Withdrawal Template object (Back Office)
This object provides the following data about a withdrawal template:
- id integer
The withdrawal template identifier.
- name string
The name of a withdrawal template.
- data object
The withdrawal data.
Show object fields- account_id integer
The identifier of an account from which funds are to be withdrawn.
- amount string
The withdrawal amount.
- currency_code string
The numeric code of a currency in which a withdrawal transaction is made.
- method_id integer
The identifier of a withdrawal method.
- groupName string
The name of a group in which a withdrawal method is included.
- data object
The data specific to a withdrawal method.
Show object fields- wallet_address string
The address of a wallet to which funds are to be withdrawn.
- comment string
The optional comment to a withdrawal transaction.
- clientId integer
The client identifier.
- createTime string
The date and time when a withdrawal template was created.
- updateTime string
The date and time when a withdrawal template was last updated.
{
"id": 1,
"name": "My withdrawal template",
"data": {
"account_id": 275,
"amount": "0.0001",
"currency_code": 1000,
"method_id": 1,
"groupName": "Crypto",
"data": {
"wallet_address": "2NGWBeEcAau98dLd4CPyXfFTJCUViEXo81f",
"comment": "Withdrawal via B2BinPay"
}
},
"clientId": 1,
"createTime": "2022-06-21T05:35:19+00:00",
"updateTime": "2022-06-21T05:35:19+00:00"
}