Back Office API objects
In this section, you can learn about the objects used in the Back Office API:
The Answer Option object (Back Office)
This object provides the following data about an answer option added for a client test’s question:
- id integer
The identifier of an answer option.
- isVisible boolean
If
true, an answer option is displayed to clients when passing a test in the B2Core UI; otherwise,false.- isCorrect boolean
If
true, an answer option is the correct one; otherwise,false.- text string or null
The text of an answer option.
- priority integer
The priority index assigned to an answer option.
- resources object
An array of resource objects specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when an answer option was added.
- updateTime string or null
The date and time when an answer was last modified.
{
"id": 1,
"isVisible": true,
"isCorrect": true,
"text": "The text of an answer option",
"priority": 1,
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
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 or null
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:
depositenabledexchangetradetransferDeposittransferWithdrawalvisiblewithdrawal
- 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 or null
The details about an account statement. See the Statement object to learn more.
- type string or null
The account type. Possible values:
personaltradedemopartnerliquidityexchangeexternalsystem
- archiveTime string or null
The date and time when an account was archived.
- createTime string or null
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:
residentialbillingmailing
- clientId integer
The client identifier.
- createTime string or null
The date and time when a client address was added.
- updateTime string or null
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 Antifraud Procedure object (Back Office)
This object provides the following data about an antifraud procedure:
- id integer
The identifier of a procedure.
- priority integer or null
The priority index assigned to a procedure.
- notificationType object
The details about an event type that triggered the notification:
Show object fields- caption string
The event type description.
- name string
The event type name.
- settings object
The settings specific to an event type.
- detailView string
The identifier of the permission that is required to view the details of the event type.
- whitelistView string
The identifier of the permission that is required to view whitelisted IP addresses.
- responsibilities array
An array of integer values indicating the Back Office users who are notified about the occurred event type and responsible for further processing of an antifraud procedure.
- caption string
The procedure description.
- createTime string or null
The date and time when a procedure was configured.
{
"id": 1,
"priority": 1,
"notificationType": {
"caption": "Identical IP Used By Multiple Accounts",
"name": "identical_ip",
"settings": {
"": [
{
"class": "RabbitCMS\\Forms\\Controls\\Input",
"name": "daysForIpCheck",
"rule": [
"integer"
],
"classes": [],
"value": null,
"label": "Same IP login days (1day: 24h)",
"messages": []
},
{
"attributes": {
"multiple": "true"
},
"classes": [
"select2"
],
"items": {
"1": "Level 0",
"2": "Level 1",
"3": "Level 2",
"4": "Corporate",
"5": "Corporate next"
},
"class": "RabbitCMS\\Forms\\Controls\\Select",
"name": "verificationLevelMonitorForIpCheck",
"rule": null,
"value": null,
"label": "Verification Level Monitor",
"messages": []
}
]
},
"detailView": "tca-backend::antifraud.notifications.blocks.details.type_identical_ip",
"whitelistView": "tca-backend::antifraud.settings.blocks.whitelist_notifications"
},
"responsibilities": [
1
],
"caption": "IP",
"createTime": "2021-10-25T09:00:21+00:00"
}
The Bonus object (Back Office)
This object provides the following data about a bonus:
- id integer
The bonus identifier.
- clientId integer
The identifier of a client who receives the bonus.
- clientName string
The name of a client who receives the bonus.
- clientEmail string
The email address of a client who receives the bonus.
- account string
The number of a client trading account to which the bonus is credited.
- email string or null
The email address of a client who receives the bonus.
- amount string
The bonus amount that can be awarded to clients under a bonus program.
- volumeComplete string
The traded volume by the moment of the bonus expiration.
- temporaryBonus string or null
The name of a temporary bonus program.
- currencyExp integer
The bonus currency.
- fictiveVolumeComplete string
The volume that must be traded by a client to receive a bonus. Specifying the updated volume reactivates the expired bonus.
- lifetime integer
The number of days after which an activated bonus expires.
- enableAutoCredit boolean
If
true, bonuses from all bonus programs (if more than one is enabled for a client at the same time) are credited to the client’s trading account immediately.If
false, bonuses from different bonus programs (if more than one is enabled for a client at the same time) are credited to the client’s trading accounts one after another. Only after a bonus from the first bonus program is processed and credited, a bonus from the second bonus program is credited to a client.- scalpingThreshold integer
The minimum time interval (in seconds) during which a position must be opened.
- enableTrade boolean
If
true, trading with bonus funds is immediately allowed after depositing funds to a trading account; otherwise,false.- disabledGroups array
An array of string values specifying the instruments for which bonuses aren’t awarded.
- dynamicLots string
The required amount of traded volume for bonus crediting.
- status string
The bonus status. Possible values:
queuedactivependingprocessingcompletedonCompletingexpirederrorhold
- activatedAt string or null
The date and time when a bonus was credited.
- createdAt string or null
The date and time when a bonus was allocated.
- updatedAt string or null
The date and time when a bonus was last updated.
{
"id": 1,
"clientId": 1,
"clientName": "Client Name",
"clientEmail": "email@example.com",
"account": "12457877",
"email": "email@example.com",
"amount": "100.000",
"volumeComplete": "0.00",
"temporaryBonus": null,
"currencyExp": 2,
"fictiveVolumeComplete": "123.000",
"lifetime": 30,
"enableAutoCredit": true,
"scalpingThreshold": 1,
"enableTrade": true,
"disabledGroups": [
"EURJPY"
],
"dynamicLots": "1.000",
"status": "Pending",
"activatedAt": null,
"createdAt": "2022-01-01T00:00:00+00:00",
"updatedAt": "2022-01-01T00:00:00+00:00"
}
The Bonus Preset object (Back Office)
This object provides the following data about a bonus preset:
- id integer
The preset identifier.
- platformId integer
The identifier of a trading platform to which a bonus preset applies.
- name string
The name of a preset.
- default boolean
If
true, a bonus preset is used as the default for all clients; oterwise,false.- lifetime integer
The number of days after which an activated bonus expires.
- dynamicLots string
The required amount of traded volume for bonus crediting.
- enableAutoCredit boolean
If
true, bonuses from all bonus programs (if more than one is enabled for a client at the same time) are credited to the client’s trading account immediately.If
false, bonuses from different bonus programs (if more than one is enabled for a client at the same time) are credited to the client’s trading accounts one after another. Only after a bonus from the first bonus program is processed and credited, a bonus from the second bonus program is credited to a client.- scalpingThreshold integer
The minimum time interval (in seconds) during which a position must be opened.
- disabledGroups array
An array of string values specifying the instruments for which bonuses aren’t awarded.
- enableTrade boolean
If
true, trading with bonus funds is immediately allowed after depositing funds to a trading account; otherwise,false.- createdAt string or null
The date and time when a bonus was allocated.
- updatedAt string or null
The date and time when a bonus was last updated.
{
"id": 1,
"platform": "PresetMT5",
"name": "MT5",
"default": true,
"lifetime": 10,
"dynamicLots": "1.000",
"enableAutoCredit": true,
"scalpingThreshold": 1,
"disabledGroups": [
"EURJPY"
],
"enableTrade": true,
"createdAt": "2022-01-01T00:00:00+00:00",
"updatedAt": "2022-01-01T00:00:00+00:00"
}
The Calendar Event object (Back Office)
This object provides the following data about a calendar event:
- id string
The calendar event identifier.
- name string
The event name.
- description string
The event description.
- timezone string
The time zone in which an event is scheduled.
- startDate string or null
The date and time when the event starts.
- endDate string or null
The date and time when the event ends.
- notifications array
An array of string values specifying the date and time of reminder notifications. The notifications are sent to the email addresses of the event recipients at a specified date and time before the event starts.
- recipients array
An array of string values specifying the email addresses of the Back Office users added to an event.
Show object fields- email string
The email address of a Back Office user.
{
"id": "36f59381-5b54-48bd-a0c7-3b908c476732",
"name": "Quarterly report",
"description": "Quarterly report's due date is March 31",
"timezone": "Africa/Abidjan",
"startDate": "2022-01-01T00:00:00+00:00",
"endDate": "2022-01-01T00:00:00+00:00",
"notifications": [
{
"date": "2022-01-01T00:00:00+00:00"
},
{
"date": "2022-01-01T00:00:00+00:00"
}
],
"recipients": [
{
"email": "user1@example.com"
},
{
"email": "user2@example.com"
}
]
}
The Client object (Back Office)
This object provides the following data about a client:
- analytics object
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
utmobject 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.
- accounts object
The details about the client’s accounts. See the Account object to learn more.
- birthday string or null
The client’s date of birth.
- city string or null
The client’s city.
- country object or null
The details about a client’s country of residence. See the Country object to learn more.
- company object or null
The details about a client company.
Show object fields- fullName string or null
The full company name.
- shortName string or null
The short company name.
- email string
The client email address.
- internalType string
The internal category assigned to a client. Possible values:
agentb2bdefaultdemoexchange
- firstName string or null
The client first name.
- lastName string or null
The client last name.
- middleName string or null
The client middle name.
- name string
The client full name.
- nickname string or null
The client nickname.
- locale string or null
The client locale.
- manager object or null
The details about a manager to whom a client is assigned.
Show object fields- id integer
The client manager identifier.
- officeId integer or null
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.).- phone string
The client manager phone number.
- resources object
An array of resource objects specifying localized strings for user interface pages displayed to a client.
- createTime string or null
The date and time when a client manager was registered.
- phone string or null
The client phone number.
- riskLevel string or null
The risk level assigned to a client. Possible values:
lowmiddlehigh
- status string
The status of a client profile. Possible values:
activebanneddeletedinactive
- tags array
An array of string values identifying the tags assigned to a client.
- type object or null
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 or null
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 or null
The date and time when a client last signed in.
- createTime string or null
The date and time when a client was registered.
- updateTime string or null
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 Client Folder object (Back Office)
This object provides the following data about a client folder:
- id string
The folder identifier.
- name string or null
The name of a folder.
- createTime string or null
The date and time when a folder was created.
- updateTime string or null
The date and time when a folder was last updated.
- subdirectories array or null
An array of objects providing details about nested folders.
Show object fields- id string
The identifier of a nested folder.
- name string or null
The name of a nested folder.
- createTime string or null
The date and time when a nested folder was created.
- updateTime string or null
The date and time when a nested folder was last updated.
- subdirectories array or null
An array of objects providing details about nested folders.
- breadcrumbs array
An array of objects providing details about the breadcrumb trails that are used for navigation through the folders.
Show object fields- id string
The identifier of a breadcrumb item.
- name string
The name assigned to a breadcrumb item.
{
"id": "0829b5fa-3118-48ff-93d2-16cf72fff588",
"name": "General",
"createTime": "2022-07-19T07:13:37+00:00",
"updateTime": "2023-03-24T09:42:10+00:00",
"subdirectories": [
{
"id": "f47afbb6-2889-4c25-82cb-aec60ba08aa4",
"name": "Documents",
"createTime": "2022-08-29T08:19:08+00:00",
"updateTime": "2023-03-24T09:42:10+00:00",
"subdirectories": [],
"breadcrumbs": [
{
"id": "0829b5fa-3118-48ff-93d2-16cf72fff588",
"name": "General"
}
]
}
],
"breadcrumbs": []
}
The Client Limits object (Back Office)
This object provides the following data about the limits to the number of live and demo trading accounts that can be opened by a client:
- maxDemoTradingAccounts string or null
The maximum number of demo trading accounts.
- maxLiveTradingAccounts integer or null
The maximum number of live trading accounts.
{
"maxDemoTradingAccounts": null,
"maxLiveTradingAccounts": 5
}
The Client Manager object (Back Office)
This object provides the following data about a manager to which clients can be assigned:
- id integer
The manager identifier.
- officeId integer or null
The identifier of a manager office.
- isEnabled boolean
If
true, a manager profile is enabled; otherwise,false.- email string or null
The manager email address.
- name string or null
The manager name.
- title string or null
The title used with a manager name (such as
Mr.orMs.).- phone string or null
The manager phone number.
- resources object
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
- createTime string or null
The date and time when a manager profile was created.
{
"id": 1,
"officeId": null,
"isEnabled": true,
"email": "jsmith@example.com",
"name": "Jane Smith",
"title": "Ms.",
"phone": "+995577755422",
"resources": [
{
"key": "caption",
"locale": "en_US",
"value": "value"
},
{
"key": "caption",
"locale": "ar_AE",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00"
}
The Client Settings object (Back Office)
This object provides the following data about client settings:
- settings object
The client settings details:
- locale string
The locale identifier (such as
en_US) indicating a preferred communication language for a client.- applicationColor string
The color used to highlight client requests in the Back Office.
{
"settings": {
"locale": "en_US",
"applicationColor": "#225577",
"commonTheme": "dark-theme"
}
}
The Client Test object (Back Office)
This object provides the following data about a client test:
- id string
The identifier of a test.
- caption string
The test’s title displayed to clients in the B2Core UI.
- isVisible boolean
If
true, a test is displayed to clients in the B2Core UI; otherwise,false.- details string or null
The test’s description or any other helpful information that clients should know before they start passing the test.
- resources object
An array of resource objects specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when a test was created.
- updateTime string or null
The date and time when a test was last modified.
{
"id": 1,
"caption": "Discover Your Trading Style",
"isVisible": true,
"details": "Takes just a couple of minutes",
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "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 Completed Test object (Back Office)
This object provides the following data about a completed client test:
- id integer
The identifier of an attempt that was made by a client to pass a test.
- clientId integer
The client identifier.
- quizId integer
The identifier of a test.
- status
The test status. Possible values:
COMPLETED— a test was successfully passed by a clientFAILED— a test was failedWAITING_CONFIRMATION— a test has been completed by a client and its results await confirmation by the admin user
- answers object
An array of objects providing the data about the answers given to test’s questions by a client. See the Test’s Question and Answer Option objects to learn more.
{
"id": "1",
"clientId": "1",
"quizId": "1",
"status": "FAILED",
"answers": [
{
"id": 1,
"question": {
"id": 1,
"quizId": 1,
"question": "The text of the 1st question",
"isVisible": true,
"category": "General questions",
"type": "closed",
"priority": "1",
"isMultipleChoices": "true",
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"answer": {
"id": 1,
"isVisible": true,
"isCorrect": false,
"text": "The text of an answer option",
"priority": "1",
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"text": "The answer text provided by a client",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
{
"id": 2,
"question": {
"id": 2,
"quizId": 1,
"question": "The text of the 2nd question",
"isVisible": true,
"category": "General questions",
"type": "poll",
"priority": "2",
"isMultipleChoices": "true",
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"answer": {
"id": 2,
"isVisible": true,
"isCorrect": true,
"text": "The text of an answer option",
"priority": 1,
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"text": "The answer test provided by a client",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
]
}
The SMS Provider object (Back Office)
This object provides the following data about an SMS provider:
- id integer
The confirmation provider identifier.
- name string
The name assigned to an SMS provider configuration.
- caption string
The name of an SMS provider configuration, used in the Back Office.
- provider string
The name of an SMS provider.
- isEnabled boolean
If
true, a provider is enabled and used to deliver SMS to your clients; otherwise,false.- priority integer
The priority index assigned to a confirmation provider.
- options object
An array of objects indicating details specific to an SMS provider.
- resources object
An array of resource objects specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when an SMS provider was configured.
- updateTime string or null
The date and time when an SMS provider was last updated.
{
"id": 1,
"name": "twilio_sms",
"caption": "Twilio SMS",
"provider": "Twilio",
"isEnabled": true,
"priority": 1,
"options": {},
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Confirmation Template object (Back Office)
This object provides the following data about a confirmation template:
- id integer
The identifier of a confirmation template.
- name string
The name of a confirmation template.
- caption string
The description of a confirmation template.
- template string
The text included in a template.
- isEnabled boolean
If
true, a template is enabled; otherwise,false.- resources object
An array of resource objects specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when a confirmation template was created.
- updateTime string or null
The date and time when a confirmation template was last updated.
{
"id": 1,
"name": "default",
"caption": "Twilio template",
"template": "The verification code is %CODE%",
"isEnabled": true,
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
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 or null
The localized country name.
- callingCode string
The international country dialing code.
- numericCode string
A numeric country code (as per ISO 3166).
- currency object or null
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 or null
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 or null
The date and time when a currency was added to the Back Office.
- updateTime string or null
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 or null
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 or null
The date and time when a currency pair was added.
- updateTime string or null
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 Deposit Commission (Back Office)
This object provides the following data about commissions configured for a deposit method:
- id integer
The commission identifier.
- currency object
The details about a currency in which a commission is charged.
Show object fields- alphabeticCode string
The alphabetic code of a currency (such as
USD).- 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
840).
- type string
The commission type.
- recipientType string
Indicates whether a commission is charged by a broker or payment system. Possible values:
vendor— a commission is charged by a brokerprovider— a commission is charged by a payment system
- percent string
The percentage of a deposit amount charged as a commission.
- fix string
The fixed commission amount.
- min string
The minimum commission amount.
- max string
The maximum commission amount.
{
"id": 1,
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"type": "default",
"recipientType": "vendor",
"percent": "5.00",
"fix": "10.00",
"min": "15.00",
"max": "20.00"
}
The Deposit Currency object (Back Office)
This object provides the following data about a currency added to a deposit method:
- id integer
The identifier of a deposit currency.
- currency object
The details about a deposit currency.
Show object fields- alphabeticCode string
The alphabetic code of a currency (such as
BTC).- 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
1000).
- caption string
The currency name displayed to clients in the B2Core UI.
- type string
The type of a currency added to a deposit method. Possible values:
tradersRoom— transaction currenciespaymentSystem— payment currencies
- isEnabled boolean
If
true, a currency is enabled for a deposit method; otherwise,false.- icon string or null
The filename of an image that is displayed as a deposit currency icon.
- min object
The data about the minimum amount that can be deposited in a currency.
Show object fields- value string
The minimum allowed deposit amount.
- scale integer
The number of decimal places displayed when representing the minimum amount in a currency.
- max object
The data about the maximum amount that can be deposited in a currency.
Show object fields- value string
The maximum allowed deposit amount.
- scale integer
The number of decimal places displayed when representing the maximum amount in a currency.
- blockExporter string or null
Applicable only for cryptocurrencies.
The cryptocurrency block explorer.
- blockchainCode integer or null
Applicable only for cryptocurrencies.
The currency code in a blockchain.
- blockchainAlpha string or null
Applicable only for cryptocurrencies.
The alphabetic code of a currency in a blockchain.
- createTime string
The date and time when a currency was added to a deposit method.
- updateTime string or null
The date and time when a currency was last modified.
{
"id": 1,
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"caption": "US Dollar",
"type": "tradersRoom",
"isEnabled": false,
"icon": "image.png",
"min": {
"value": "0.00",
"scale": 2
},
"max": {
"value": "0.00",
"scale": 2
},
"blockExporter": null,
"blockchainCode": null,
"blockchainAlpha": "null",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Deposit Group object (Back Office)
This object provides the following data about a deposit group:
- id integer
The deposit group identifier.
- description string
The deposit group description.
- caption string
The deposit group name displayed to clients in the B2Core UI.
- name string
The deposit group name used in the Back Office.
- icon string
The filename of an image that is displayed as a deposit group icon.
- priority integer
The priority index assigned to a deposit group.
- isEnabled boolean
If
true, a group is enabled; otherwise,false.- createTime string or null
The date and time when a deposit group was created.
- updateTime string or null
The date and time when a deposit group was last updated.
{
"id": 1,
"description": "Group description",
"caption": "crypto",
"name": "crypto",
"icon": "image.png",
"priority": 1,
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Deposit Method object (Back Office)
This object provides the following data about a deposit method:
- id integer
The deposit method identifier.
- name string
The name of a deposit method.
- isEnabled boolean
If
true, a method is enabled; otherwise,false.- groups array
An array of objects providing data about one or several groups in which a deposit method is included. See the Deposit Group object to learn more.
- caption string
The name of a deposit method displayed to clients in the B2Core UI.
- provider string
The name of a payment system used to make deposits.
- providerResultUrl string
The URL to which a callback notifying about changing a deposit transaction status is sent.
- providerSettings object
The settings specific to a payment provider that is used to make deposits.
- providerOptions object
The details about custom fields added to a deposit method configuration.
- libraryTimeToFund string
A hint displayed to clients in the B2Core UI about the period during which a deposit transaction is processed.
- precalculate boolean
If
true, the commission amount charged for depositing funds is calculated and displayed to a client in the B2Core UI; otherwise,false.- icon string
The filename of an image that is displayed as a deposit method icon.
- priority integer
The priority index assigned to a deposit method.
- ipWhiteList string or null
The list of allowed IP addresses.
- ratesProvider string or null
The name of an exchange rate provider associated with a deposit method.
- resources object
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when a deposit method was created.
- updateTime string or null
The date and time when a deposit method was last updated.
{
"id": 1,
"name": "B2BinPay",
"isEnabled": false,
"groups": [
{
"id": 1,
"description": "Group description",
"caption": "Crypto",
"name": "Crypto",
"icon": "image.png",
"priority": 1,
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
{
"id": 1,
"description": "Group description",
"caption": "Fiat",
"name": "Fiat",
"icon": "image.png",
"priority": 2,
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
],
"caption": "B2BinPay",
"provider": "B2BinPay",
"providerResultUrl": "www.example.com",
"providerSettings": {},
"providerOptions": {},
"libraryTimeToFund": "Depending on the blockchain",
"precalculate": true,
"icon": "image.png",
"priority": 1,
"ipWhitelist": "IP White List",
"ratesProvider": "B2BinPay2",
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "ja_JP",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Deposit Method Attribute object (Back Office)
This object provides the following data about an attribute added to a deposit method:
- id integer
The identifier of a deposit method attribute.
- caption string
The attribute name displayed in the B2Core UI.
- type string
The attribute type. Possible values:
selectAutocompleteinput
{
"id": "affca0b6-fc27-4a46-92e3-bb3fbd95cb99",
"caption": "Code",
"type": "selectAutocomplete"
}
The Deposit Method Restriction object (Back Office)
This object provides the following data about a deposit method restriction.
- id integer
The identifier of a deposit method restriction.
- isEnabled boolean
If
true, a deposit method restriction is enabled; otherwise,false.- name string
The deposit method restriction name. Possible values:
country— allows or forbids the use of a deposit method for specified countries.client_type— allows or forbids the use of a deposit method for specified client types.verification_level_restriction— allows or forbids the use of a deposit method for specified client verification levels.
- type string
A string value specifying the type of a deposit method restriction. Possible values:
Allow onlyDeny only
- rules array
An array of integer values identifying the countries, client types or client verification levels to which a restriction applies.
- createTime string
The date and time when a deposit method restriction was added.
- updateTime string
The date and time when a deposit method restriction was last modified.
{
"id": 432,
"isEnabled": true,
"name": "country",
"type": "Allow Only",
"rules": [
{
"key": 4,
"caption": "Afghanistan"
},
{
"key": 7,
"caption": "Norway"
}
],
"updateTime": "2023-03-24T12:07:29+00:00",
"createTime": "2023-03-24T12:07:29+00:00"
}
The File Storage object (Back Office)
This object provides the following data about a data storage system:
- id integer
The storage identifier.
- cacheTime integer
The period during which the cached data is valid.
- provider string
The name of the data storage system used to store the files uploaded to B2Core.
- options object
The connection settings specific to a data storage system.
- name string
The storage name used in the Back Office.
{
"id": 1,
"cacheTime": 0,
"provider": "local",
"options": {},
"name": "Documents"
}
The Key-Value Pair object (Back Office)
This object provides the following data about a key-value pair defined in the Back Office:
- id integer
The identifier of a key-value pair.
- isEnabled boolean
If
true, a key-value pair is enabled; otherwise,false.- tags array
An array of integer values specifying the tags assigned to a key-value pair. See the Key-Value Tag object to learn more.
- resources object
An array of resource objects specifying the localized strings for user interface pages displayed to a client.
- type string
The value type. Possible values:
stringhtmlmailurl
- key string
The name of a key.
- value string
The value assigned to a key.
- createTime string or null
The date and time when a key-value pair was created.
- updateTime string or null
The date and time when a key-value pair was last updated.
{
"id": 1,
"isEnabled": true,
"tags": [
{
"id": 1,
"caption": "email_config",
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
{
"id": 2,
"caption": "support",
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
],
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"type": 1,
"key": "support_email",
"value": "support@example.com",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Key-Value Tag object (Back Office)
This object provides the following data about a tag used to group the key-value pairs defined in the Back Office.
- id integer
The tag identifier.
- caption string
The tag name.
- isEnabled boolean
If
true, a tag is enabled; otherwise,false.- createTime string or null
The date and time when a tag was created.
- updateTime string or null
The date and time when a tag was last updated.
{
"id": 1,
"caption": "email_config",
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
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 or null
The device platform.
- userAgent string or null
The user agent data.
- webTimezone string or null
The time zone set in a client browser.
- hash string
The device hash.
- ipAddress string
The client IP address.
- lastSignIn string or null
The date and time when a client last signed in to the B2Core UI using this device.
- createTime string or null
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 or null
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 or null
The date and time when a document was submitted.
{
"id": 1,
"type": {
"id": 1,
"description": "The document types available for corporate clients",
"enabled": true,
"example": "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,
"resolution": null,
"comment": "The comment",
"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 Email Delivery Service object (Back Office)
This object provides the following data about an email delivery service connected to the Back Office:
- id integer
The identifier of the email delivery service.
- caption string
The email delivery service name used in the Back Office.
- platform string
The email delivery service name, such as SendGrid.
- isEnabled boolean
If
true, the email delivery service connection is enabled; otherwise,false.- createTime string
The date and time when the email delivery service was configured in the Back Office.
- options object
The details about the connection settings of the email delivery service.
- webhook string
The webhook URL.
{
"id": 1,
"caption": "SendGrid config",
"platform": "SendGrid",
"isEnabled": true,
"createTime": "2021-10-26T08:31:10+00:00",
"options": {
"sender_address": "user@example.com",
"sender_name": "The company name",
"api_key": "lA1bXX8O0UM01Tgt-w7cjxfxFu-qQfXm7ccnN5j8wG8"
},
"webhook": "https://host.name/api/v2/my/mail/subscriptions/webhooks/1"
}
The SMTP Service Provider object (Back Office)
This object provides the following data about an SMTP service provider connection:
- id integer
The identifier of a connection to an SMTP service provider.
- caption string
The name specified for a connection configuration in the Back Office.
- driver string
The driver used for sending emails (
smtp).- host string
The SMTP host
- port integer
The SMTP port number.
- username string
The SMTP username.
- password string
The SMTP password.
- sendFrom string
The sender’s email address displayed to your email recipients.
- sendFromName string
The sender’s name displayed to your email recipients (for example, this may be your company name).
- encryption string or null
The encryption protocol used to securely communicate with an SMTP service provider. Possible values:
tlsssl
- isEnabled integer
If
true, a connection to an SMTP service provider is enabled; otherwise,false.
{
"id": 1,
"caption": "My SMTP connection",
"driver": "smtp",
"host": "host.example.com",
"port": 25,
"username": "User",
"password": "Password",
"sendFrom": "user@example.com",
"sendFromName": "Company name",
"encryption": "ssl",
"isEnabled": false
}
The Notification Type object (Back Office)
This object provides the following data about a notification type:
- id integer
The notification type’s identifier.
- name string
The name of the notification type.
- caption string
The caption of the notification type.
- isEnabled boolean
If
true, the notification type is enabled and can be used to deliver notifications; otherwise,false.- createTime string
The date and time when the notification type was configured.
{
"id": 1,
"name": "accountCreated",
"caption": "accountCreated",
"isEnabled": true,
"createTime": "2021-10-22T15:39:13+00:00"
}
The Email Notification Template object (Back Office)
This object provides the following data about an email notification template:
- id integer
The identifier of an email notification template.
- subject string
The email template subject.
- isEnabled boolean
If
true, the email notification template is enabled and can be used to deliver notifications; otherwise,false.- locale string
The locale identifier (such as
en_US).- template string
The raw content of the email template.
- extendsId string
The type of email template. Possible values:
mailsnotificationstypes
- type object or null
The details about the notification type for which the template is used. To learn more, see the Notification Type object.
- createTime string
The date and time when the email notification template was configured.
{
"id": 1,
"subject": "Trading Account Created",
"isEnabled": true,
"locale": "en_US",
"template": "Template",
"extendsId": 2,
"type": {
"id": "1",
"name": "accountCreated",
"caption": "accountCreated",
"isEnabled": "true",
"createTime": "2022-01-01T00:00:00+00:00"
},
"createTime": "2022-01-01T00:00:00+00:00"
}
The Email Template object (Back Office)
This object provides the following data about an email template:
- id integer
The email template identifier.
- template string
The content of the email template, in the HTML format.
- provider object
The details about the email delivery service connected to the Back Office. See the Email Delivery Service object to learn more.
- subject string
The email subject.
- caption string
The email template name used in the Back Office.
- description string
The email template description.
- createTime string
The date and time when the email template was created.
{
"id": 1,
"template": "The email template content",
"provider": {
"id": 1,
"caption": "SendGrid config",
"platform": "SendGrid",
"isEnabled": true,
"createTime": "2021-10-26T08:31:10+00:00",
"options": {
"sender_address": "user@example.com",
"sender_name": "The company name",
"api_key": "lA1bXX8O0UM01Tgt-w7cjxfxFu-qQfXm7ccnN5j8wG8"
},
"webhook": "https://host.name/api/v2/my/mail/subscriptions/webhooks/1"
},
"subject": "The email subject",
"caption": "The email template caption",
"description": "The email template description",
"createTime": "2022-12-19T22:34:21+00:00"
}
The Event Listener object (Back Office)
This object provides the following data about an event listener:
- id integer
The identifier of an event listener.
- enabled boolean
If
true, an event listener is enabled; otherwise,false.- description string
The event listener description.
- type string
The event type that is listened for.
- handler string
The event handler assigned to an event type.
- eventHandlerProperties object
The filtering options specified for an event handler.
- workflow string
The workflow name.
- workflowProperties object
The detailed information about the action sequence that is initialized after an event occurs.
- createTime string
The date and time when an event listener was added.
- updateTime string
The date and time when an event listener was last updated.
{
"id": 1,
"enabled": true,
"description": "TransferEvent",
"type": "B2B\\TCA\\EventHandler\\Events\\TransferEvent",
"handler": "B2B\\TCA\\EventHandler\\Handlers\\TransferEventHandler",
"eventHandlerProperties": {
"destination_platform": "3",
"source_platform": "1",
"min_amount": "1"
},
"workflow": "SendNotificationFlow",
"workflowProperties": {
"emails": "user@example.com",
"template": "TransferEvent"
},
"createTime": "2021-08-21T09:53:14+00:00",
"updateTime": "2021-08-21T09:54:39+00:00"
}
The Event Notification object (Back Office)
This object provides the following data about an event notification:
- id integer
The event notification identifier.
- user object
The details about a Back Office user who is added as a notification recipient. See the User object to learn more.
- description string
The event notification description.
- event string
The event type that triggers a notification.
- channels array
An array of string values specifying channels through which notifications are delivered. Possible values:
emailsmsslacktelegram
- createTime string
The date and time when an event notification was configured.
- updateTime string
The date and time when an event notification was last updated.
{
"id": 1,
"user": {
"id": 10,
"name": "John Smith",
"email": "user@example.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": "client_tag"
}
],
"canViewMaskedData": true
},
"description": "Notifications about the notes and comments added on the Event log tab",
"event": "EventLogUserTagged",
"channels": [
"sms",
"email"
],
"createTime": "2023-01-01T00:00:00+00:00",
"updateTime": "2023-01-01T00:00:00+00:00"
}
The Exchange Rate Provider object (Back Office)
This object provides the following data about an exchange rate provider:
- id integer
The identifier of an exchange rate provider.
- name string
The name assigned to an exchange rate provider in the Back Office.
- provider string
The exchange rate provider name.
- fromCurrencies object
The details about the base currencies specified for an exchange rate provider.
- toCurrency object
The details about the quote currencies specified for an exchange rate provider.
- enabled boolean
If
true, a rate provider is enabled; otherwise,false.- priority integer
The priority index assigned to a rate provider.
- options object or null
The details about the settings specific to an exchange rate provider.
{
"id": 1,
"name": "CoinGecko",
"provider": "CoinGecko",
"fromCurrencies": "All",
"toCurrencies": "All",
"enabled": true,
"priority": 1,
"options": [
{ "rate": "2",
"base": "USD"
}
]
}
The External Connection object (Back Office)
This object provides the following data about an external connection:
- id integer
The identifier of an external connection.
- name string
The external connection name.
- caption string
The external connection name used in the Back Office.
- enabled boolean
If
true, an external connection is enabled; otherwise,false.- provider string required
The name of a service provider for which a connection is configured.
- providerOptions object required
The connection settings specific to a service provider.
- createTime string
The date and time when a connection was configured.
- updateTime string or null
The date and time when a connection was last updated.
{
"id": 1,
"name": "b2binpay",
"caption": "B2BinPay",
"enabled": true,
"provider": "B2BinPay",
"providerOptions": {
"location": "https://api-sandbox.b2binpay.com",
"login": "user1",
"password": "Qwerty123"
},
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
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 or null
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 or null
A character used as a decimal separator.
- fullDate string or null
The full date format (such as
l, F j, Y).- fullTime string or null
The full time format (such as
h:i:s A T).- longDate string or null
The long date format (such as
F j, Y).- middleDate string or null
The middle date format starting with the month (such as
M j, Y).- middleTime string or null
The middle time format (such as
h:i:s A).- name string or null
The person name format (such as
{title} {givenName} {familyName})- shortDate string or null
The short date format (such as
h:i A)- shortTime string or null
The short time format (such as
h:i A).- thousands string or null
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": ","
},
"fallBack": {
"id": 1,
"caption": "English",
"locale": "en_US",
"languageCode": "en",
"isEnabled": true,
"isDefault": true,
"isRightToLeft": false,
"priority": 1,
"formats": {
"decimal": ".",
"fullDate": "l, F j, Y",
"fullTime": "h:i:s A T",
"longDate": "h:i:s A T",
"longTime": "h:i:s A T",
"middleDate": "M j, Y",
"middleTime": "h:i:s A",
"name": "{title} {givenName} {familyName}",
"shortDate": "d.m.Y",
"shortTime": "h:i A",
"thousands": ","
}
}
}
The Paid Service object (Back Office)
This object provides the following data about a paid service:
- id integer
The identifier of a paid service.
- name string
The name of a paid service.
- comment string
The internal description of a paid service.
- group object
The details about the group in which a paid service is included. See the Paid-Service group object.
- fullName string
The full name of a paid service.
- externalId string or null
The identifier of an external service provider.
- isActive boolean
If
true, a paid service is enabled, and clients can be subscribed to it; otherwise,false.- createTime string
The date and time when a paid service was configured in the Back Office.
{
"id": 1,
"name": "The service name",
"comment": "The service description",
"group": {
"id": 1,
"comment": "The group description",
"caption": "The group name"
},
"fullName": "The full service name",
"externalId": null,
"isActive": false,
"createTime": "2022-01-01T00:00:00+00:00"
}
The Paid-Service group object (Back Office)
This object provides the following data about a group in which paid services can be included:
- id integer
The identifier of the paid-service group.
- comment string or null
The internal description of the paid-service group.
- caption string
The name of the paid-service group.
{
"id": 1,
"comment": "The group description",
"caption": "The group name"
}
The Paid-Service parameter object (Back Office)
This object provides the following data about a parameter that can be specified when subscribing clients to paid services:
- id integer
The identifier assigned to a service parameter after it is specified for a paid service.
- value string
The value assigned to a parameter.
- serviceParameterId integer
The service parameter identifier.
- createTime string
The date and time when a service parameter was added to a parameters list in the Back Office.
{
"id": 150,
"value": "The client's company name",
"serviceParameterId": 1,
"createTime": "2022-01-01T00:00:00+00:00"
}
The Parameter Preset object (Back Office)
This object provides the following data about a parameter preset that is applied when subscribing a client to a paid service.
- id integer
The parameter preset identifier.
- data object
The details about the parameters included in a preset.
- name string
The parameter preset name.
- service object
The details about the paid service to which a parameter preset can be applied. See the Paid Service object to learn more.
{
"id": 1,
"data": {},
"name": "The preset name",
"service": {
"id": 1,
"name": "The service name",
"comment": "The service description",
"group": {
"id": 1,
"comment": "The group description",
"caption": "The group name"
},
"fullName": "The full service name",
"externalId": null,
"isActive": true,
"createTime": "2022-01-01T00:00:00+00:00"
}
}
The Permission Level object (Back Office)
This object provides the following data about a client permission level:
- id integer
The identifier of a permission level.
- name string
The permission level name.
- parentId integer or null
The identifier of a previous permission level that clients must obtain before they can get this level.
- permissions array
An array of objects providing the data about the operations that clients are allowed to make in the B2Core UI.
Show object fields- name string
The operation name. Possible values:
verification— clients can obtain a higher verification levelconverter— clients can exchange fundsdeposits— clients can deposit funds to their wallets or trading accountswithdrawals— clients can withdraw funds from their wallets or trading accountsinternal_transfers— clients can transfer funds to the wallets and trading accounts of other clients registered on the same B2Core UI instance
- isEnabled boolean
If
true, clients are allowed to make an operation; otherwise,false.
- createTime string
The date and time when a permission level was created
- updateTime string
The date and time when a permission level was last modified.
- isDefault boolean
If
true, a permission level is the default one and is assigned to all clients that were granted the initial verification level; otherwise,false.
{
"id": 2,
"name": "Level 1",
"caption": "Level 1",
"parentId": 1,
"permissions": [
{
"name": "verification",
"isEnabled": true
},
{
"name": "converter",
"isEnabled": true
},
{
"name": "deposits",
"isEnabled": true
},
{
"name": "withdrawals",
"isEnabled": false
},
{
"name": "internal_transfers",
"isEnabled": false
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00",
"isDefault": false
}
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 or null
The client identifier.
- confirmed boolean
If
true, a phone number is confirmed, otherwise,false.- default boolean
If
true, a phone number is marked as the default one for a client, otherwise,false.- ext string or null
The phone number extension.
- number string
The client phone number.
- type string
The type of a phone number. Possible values:
fixedmobilefaxvoippager
- createTime string or null
The date and time when a phone number was added to a client profile.
- updateTime string or null
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:
personaltradedemopartnerliquidityexchangeexternalsystem
- status string
The product status. Possible values:
disabledpresentenableddefault
- 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:
dontSenddefaultsend
- 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 a 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:
depositenabledexchangetradetransferDeposittransferWithdrawalvisiblewithdrawal
- 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:
depositenabledexchangetradetransferDeposittransferWithdrawalvisiblewithdrawal
- 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 or null
The date and time when a product was created.
- updateTime string or null
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 or null
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
100if 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:
depositenabledexchangetradetransferDeposittransferWithdrawalvisiblewithdrawal
- defaultAccountPermissions array
An array of string values specifying permissions applied to accounts denominated in a product currency. Possible values:
depositenabledexchangetradetransferDeposittransferWithdrawalvisiblewithdrawal
- 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 or null
A link to a resource providing additional information about a product.
- agreementLink string or null
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 string or null
The date and time when a currency was added to a product.
- updateTime string or null
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:
disabledenabled
- type string
The product group type.
- priority integer
The priority index assigned to a product group.
- createTime string or null
The date and time when a product group was created.
- updateTime string or null
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 Product Note object (Back Office)
This object provides the following data about a product note:
- id integer
The identifier of a product note.
- title string
The title specified for a product note.
- value string
The text of a note.
- resources object
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when a note was added to a product.
- updateTime string or null
The date and time when a note was last updated.
{
"id": 1,
"title": "Title",
"value": "Text",
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "ja_JP",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Product Permission Group object (Back Office)
This object provides the following data about a product permission group:
- id integer
The identifier of a permission group.
- rights array
An array of string values specifying the permissions included in a permission group. Possible values:
enabledtradeEnableddepositwithdrawvisibletransferDeposittransferWithdrawexchangecreateFromTRDenied
- name string
The name of a permission group.
- isEnabled boolean
If
true, a permission group is enabled; otherwise,false.- createTime string or null
The date and time when a permission group was created.
- resource object
An array of resource objects specifying localized strings for user interface pages displayed to a client.
{
"id": 1,
"rights": [
"enabled",
"tradeEnabled",
"deposit",
"withdraw",
"visible",
"transferDeposit",
"transferWithdraw"
],
"name": "Name",
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"resources": [
{
"key": "caption",
"locale": "en_US",
"value": "value"
},
{
"key": "caption",
"locale": "ja_JP",
"value": "value"
}
]
}
The Product Restriction object (Back Office)
This object provides the following data about a product restriction.
- id integer
The identifier of a product restriction.
- isEnabled boolean
If
true, a product restriction is enabled; otherwise,false.- name string
The product restriction name. Possible values:
countryclient_typeproduct_countryverification_level_restrictionproduct_verification_auto_createclient_ib_parent
- type string
A string value specifying the type of a product restriction. Possible values:
Allow onlyDeny only
- rules array
An array of objects providing detailed information about the instances (such as countries, client types or others) to which a restriction applies.
- createTime string
The date and time when a product restriction was added.
- updateTime string
The date and time when a product restriction was last modified.
{
"id": 432,
"isEnabled": true,
"name": "country",
"type": "Allow Only",
"rules": [
{
"key": 4,
"caption": "Afghanistan"
},
{
"key": 7,
"caption": "Norway"
}
],
"updateTime": "2023-03-24T12:07:29+00:00",
"createTime": "2023-03-24T12:07:29+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 client’s previous email address.
- type string
The change type. Possible value:
email
- userId integer or null
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 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:
accountaddressarchiveclientTypedepositdocumentexternalinvestmentpartnerprofiletransferverificationwithdrawal
- resolution object or null
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 or null
The account identifier.
- amount string or null
The transaction amount.
- method string or null
The localized name of a method by which a transaction was made.
- transactionId integer or null
The transaction identifier.
- currency string or null
The transaction currency.
- dealingApproved string or null
Applicable only for withdrawal-type transactions.
Indicates whether a transaction is approved by the Compliance Department. Possible values:
approveddeclinedpending
- complianceApproved string or null
Applicable only for withdrawal-type transactions.
Indicates whether a transaction is approved by the Compliance Department. Possible values:
approveddeclinedpending
- liquidityAccount string or null
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 or null
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 Sent Email object (Back Office)
This object provides the following data about an email that was sent to clients:
- id integer
The sent email identifier.
- subject string
The email subject.
- description string
The email internal description.
- provider object
The details about the email delivery service that is used to deliver emails. See the Email Delivery Service object to learn more.
- createTime integer
The date and time when the email was sent.
{
"id": 1,
"subject": "The email subject",
"description": "The email internal description",
"provider": {
"id": 1,
"caption": "SendGrid config",
"platform": "SendGrid",
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"options": {},
"webhook": "https://host.name/api/v2/my/mail/subscriptions/webhooks/1"
},
"createTime": "2022-01-01T00:00:00+00:00"
}
The Subscription object (Back Office)
This object provides the following data about a client’s subscription to a paid service:
- id integer
The subscription identifier.
- isActive boolean
If
true, the subscription is active; otherwise,false.- service object
The details about the paid service to which a client is subscribed. See the Paid Service object to learn more.
- clientId integer
The client identifier.
- parameters array
An array of objects specifying the parameters applied to a subscription. See the Paid-Service parameter object to learn more.
- createTime string
The date and time when a client was subscribed to a paid service.
{
"id": 1,
"isActive": false,
"service": {
"id": 1,
"name": "The service name",
"comment": "The service description",
"group": {
"id": 1,
"comment": "The group description",
"caption": "The group name"
},
"fullName": "The full service name",
"externalId": null,
"isActive": false,
"createTime": "2022-01-01T00:00:00+00:00"
},
"clientId": 1,
"parameters": [
{
"id": 150,
"value": "01/01/2023",
"serviceParameterId": 1,
"createTime": "2022-01-01T00:00:00+00:00"
},
{
"id": 151,
"value": "The client's company name",
"serviceParameterId": 2,
"createTime": "2022-01-01T00:00:00+00:00"
}
],
"createTime": "2022-01-01T00:00:00+00:00"
}
The System Log object (Back Office)
This object provides the following data about a Back Office user’s action recorded to the system log:
- id integer
The record identifier.
- actorType string
The name of a user group that includes a Back Office user who made an action.
- actorContext string
The email address of a Back Office user who made an action.
- event string
The event name. Possible values:
client_created— a new client profile was registeredclient_updated— a client profile was updatedclient_info_updated— additional data provided by a client during registration was updated. The scope of the additional data depends on the Registration wizard configuration.client_phone_created— a new phone number was specified for a clientclient_phone_deleted— a phone number was removedclient_address_created— a new address was specified for a clientclient_address_updated— an address was modifiedclient_address_deleted— an address was removedclient_service_created— a client was subscribed to a paid serviceclient_service_updated— a client’s subscription to a paid service was modifiedclient_service_deleted— a client was unsubscribed from a paid serviceclient_directory_created— a client folder was addedclient_directory_deleted— a client folder was removedclient_subdirectory_created— a client subfolder was addedclient_document_created— a client document was addedclient_file_created— a client file was addedclient_file_deleted— a client file was removedclient_password_reset— a client’s password was resetclient_password_all_reset— all client passwords were resetoperation_created— a deposit, withdrawal, transfer or exchange transaction was made
- details string
The detailed information about an action that was made.
- createTime string
The date and time when an action was made.
{
"id": 1,
"actorType": "admin",
"actorContext": "<b>Email</b>: \"user@example.com\"<br>",
"event": "Operation Created",
"details": "<b>OperationId</b>: 2570<br><b>Type</b>: \"exchange\"<br>",
"createTime": "2022-11-16T09:09:46+00:00"
}
The Test’s Question object (Back Office)
This object provides the following data about a question included in a client test:
- id integer
The question identifier.
- quizId integer
The identifier of a test.
- question string
The text of a question.
- isVisible boolean
If
true, a question is displayed to clients when passing a test in the B2Core UI; otherwise,false.- category string
The category in which a question is included.
- type string
The question type. Possible values:
open— an open-ended question that can be answered in a free form.close— a close-ended question that can be answered by choosing a single or multiple correct answers from a given list of options.questionnaire— a multiple-choice question that can be answered by choosing one or more answers from a given list of options.poll— a multiple-choice question that can be answered by choosing a single answer from a given list of options.
- priority integer
The priority index assigned to a question.
- isMultipleChoices boolean
If
true, multiple answer options are specified for a question; otherwise,false.- resources object
An array of resource objects specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when a question was added to a test.
- updateTime string or null
The date and time when a question was last modified.
{
"id": 1,
"quizId": 1,
"question": "What kind of information helps you make informed decisions?",
"isVisible": true,
"category": "General questions",
"type": "closed",
"priority": 1,
"isMultipleChoices": false,
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
},
{
"key": "caption",
"locale": "en_US",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Temporary Bonus object (Back Office)
This object provides the following data about a temporary bonus program:
- id integer
The identifier of a temporary bonus program.
- amount string
The bonus amount that can be awarded to clients under a bonus program.
- name string
The name of a bonus program displayed to clients in the B2Core UI.
- dynamicLots string
The required amount of traded volume for bonus crediting.
- currency integer
The bonus program currency. Only the trading accounts denominated in the specified currency can join a bonus program.
- platform string
The trading platform for which a bonus program is available.
- platformGroups array
An array of string values specifying the platform groups. Only trading accounts included in the specified groups can be awarded bonuses under a bonus program.
- lifetime integer
The number of days after which an activated bonus expires.
- enableAutoCredit boolean
If
true, bonuses from all bonus programs (if more than one is enabled for a client at the same time) are credited to the client’s trading account immediately.If
false, bonuses from different bonus programs (if more than one is enabled for a client at the same time) are credited to the client’s trading accounts one after another. Only after a bonus from the first bonus program is processed and credited, a bonus from the second bonus program is credited to a client.- scalpingThreshold integer
The minimum time interval (in seconds) during which a position must be opened for a bonus to be awarded.
- disabledGroups array
An array of string values specifying the instruments for which bonuses aren’t awarded.
- enableTrade boolean
If
true, trading with bonus funds is immediately allowed after depositing funds to a trading account; otherwise,false.- expiredAt string or null
The date and time when a bonus program expires.
- createdAt string or null
The date and time when a bonus program was created.
- updatedAt string or null
The date and time when a bonus program was updated.
- default boolean
If
true, a bonus program is used as the default for all clients; oterwise,false.
{
"id": 1,
"amount": "100.00",
"name": "MT5",
"dynamicLots": "1.000",
"currency": "USD",
"platform": "MetaTrader5",
"platformGroups": [],
"lifetime": 30,
"enableAutoCredit": true,
"scalpingThreshold": 1,
"disabledGroups": [
"EURJPY"
],
"enableTrade": true,
"expiredAt": "2022-01-01T00:00:00+00:00",
"createdAt": "2022-01-01T00:00:00+00:00",
"updatedAt": "2022-01-01T00:00:00+00:00",
"default": true
}
The Transaction object (Back Office)
This object provides the following data about a transaction:
- clientId integer or null
The client identifier.
- transactionId integer or null
The transaction identifier.
- creditDetails object or null
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 or null
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 or null
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
verificationStatusfield.For withdrawals, this object includes the
complianceStatusanddealingStatusfields.Show object fields- blockchainTransaction string or null
The transaction identifier in a blockchain.
- comment string or null
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:
approveddeclinedpending
- dealingStatus string
Applicable only for withdrawal-type transactions.
Indicates whether a transaction is approved by the Dealing Department. Possible values:
approveddeclinedpending
- invoice string or null
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:
approvednewpending
- createTime string or null
The date and time when a transaction was made.
- invoiceTime string or null
The date and time when an invoice was sent.
- updateTime string or null
The date and time when the transaction status has last been updated.
- method object or null
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 or null
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:
approvedinProgressnewpendingrejected
- type string or null
The client request type. Possible values:
accountaddressarchiveclientTypedepositdocumentexternalinvestmentpartnerprofiletransferverificationwithdrawal
- createTime string or null
The date and time when a client request was made.
- processedTime string or null
The date and time when a client request was processed.
- resolution object or null
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:
cancelleddonefailedholdholdFailedinProgressnewpartialpendingrejectedrefundrefundFailedtrade
Transactions with the
newstatus are not returned.- type string or null
The transaction type. Possible values:
depositexchangeexternalpartnertransferwithdrawal
- createTime string or null
The date and time when a transaction was created in B2Core.
- updateTime string or null
The date and time when the transaction status has last been updated.
- processedTime string or null
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 object or null
An array of objects indicating details specific to a transaction type (such as transaction statuses or restrictions applied to a transaction type).
- class string or null
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 or null
This object provides the following data:
Show object fields- blockchainTransaction string or null
The transaction identifier in a blockchain.
- comment string or null
The text of an internal comment to a transaction.
- invoice string or null
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:
approvednewpending
- createTime string or null
The date and time when a transaction was made.
- invoiceTime string or null
The date and time when an invoice was sent.
- updateTime string or null
The date and time when a transaction status has last been updated.
- direction string
The transaction type. Possible values:
depositwithraw
- reviewResult string
The transaction monitoring result returned by a provider. Possible values:
redgreenerror
- 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 Back Office user:
- id integer
The user identifier.
- name string
The user name.
- email string
The user email address.
- phone string or null
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 or null
The free funds available on an account.
- currentBalance string or null
The current balance on an account.
- credit string or null
The amount of credit funds on an account.
- equity string or null
The equity of an account.
- freeMargin string or null
The account free margin.
- hold string or null
The amount of funds currently on hold for an account.
- margin string or null
The account margin.
- marginLevel string or null
The account margin level, which is a ratio of equity to margin.
- pnl string or null
The profit-loss value calculated for an account.
- updateTime string or null
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 or null
The email text.
- nextLevel integer or null
The identifier of a next verification level that clients can be granted after obtaining this verification level.
- roleId integer or null
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 or null
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 or null
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 Verification Level Restriction object (Back Office)
This object provides the following data about a verification level restriction.
- id integer
The identifier of a verification level restriction.
- isEnabled boolean
If
true, a verification level restriction is enabled; otherwise,false.- name string
The name of a verification level restriction. Possible value: -
client_type— allows or forbids granting a verification level to specified client types.- type string
A string value specifying the type of a verification level restriction. Possible values:
Allow onlyDeny only
- rules array
Array of objects specifying the rules in a verification level restriction.
- createTime string
The date and time when a verification level restriction was added.
- updateTime string
An array of objects providing detailed information about the client types to which a restriction applies.
{
"id": 432,
"isEnabled": true,
"name": "country",
"type": "Allow Only",
"rules": [
{
"key": 4,
"caption": "Afghanistan"
},
{
"key": 7,
"caption": "Norway"
}
],
"updateTime": "2023-03-24T12:07:29+00:00",
"createTime": "2023-03-24T12:07:29+00:00"
}
The Whitelisted Address object (Back Office)
This object provides the following data about a whitelisted withdrawal address:
- id integer
The identifier of a whitelisted withdrawal address.
- destinationTag string or null
The destination tag used to identify a transaction recipient.
- walletAddress string
A string value identifying the address of a wallet that is used for withdrawing funds.
- client object
The details about the client who added a withdrawal address to their whitelist. See the Client object to learn more.
- accounts array
An array of objects providing the data about client accounts.
Show object fields- accountId integer
The account identifier.
- accountNumber string
The account number
- createTime string
The date and time when an account was created.
- currency object
The details about the currency in which a wallet for withdrawing funds is denominated. See the Currency object to learn more.
- isEnabled boolean
If
true, the address management option is enabled by a client in the B2Core UI; otherwise,false.This option allows clients to add withdrawal addresses to their whitelists and withdraw funds only to the whitelisted addresses.
- createTime boolean
The date and time when a withdrawal address was added to a whitelist.
- createTime boolean
The date and time when a whitelisted withdrawal address was last modified.
{
"id": 1,
"destinationTag": null,
"walletAddress": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLi",
"client": {
"analytics": [
{
"property": "utm_campaign",
"value": "summer_program"
}
],
"clientId": 1,
"accounts": [
{
"accountId": 1,
"accountNumber": "17548892996474470",
"createTime": "2022-01-01T00:00:00+00:00"
},
{
"accountId": 2,
"accountNumber": "10611",
"createTime": "2022-01-01T00:00:00+00:00"
}
],
"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": "jdoe@bexample.com",
"internalType": "default",
"firstName": "John",
"lastName": "Doe",
"middleName": "James",
"name": "John James Doe",
"nickname": "Super trader",
"locale": "en_US",
"manager": {
"id": 1,
"officeId": 1,
"enabled": false,
"email": "msmith@example.com",
"name": "Mary Smith",
"title": "Ms",
"phone": "+995577755422",
"resources": [
{
"key": "caption",
"locale": "en_US",
"value": "value"
},
{
"key": "caption",
"locale": "ru_RU",
"value": "value"
}
],
"createTime": "2022-01-01T00:00:00+00:00"
},
"phone": "+14962000000",
"riskLevel": "low",
"status": "active",
"tags": [
"tag1",
"tag2"
],
"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",
"updateTime": "2022-01-01T00:00:00+00:00"
},
"currency": {
"alphabeticCode": "BTC",
"minorUnit": 8,
"name": "Bitcoin",
"numericCode": 1000
},
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
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 or null
The widget width, in points.
- height integer or null
The widget height, in points.
- positionX integer or null
The
Xcoordinate of the upper-right corner of a widget.- positionY integer or null
The
Ycoordinate 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 Commission (Back Office)
This object provides the following data about commissions configured for a withdrawal method:
- id integer
The commission identifier.
- currency object
The details about a currency in which a commission is charged.
Show object fields- alphabeticCode string
The alphabetic code of a currency (such as
USD).- 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
840).
- type string
The commission type.
- recipientType string
Indicates whether a commission is charged by a broker or payment system. Possible values:
vendor— a commission is charged by a brokerprovider— a commission is charged by a payment system
- percent string
The percentage of a withdrawal amount charged as a commission.
- fix string
The fixed commission amount.
- min string
The minimum commission amount.
- max string
The maximum commission amount.
{
"id": 1,
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"type": "default",
"recipientType": "vendor",
"percent": "5.00",
"fix": "10.00",
"min": "15.00",
"max": "20.00"
}
The Withdrawal Currency object (Back Office)
This object provides the following data about a currency added to a withdrawal method:
- id integer
The identifier of a withdrawal currency.
- currency object
The details about a withdrawal currency.
Show object fields- alphabeticCode string
The alphabetic code of a currency (such as
BTC).- 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
1000).
- type string
The type of a currency added to a withdrawal method. Possible values:
tradersRoom— transaction currenciespaymentSystem— payment currencies
- isEnabled boolean
If
true, a currency is enabled for a withdrawal method; otherwise,false.- min object
The data about the minimum amount that can be withdrawn in a currency.
Show object fields- value string
The minimum allowed withdrawal amount.
- scale integer
The number of decimal places displayed when representing the minimum amount in a currency.
- max object
The data about the maximum amount that can be withdrawn in a currency.
Show object fields- value string
The maximum allowed withdrawal amount.
- scale integer
The number of decimal places displayed when representing the maximum amount in a currency.
- blockExporter string or null
Applicable only for cryptocurrencies.
The cryptocurrency block explorer.
- blockchainCode integer or null
Applicable only for cryptocurrencies.
The currency code in a blockchain.
- createTime string
The date and time when a currency was added to a withdrawal method.
- updateTime string or null
The date and time when a currency was last modified.
{
"id": 1,
"currency": {
"alphabeticCode": "BTC",
"minorUnit": 8,
"name": "Bitcoin",
"numericCode": 1000
},
"type": "tradersRoom",
"isEnabled": true,
"min": {
"value": "0.00",
"scale": 8
},
"max": {
"value": "0.00",
"scale": 8
},
"blockExporter": "https://www.blockchain.com/btc/tx/{address}",
"blockchainCode": 123,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Withdrawal Group object (Back Office)
This object provides the following data about a withdrawal group:
- id integer
The withdrawal group identifier.
- description string
The withdrawal group description.
- caption string
The withdrawal group name displayed to clients in the B2Core UI.
- name string
The withdrawal group name used in the Back Office.
- icon string
The filename of an image that is displayed as a withdrawal group icon.
- priority integer
The priority index assigned to a withdrawal group.
- isEnabled boolean
If
true, a group is enabled; otherwise,false.- createTime string or null
The date and time when a withdrawal group was created.
- updateTime string or null
The date and time when a withdrawal group was last updated.
{
"id": 1,
"description": "description",
"caption": "crypto",
"name": "crypto",
"icon": "",
"priority": 1,
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Withdrawal Method object (Back Office)
This object provides the following data about a withdrawal method:
- id integer
The withdrawal method identifier.
- name string
The name of a withdrawal method.
- isEnabled boolean
If
true, a method is enabled; otherwise,false.- group array
An array of objects providing data about one or several groups in which a withdrawal method is included. See the Withdrawal Group object to learn more.
- caption string
The withdrawal method’s name that is displayed to clients in the B2Core UI.
- provider string
The name of a payment system used to make withdrawals.
- providerResultUrl string
The URL to which a callback notifying about changing a withdrawal transaction status is sent.
- providerSettings object
The settings specific to a payment provider that is used to make withdrawals.
- providerOptions object
The details about custom fields added to a withdrawal method configuration.
- libraryTimeToFund string
A hint displayed to clients in the B2Core UI about the period during which a withdrawal transaction is processed.
- precalculate boolean
If
true, the commission amount charged for withdrawing funds is calculated and displayed to a client in the B2Core UI; otherwise,false.- icon string
The filename of an image that is displayed as a withdrawal method icon.
- priority integer
The priority index assigned to a withdrawal method.
- ipWhiteList string
The list of allowed IP addresses.
- ratesProvider string
The name of an exchange rate provider associated with a withdrawal method.
- resources object
An array of resource objects, specifying localized strings for user interface pages displayed to a client.
- createTime string
The date and time when a withdrawal method was created.
- updateTime string or null
The date and time when a withdrawal method was last updated.
{
"id": 1,
"name": "B2BinPay",
"isEnabled": false,
"groups": [
{
"id": 1,
"description": "description",
"caption": "Crypto",
"name": "Crypto",
"icon": "image.png",
"priority": 1,
"isEnabled": false,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
},
{
"id": 1,
"description": "description",
"caption": "Fiat",
"name": "Fiat",
"icon": "image.png",
"priority": 1,
"isEnabled": true,
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
],
"caption": "B2BinPay",
"provider": "B2BinPay",
"providerResultUrl": "www.example.com",
"providerSettings": {},
"providerOptions": {},
"libraryTimeToFund": "Depending on the blockchain",
"precalculate": true,
"icon": "image.png",
"priority": 1,
"ipWhitelist": "IP White List",
"ratesProvider": "B2BinPay2",
"resources": [
{
"key": "caption",
"locale": "ru_RU",
"value": "Lorem"
},
{
"key": "caption",
"locale": "ja_JP",
"value": "ビットコイン"
}
],
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Withdrawal Method Attribute object (Back Office)
This object provides the following data about an attribute added to a withdrawal method:
- id integer
The identifier of a withdrawal method attribute.
- caption string
The attribute name displayed in the B2Core UI.
- type string
The attribute type. Possible values:
selectAutocompleteinput
{
"id": "affca0b6-fc27-4a46-92e3-bb3fbd95cb99",
"caption": "Code",
"type": "selectAutocomplete"
}
The Withdrawal Method Restriction object (Back Office)
This object provides the following data about a withdrawal method restriction.
- id integer
The identifier of a withdrawal method restriction.
- isEnabled boolean
If
true, a withdrawal method restriction is enabled; otherwise,false.- name string
The withdrawal method restriction name. Possible values:
country— allows or forbids the use of a deposit method for specified countries.client_type— allows or forbids the use of a deposit method for specified client types.verification_level_restriction— allows or forbids the use of a deposit method for specified client verification levels.
- type string
A string value specifying the type of a withdrawal method restriction. Possible values:
Allow onlyDeny only
- rules array
An array of objects providing detailed information about the countries, client types or client verification levels to which a restriction applies.
- createTime string
The date and time when a withdrawal method restriction was added.
- updateTime string
The date and time when a withdrawal method restriction was last modified.
{
"id": 432,
"isEnabled": true,
"name": "country",
"type": "Allow Only",
"rules": [
{
"key": 4,
"caption": "Afghanistan"
},
{
"key": 7,
"caption": "Norway"
}
],
"updateTime": "2023-03-24T12:07:29+00:00",
"createTime": "2023-03-24T12:07:29+00:00"
}
The Withdrawal Template object (Back Office)
This object provides the following data about a withdrawal template:
- id integer
The identifier of a withdrawal template.
- name string
The name of a withdrawal template.
- accountId integer
The identifier of the account from which funds are to be withdrawn.
- amount string
The withdrawal amount.
- amountTo string or null
The withdrawal amount converted to the currency in which the wallet for withdrawing funds is denominated.
- method object or null
The withdrawal method.
Show object fields- id integer
The identifier of a withdrawal method.
- name string
The name of a withdrawal method.
- caption string or null
The name of a withdrawal method displayed to clients 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 or null
The withdrawal method.
Show object fields- id integer
The identifier of a withdrawal group.
- caption string or null
The withdrawal group name displayed to clients in the B2Core UI.
- name string
The withdrawal group name used in the Back Office.
- icon string or null
The filename of an image that is displayed as a withdrawal group icon.
- data object
The data specific to a withdrawal method.
Show object fields- wallet_address string
The address of the wallet from 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",
"accountId": 275,
"amount": "0.0001",
"amountTo": "0.0001",
"method": {
"id": 1,
"name": "B2BinPay",
"caption": "B2BinPay"
},
"currency": {
"alphabeticCode": "BTC",
"minorUnit": 8,
"name": "Bitcoin",
"numericCode": 1000
},
"group": {
"id": 1,
"caption": "crypto",
"name": "crypto",
"icon": "image.png"
},
"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"
}