Front Office API objects
In this section, you can learn about the objects used in the Front Office API:
The Account object (Front Office)
This object provides the following data about a client account:
- accountId integer
The account identifier.
- accountNumber string
The account number.
- archive boolean
If
true, an account is archived; otherwise,false.- 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.
- favourite boolean
If
true, an account is marked as favorite; otherwise,false.- group object or null
The details about a group to which an account belongs.
Show object fields- id integer
The identifier of an account group.
- name string
The name of an account group.
- priority integer
The priority index assigned to an account group.
- platform object
The details about a platform on which an account is opened.
Show object fields- id integer
The identifier of a platform.
- name string
The name of a platform.
- priority integer
The priority index assigned to an account.
- statement object or null
The account statement.
Show object fields- 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 was last updated.
- type string or null
The account type. Possible values:
personaltradedemopartnerliquidityexchangeexternalboiisbosystem
- createTime string
The date and time when an account was created.
{
"accountId": 1,
"accountNumber": "12345678",
"archive": false,
"caption": "USD",
"currency": {
"alphabeticCode": "USD",
"minorUnit": 2,
"name": "US Dollar",
"numericCode": 840
},
"favourite": true,
"group": {
"id": 1,
"name": "Fiat",
"priority": 1
},
"platform": {
"id": 1,
"name": "MetaTrader 5"
},
"priority": 1,
"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",
"createTime": "2022-01-01T00:00:00+00:00"
}
The Announcement object (Front Office)
This object provides the following data about a client announcement:
- id integer
The identifier of a client announcement.
- title string
The announcement title.
- text string
The text of the announcement.
- buttonText string
The text displayed on the button in the announcement.
- type object
The details about the announcement type. The announcement type identifies whether the announcement requires clients to take an action.
Show object fields- caption string or null
The type name.
- value integer
The identifier assigned to the announcement type. Possible values:
0— required. The announcement contains a button and blocks further interaction with the B2Core UI until a client clicks this button.1— optional. The announcement does not require any actions from a client and is displayed as a notification.
- createTime string
The date and time when the announcement was created.
- updateTime string
The date and time when the announcement was last updated.
- buttonLink string or null
The link to an external resource that is opened upon clicking a button displayed in the announcement.
{
"id": "1",
"title": "The Announcement title",
"text": "The Announcement text",
"buttonText": "The Button text",
"type": {
"caption": "The type name",
"value": 0
},
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00",
"buttonLink": "https://example.com"
}
The Bonus object (Front Office)
This object provides the following data about a bonus:
- id integer
The bonus identifier.
- clientId integer
The identifier of a client.
- clientName string
The name of a client.
- clientEmail string
The email address of a client.
- accountId integer
The identifier of a client trading account to which a bonus is credited.
- accountNumber string
The number of a client trading account to which a bonus is credited.
- amount number
The bonus amount that can be awarded to a client.
- volumeComplete string
The traded volume by the moment of the bonus expiration.
- temporaryBonus string or null
The name of a temporary bonus program.
- currency object
The details about the currency in which a bonus is allocated.
- 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 so that the position volume is counted as traded volume.
- 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 volume that must be traded for bonus crediting.
- status string
The bonus status. Possible values:
queuedactivependingprocessingcompletedonCompletingexpirederrorhold
- activatedAt string or null
The date and time when a bonus was activated.
- 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": "John Doe",
"clientEmail": "jdoe@example.com",
"accountId": "1",
"accountNumber": "2100242175",
"amount": 100.00,
"volumeComplete": "0.060",
"temporaryBonus": null,
"currency": {
"alphabeticCode": "USD",
"minorUnit": "2",
"name": "US Dollar",
"numericCode": 840
},
"currencyExp": 2,
"fictiveVolumeComplete": "0.100",
"lifetime": 30,
"enableAutoCredit": true,
"scalpingThreshold": 120,
"enableTrade": true,
"disabledGroups": [
"USDCZK"
],
"dynamicLots": "0.100",
"status": "Pending",
"activatedAt": "2022-01-01T00:00:00+00:00",
"createdAt": "2022-01-01T00:00:00+00:00",
"updatedAt": "2022-01-01T00:00:00+00:00"
}
The Client Profile (Front Office)
This object provides the following data about a client profile:
- id integer
The client profile identifier.
- email string
The client’s email address.
- locale string or null
The localization option applied to the B2Core UI.
- status string
The client profile status. Possible values:
inactiveactivebanneddeleted
- nickname string or null
The client’s nickname used in the B2Core UI.
- photo string or null
The filename of an image used as a profile picture.
- maskedEmail string
The masked email address.
- clientUiConfig object
The user interface configuration options specified for a client.
Show object fields- showId boolean
If
true, a client identifier is displayed in the B2Core UI; otherwise,false.- allowChangeUserPic boolean
If
true, a client can change their profile picture via the B2Core UI; otherwise,false.- allowChangeNickname boolean
If
true, a client can change their nickname via the B2Core UI; otherwise,false.
The client personal data.
- firstName string or null
The client’s first name.
- lastName string or null
The client’s last name.
- middleName string or null
The client’s middle name.
- birthday string or null
The client’s date of birth.
The details about a client phone number that is marked as the default one.
The default phone number is always a mobile number that is confirmed by a client. If several mobile numbers are confirmed, the latest confirmed number is marked as the default one.
- id integer
The identifier of a phone number.
- phone string
The phone number.
- ext string
The phone number extension.
- type string
The type of a phone number.
Always
mobilefor the default phone number.- confirm boolean
If
true, a phone number is confirmed; otherwise,false.Always
truefor the default phone number.- default boolean
If
true, a phone number is marked as the default one for a client; otherwise,false.- maskedPhone string
The masked phone number.
An array of objects providing data about all phone numbers specified in a client profile.
The details about a client profile type. See the Client Type object to learn more.
The details about a client’s country (if specified by a client during registration or KYC verification process). See the Country object to learn more.
The details about a verification level obtained by a client. See Verification Level object to learn more.
The date and time of when a client was last signed in to the B2Core UI.
The date and time when a client profile was registered.
The date and time when a client profile was last modified.
{
"id": 1,
"email": "jdoe@example.com",
"locale": "en_US",
"status": "active",
"nickname": null,
"photo": "image.jpeg",
"maskedEmail": "j*********@********.com",
"clientUiConfig": {
"showId": true,
"allowChangeUserPic": true,
"allowChangeNickname": true
},
"info": {
"firstName": "John",
"lastName": "Doe",
"middleName": null,
"birthday": "2022-01-01T00:00:00+00:00"
},
"phone": {
"id": 1,
"phone": "phone number",
"ext": "123",
"type": "mobile",
"confirm": true,
"default": true,
"maskedPhone": "masked phone number"
},
"phones": [
{
"id": 1,
"phone": "phone number",
"ext": "123",
"type": "mobile",
"confirm": true,
"default": true,
"maskedPhone": "masked phone number"
},
{
"id": 2,
"phone": "phone number",
"ext": "1214",
"type": "fixed",
"confirm": false,
"default": false,
"maskedPhone": "masked phone number"
}
],
"type": {
"id": 1,
"default": true,
"enabled": true,
"name": "Individual",
"group": "individual",
"wizard": true
},
"country": {
"countryId": 8,
"alpha2Code": "US",
"alpha3Code": "USA",
"countryName": "United States",
"callingCode": "+1",
"numericCode": "840",
"enabled": true
},
"verificationLevel": {
"id": 1,
"name": "Level 0",
"description": "description",
"mailDescription": "mail description",
"nextLevel": 1,
"roleId": 1,
"wizard": "DocumentsWizard",
"default": true,
"visible": true,
"sustainable": true,
"options": [
"Document type 1",
"Document type 2"
]
},
"lastLoginTime": "2022-01-01T00:00:00+00:00",
"createTime": "2022-01-01T00:00:00+00:00",
"updateTime": "2022-01-01T00:00:00+00:00"
}
The Client Settings object (Front Office)
This object provides the following data about client settings:
- settings object
The client settings details:
- applicationColor string
The color used to highlight client requests in the Back Office. You can specify the color name, or define its HEX or RGBA value.
- locale string
The locale identifier (such as
en_US) indicating a preferred communication language for a client.- commonTheme string
The default theme applied to the B2Core UI. Possible values:
dark-themelight-theme
{
"settings": {
"applicationColor": "#225577",
"locale": "en_US",
"commonTheme": "light-theme"
}
}
The Client Type object (Front 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.
{
"id": 1,
"default": true,
"enabled": true,
"name": "Individual",
"group": "individual",
"wizard": true
}
The Country object (Front 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).
- enabled boolean
If
true, a country is available for selection when clients sign up to the B2Core UI; otherwise,false.
{
"countryId": 840,
"alpha2Code": "US",
"alpha3Code": "USA",
"countryName": "United States",
"callingCode": "+1",
"numericCode": "840",
"enabled": true
}
The Currency object (Front Office)
This object provides the following data about a currency:
- 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 localized currency name.
- numericCode integer
The numeric code of a currency.
{
"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 Deposit Group object (Front Office)
This object provides the following data about a deposit group:
- id integer
The identifier of a deposit group.
- 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 displayed as a deposit group icon.
{
"id": 1,
"description": "Group description",
"caption": "Crypto",
"name": "Cryptocurrencies",
"icon": "example.png"
}
The Deposit Method object (Front Office)
This object provides the following data about a deposit method:
- id integer
The identifier of a deposit method.
- name string
The deposit method name displayed to clients in the B2Core UI.
- icon string or null
The filename of an image displayed as a deposit method icon.
- libraryTimeToFund string
A hint displayed to clients in the B2Core UI about the period during which a deposit transaction is processed.
- caption string
The deposit method description.
- provider string
The name of a payment system used to make deposits.
- tradersRoomCurrencies array
An array of objects providing data about each transaction currency added to a deposit method.
Show object fields- min object
The data about the minimum amount that can be deposited in a transaction 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 transaction currency.
- max object
The data about the maximum amount that can be deposited in a transaction 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 transaction currency.
- icon string
The filename of an image displayed as a currency icon.
- caption string
The currency name displayed to clients in the B2Core UI.
- keyCaption string
The path to a list of localized strings that can be displayed as a currency caption.
- currency object
The details about a transaction currency.
Show object fields- alphabeticCode string
The alphabetic code of a currency.
- 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.
- paymentSystemCurrencies array
An array of objects providing data about each payment currency added to a deposit method.
Show object fields- min object
The data about the minimum amount that can be deposited in a payment 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 payment currency.
- max object
The data about the maximum amount that can be deposited in a payment 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 payment currency.
- icon string
The filename of an image displayed as a currency icon.
- caption string
The currency name displayed to clients in the B2Core UI.
- keyCaption string
The path to a list of localized strings that can be displayed as a currency caption.
- currency object
The details about a payment currency.
Show object fields- alphabeticCode string
The alphabetic code of a currency.
- 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.
- vendorCommissions array
An array of objects providing data about commissions charged by a broker.
Show object fields- percent integer
The percentage of a deposit amount charged as a commission.
- min number
The minimum commission amount.
- max number
The maximum commission amount.
- fix number
The fixed commission amount.
- type string
The commission type.
- providerCommissions array
An array of objects providing data about commissions charged by a payment system.
Show object fields- percent integer
The percent of a deposit amount charged as a commission.
- min number
The minimum charged commission amount.
- max number
The maximum charged commission amount.
- fix number
The fixed commission amount.
- type string
The commission type.
- hideAmount boolean
If
true, the Amount field is not displayed in the B2Core UI when clients deposit funds using a deposit method; otherwise,false.- hideProceed boolean
If
true, the Proceed button is not displayed in the B2Core UI when clients deposit funds using a deposit method; otherwise,false.- description string
The additional description of a deposit method.
- groups array
An array of objects providing data about deposit groups in which a deposit method is included. See the Deposit Group object to learn more.
THE DEPOSIT METHOD OBJECT (FRONT OFFICE){ "id": 1, "name": "B2BinPay", "icon": "image.png", "libraryTimeToFund": "Depending on the blockchain", "caption": "B2BinPay", "pretend": true, "provider": "B2BinPay", "tradersRoomCurrencies": [ { "min": { "value": "0.00", "scale": 2 }, "max": { "value": "0.00", "scale": 2 }, "icon": "image.png", "caption": "BTC", "keyCaption": "", "currency": { "alphabeticCode": "BTC", "minorUnit": 8, "name": "BTC", "numericCode": 1000 } } ], "paymentSystemCurrencies": [ { "min": { "value": "0.00", "scale": 2 }, "max": { "value": "0.00", "scale": 2 }, "icon": "image.png", "caption": "USD", "keyCaption": "", "currency": { "alphabeticCode": "USD", "minorUnit": 2, "name": "US Dollar", "numericCode": 840 } } ], "vendorCommissions": [ { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 840 }, { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 1000 } ], "providerCommissions": [ { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 840 }, { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 1000 } ], "hideAmount": false, "hideProceed": false, "description": "Additional deposit method description", "groups": [ { "id": 3, "description": "Group description", "caption": "Crypto", "name": "Cryptocurrencies", "icon": "image.png" } ] }
The Device object (Front 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 use agent data.
- webTimezone string or null
The time zone set in a client browser.
- 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.
THE DEVICE OBJECT (FRONT OFFICE){ "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 (Front 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 document type with which a document is associated:
Show object fields- 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 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:
Show object fields- 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 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.
- 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.
- 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.
THE DOCUMENT OBJECT (FRONT OFFICE){ "id": 1, "type": { "id": 1, "description": "Document types available for corporate clients", "enabled": true, "exаmple": "example", "group": { "id": 1, "description": "The documents required for corporate clients", "enabled": true, "name": "corporate", "priority": 1, "type": "one" }, "maxFiles": 10, "name": "corporate", "priority": 1 }, "status": "approved", "applicationId": 1, "files": [ { "id": 8, "file": "y/1662913861_photo_2022-09-08_11-23-06.jpg" } ], "createTime": "2022-01-01T00:00:00+00:00" }
The Exchange Rate object (Front Office)
This object provides the following data about exchange rates for currency pairs:
- rates array or null
An array of objects providing the exchange rate data for the requested currency pairs.
- rate object
The details about the exchange rate for a specific currency pair.
Show object fields- value string
The exchange rate.
- scale integer
The number of decimal places displayed when representing the minimum amount in a currency.
- expiredAt string
The date and time when the exchange rate data is due to expire.
THE EXCHANGE RATE OBJECT (FRONT OFFICE){ "rates": { "btc_usd": { "rate": { "value": "38035.563488310000000000", "scale": 18 } }, "btc_eur": { "rate": { "value": "33557.826776640000000000", "scale": 18 } } }, "expiredAt": "2023-06-01T15:24:39.597081Z" }
The Key-Value Pair object (Front Office)
This object provides the following data about a key-value pair defined in the B2Core UI:
- 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 objects providing information about the tags assigned to a key-value pair.
Show object fields- id integer
The tag identifier.
- caption string
The tag name.
- isEnabled boolean
If
true, a tag is enabled; otherwise,false.- createTime string
The date and time when a tag was created.
- updateTime string
The date and time when a tag was last updated.
- 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.
THE KEY-VALUE PAIR OBJECT (FRONT OFFICE){ "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" } ], "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 Localization object (Front 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).- languageCode string
The language code (such as
en).- isEnabled boolean
If
true, a language can be selected by clients from the list of available languages in the B2Core UI; otherwise,false.- isDefault boolean
If
true, a language and the localization settings specified for it are applied by default in the B2Core UI; 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.
- fallback object or null
The details about the localization option that is used as a fallback option. The translations and format settings specified for the fallback localization option are used in the B2Core UI if the default translations can’t be found.
Show object fields- id integer
The identifier of a fallback localization option.
- caption string
The name of a language for which localization settings are configured.
- locale string
The locale identifier (such as
en_US).- languageCode string
The language code (such as
en).- isEnabled boolean
If
true, a language can be selected by clients from the list of available languages in the B2Core UI; otherwise,false.- isDefault boolean
If
true, a language and the localization settings specified for it are applied by default in the B2Core UI; 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 fallback 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).- longTime string or null
The long time 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.
THE LOCALIZATION OBJECT (FRONT OFFICE){ "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 Product Currency object (Front 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.
- product object
The details about a product to which a currency is added.
Show object fields- id integer
The product identifier.
- type string
The product type. Possible values:
personaltradedemopartnerliquidityexchangeexternalboiisbosystem
- name string
The product name.
- group object
The details about a product group in which a product is included. See the Product Group object to learn more.
- 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.
- shortCaption string
The platform short name.
- name string
The platform name used in the Back Office.
- class string
The class to which a platform is assigned.
- isDemo boolean
If
true, only demo accounts can be opened using the products created for this platform; otherwise,false.
- currency object
The details about a product currency.
Show object fields- alphabeticCode integer
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).
- factory integer
This parameter is set to
100if product-associated accounts are denominated in currency subunits (for example, cents); otherwise, set to1.- variants object
The options that can be selected by a client when opening an account denominated in a product currency.
Show object fields- 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.
- leverages array
An array of integer values specifying optional leverage ratios available to accounts denominated in a product currency.
- platformGroups array or null
An array of string values specifying platform group names.
- isHedgingEnabled boolean
If
true, exchange operations in a product currency are hedged; otherwise,false.- maxAccounts integer
The maximum number of accounts denominated in a product currency that can be created for a client.
- permissions array
An array of string values specifying permissions applied to a product. Possible values:
depositenabledexchangetradetransferDeposittransferWithdrawalvisiblewithdrawal
- priority integer
The priority index assigned to a product currency.
- linkInfo string or null
A link to an external 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.
THE PRODUCT CURRENCY OBJECT (FRONT OFFICE){ "id": 1, "caption": "USD", "product": { "id": 2, "type": "trade", "name": "MT5 Live", "group": { "id": 1, "caption": "MetaTrader5 Live", "description": "MetaTrader5 Live", "type": "default", "priority": 1, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00" }, "platform": { "id": 1, "caption": "MetaTrader5 Live", "shortCaption": null, "name": "mt5", "class": null, "isDemo": false } }, "currency": { "alphabeticCode": "USD", "minorUnit": 2, "name": "US Dollar", "numericCode": 840 }, "factory": 1, "variants": { "startAmounts": [ "100.00", "150.00" ], "leverages": [ 1, 5 ] }, "platformGroups": [ "Platform group name" ], "isHedgingEnabled": true, "maxAccounts": 1, "permissions": [ "deposit", "enabled", "trade", "withdrawal" ], "priority": 1, "linkInfo": "https://example.url", "agreementLink": "https://example.url" }
The Product Group (Front 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.
- 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.
THE PRODUCT GROUP OBJECT (FRONT OFFICE){ "id": 1, "caption": "Stable Coins", "description": "Stable Coins", "type": "default", "priority": 1, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00" }
The Product Note object (Front 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
The date and time when a note was last updated.
THE PRODUCT NOTE OBJECT (FRONT OFFICE){ "id": 1, "title": "Title", "value": "Text", "resources": [ { "key": "caption", "locale": "ru_RU", "value": "value" }, { "key": "caption", "locale": "ja_JP", "value": "value" } ] }
The Temporary Bonus object (Front Office)
This object provides the following data about a temporary bonus program:
- id integer
The identifier of a temporary bonus.
- amount number
The bonus amount that can be awarded to clients.
- name string
The name of a bonus program displayed to clients in the B2Core UI.
- default boolean
If
true, a bonus program is used as the default for all clients; otherwise,false.- currency object
The currency in which a temporary bonus is allocated. Only the trading accounts denominated in the specified currency can claim the temporary bonus.
- dynamicLots string
The volume that must be traded for bonus crediting.
- platform object
The details about the trading platform for which a bonus program is available.
Show object fields- id integer
The platform identifier.
- name string
The platform name.
- 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 so that the position volume is counted as traded volume.
- 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.- activatedAt string or null
The date and time when a bonus was activated.
- 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 last updated.
THE TEMPORARY BONUS OBJECT (FRONT OFFICE){ "id": 1, "amount": 100.00, "name": "MT4", "default": true, "currency": { "alphabeticCode": "USD", "minorUnit": 2, "name": "US Dollar", "numericCode": 840 }, "dynamicLots": "1.000", "platform": { "id": 1, "name": "MT4" }, "platformGroups": [], "lifetime": 30, "enableAutoCredit": true, "scalpingThreshold": 120, "disabledGroups": [ "USDCZK" ], "enableTrade": true, "activatedAt": "2022-01-01T00:00:00+00:00", "expiredAt": "2022-01-01T00:00:00+00:00", "createdAt": "2022-01-01T00:00:00+00:00", "updatedAt": "2022-01-01T00:00:00+00:00" }
The Ticket object (Front Office)
This object provides the following data about a ticket submitted to a help desk system:
- id integer
The ticket identifier.
- number integer
The number assigned to a ticket in SupportPal.
- status object
The details about the ticket status.
Show object fields- id integer
The status identifier.
- status string
The status assigned to a ticket in SupportPal. Possible values:
1— Opened2— Closed3— Awaiting4— In-Progress5— Pending6— Resolved7— Duplicate
- subject string
The ticket subject.
- lastReply object
The details about the latest ticket-related message that was sent to the support chat.
Show object fields- id integer
The message identifier.
- text string
The message text.
- attachments array
An array of objects specifying the attachments added to the latest message.
Show object fields- id integer
The attachment identifier.
- createTime string or null
The date and time when an attachment was added.
- updateTime string or null
The date and time when an attachment was last updated.
- directFrontendUrl string
The URL of a B2Core UI instance from which a ticket was submitted.
- originalName string
The name of the attached file.
- feature object
The attachment details.
- filename string
The name used to save the attached file to SupportPal.
- mime string
The file extension.
- size string
The size of the attached file.
- ticketId integer
The identifier of the ticket to which a message relates.
- createTime string
The date and time when a message was sent to the support chat.
- updateTime string
The date and time when a message was last updated.
- isSeen boolean
If
true, a message was viewed in the support chat; otherwise,false.
- createTime string
The date and time when a ticket was submitted by a client.
THE TICKET OBJECT (FRONT OFFICE){ "id": 1, "number": "222333", "status": { "id": 1, "name": "Open" }, "subject": "Ticket subject", "lastReply": { "id": 1, "text": "Ticket text", "attachments": [ { "id": 1, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00", "directFrontendUrl": "http://www.b2broker.net/main-room/", "originalName": "test.png", "feature": { "id": 1, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00", "filename": "filename.png", "mime": "png", "size": "2kb" } }, { "id": 2, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00", "directFrontendUrl": "http://www.b2broker.net/main-room/", "originalName": "test2.png", "feature": { "id": 1, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00", "filename": "filename2.png", "mime": "png", "size": "2kb" } } ], "ticketId": 1, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00", "isSeen": true }, "createTime": "2022-01-01T00:00:00+00:00" }
The Transaction object (Front Office)
This object provides the following data about a transaction:
- 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 an account to which funds were credited. See the Account object (Front Office) 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 an 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.
- 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.
- 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
- wallet object or null
The details about the wallet. Applicable only for deposit-type transactions made with B2BinPay.
Show object fields- address string
The blockchain address of the wallet from which funds were deposited.
- message string
The optional comment to a deposit transaction.
- createTime string or null
The date and time when the transaction was made.
- updateTime string or null
The date and time when the transaction status has last been updated.
THE TRANSACTION OBJECT (FRONT OFFICE){ “transactionId”: 235, “creditDetails”: { “account”: { “accountId”: 1, “accountNumber”: “1", “caption”: “USD”, “currency”: { “alphabeticCode”: “USD”, “name”: “USD”, “numericCode”: 840, “minorUnit”: 2 }, “favourite”: true, “group”: { “id”: 3, “name”: “Fiat”, “priority”: 2 }, “platform”: { “id”: 1, “name”: “eWallet” }, “priority”: 202, “statement”: { “availableBalance”: “2007.450000000000000000”, “currentBalance”: “2007.450000000000000000”, “credit”: “0.000000000000000000”, “equity”: “0.000000000000000000”, “freeMargin”: “0.000000000000000000”, “hold”: “1456.800000000000000000”, “margin”: “0.000000000000000000”, “marginLevel”: “0.000000000000000000”, “pnl”: “0.000000000000000000”, “updateTime”: “2022-10-20T11:04:07+00:00” }, “type”: “personal”, “createTime”: “2022-10-06T08:11:58+00:00” }, “amount”: “98100.0”, “commission”: “0.000000000000000000”, “currency”: { “alphabeticCode”: “USD”, “name”: “USD”, “numericCode”: 840, “minorUnit”: 2 } }, “debitDetails”: null, “foreignExchangeRate”: “9000”, “method”: { “id”: 1, “name”: “аа” }, “resolution”: null, “status”: “pending”, “type”: “deposit”, "wallet": { "address": "2NGWBeEcAau98dLd4CPyXfFTJCUViEXo81f", "message": "" }, “createTime”: “2022-10-20T11:04:27+00:00", “updateTime”: “2022-10-20T11:04:27+00:00" }The Verification Level object (Front 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 object or null
An array of string values specifying the groups which include the documents that must be submitted by clients.
THE VERIFICATION LEVEL OBJECT (FRONT OFFICE){ "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 Whitelisted Address object (Front Office)
This object provides the following data about a whitelisted withdrawal address:
- id integer
The identifier of a whitelisted withdrawal address.
- destinationTag string
The destination tag used to identify a transaction recipient.
- walletAddress string or null
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 Profile object to learn more.
- 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 for a client; 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.
THE WHITELISTED ADDRESS OBJECT (FRONT OFFICE){ "id": 1, "destinationTag": null, "walletAddress": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLi", "client": { "clientId": 1, "birthday": "2022-01-01T00:00:00+00:00", "country": { "countryId": 8, "alpha2Code": "US", "alpha3Code": "USA", "countryName": "United States", "callingCode": "+1", "numericCode": "840", "enabled": true }, "email": "jdoe@bexample.com", "locale": "en_US", "name": "John Doe", "nickname": "Super trader", "phone": "+995577755422" }, "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 (Front 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).
THE WIDGET OBJECT (FRONT OFFICE){ "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 Group object (Front Office)
This object provides the following data about a withdrawal group:
- id integer
The identifier of a withdrawal group.
- 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 displayed as a withdrawal group icon.
THE WITHDRAWAL GROUP OBJECT (FRONT OFFICE){ "id": 1, "description": "Group description", "caption": "Crypto", "name": "Cryptocurrencies", "icon": "example.png" }
The Withdrawal Method object (Front Office)
This object provides the following data about a withdrawal method:
- id integer
The identifier of a withdrawal method.
- name string
The withdrawal method name displayed to clients in the B2Core UI.
- icon string
The filename of an image that is displayed as a withdrawal method icon.
- libraryTimeToFund string
A hint displayed to clients in the B2Core UI about the period during which a withdrawal transaction is processed.
- caption string
The withdrawal method description.
- provider string
The name of a payment system used to make withdrawals.
- currencies array
An array of objects providing data about each transaction currency added to a withdrawal method.
Show object fields- min object
The data about the minimum amount that can be withdrawn in a transaction 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 transaction currency.
- max object
The data about the maximum amount that can be withdrawn in a transaction 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 transaction currency.
- icon string
The filename of an image displayed as a currency icon.
- caption string
The currency name displayed to clients in the B2Core UI.
- keyCaption string
The path to a list of localized strings that can be displayed as a currency caption.
- currency object
The details about a transaction currency.
Show object fields- alphabeticCode string
The alphabetic code of a currency.
- 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.
- psCurrencies array
An array of objects providing data about each payment currency added to a withdrawal method.
Show object fields- min object
The data about the minimum amount that can be withdrawn in a payment 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 payment currency.
- max object
The data about the maximum amount that can be withdrawn in a payment 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 payment currency.
- icon string
The filename of an image displayed as a currency icon.
- caption string
The currency name displayed to clients in the B2Core UI.
- keyCaption string
The path to a list of localized strings that can be displayed as a currency caption.
- currency object
The details about a payment currency.
Show object fields- alphabeticCode string
The alphabetic code of a currency.
- 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.
- vendorCommissions array
An array of objects providing data about commissions charged by a broker.
Show object fields- percent integer
The percentage of a withdrawal amount charged as a commission.
- min number
The minimum commission amount.
- max number
The maximum commission amount.
- fix number
The fixed commission amount.
- type string
The commission type.
- providerCommissions array
An array of objects providing data about commissions charged by a payment system.
Show object fields- percent integer
The percentage of a withdrawal amount charged as a commission.
- min number
The minimum charged commission amount.
- max number
The maximum charged commission amount.
- fix number
The fixed commission amount.
- type string
The commission type.
- hideAmount boolean or null
If
true, the Amount field is not displayed in the B2Core UI when clients withdraw funds using a withdrawal method; otherwise,false.- hideProceed boolean or null
If
true, the Proceed button is not displayed in the B2Core UI when clients withdraw funds using a withdrawal method; otherwise,false.- description string
The additional description of a withdrawal method.
- groups array
An array of objects providing data about withdrawal groups in which a withdrawal method is included. See the Withdrawal Group object to learn more.
THE WITHDRAWAL METHOD OBJECT (FRONT OFFICE){ "id": 1, "name": "B2BinPay", "icon": "image.png", "libraryTimeToFund": "Depending on the blockchain", "caption": "B2BinPay", "pretend": true, "provider": "B2BinPay", "currencies": [ { "min": { "value": "0.00", "scale": 2 }, "max": { "value": "0.00", "scale": 2 }, "currency": { "alphabeticCode": "BTC", "minorUnit": 8, "name": "BTC", "numericCode": 1000 } } ], "psCurrencies": [ { "min": { "value": "0.00", "scale": 2 }, "max": { "value": "0.00", "scale": 2 }, "currency": { "alphabeticCode": "USD", "minorUnit": 2, "name": "US Dollar", "numericCode": 840 } } ], "vendorCommissions": [ { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 840 }, { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 1000 } ], "providerCommissions": [ { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 840 }, { "percent": 1, "min": 1, "max": 1, "fix": 1, "type": "default", "numericCode": 1000 } ], "hideAmount": true, "hideProceed": false, "description": "Additional withdrawal method description", "groups": [ { "id": 3, "description": "Group description", "caption": "Crypto", "name": "Cryptocurrencies", "icon": "image.png" } ] }
The Withdrawal Template object (Front 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.
- data object
The data specific to a withdrawal method.
Show object fields- wallet_address string
The address of the wallet to which funds are to be withdrawn.
- comment string
The optional comment to a withdrawal transaction.
- method object
The details about the method used to withdraw funds.
Show object fields- id integer
The identifier of a withdrawal method.
- name string
The method name used in the Back Office.
- caption object or null
The method name displayed to clients in the B2Core UI.
- currency object
The details about the currency in which a withdrawal transaction is made. See the Currency object to learn more.
- group string
The details about the group in which a withdrawal method is included. See the Withdrawal Group object to learn more.
- isWhitelisted boolean
If
true, the withdrawal address saved with a template is added to a client whitelist; otherwise,false.- 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.
THE WITHDRAWAL TEMPLATE OBJECT (FRONT OFFICE){ "id": 1, "name": "My withdrawal template", "accountId": 275, "amount": "0.0001", "amountTo": null, "data": { "data": { "wallet_address": "2NGWBeEcAau98dLd4CPyXfFTJCUViEXo81f", "comment": "Withdrawal via B2BinPay" }, "method": { "id": 1, "name": "b2binpay_btc", "caption": "B2BinPay BTC" }, "currency": { "alphabeticCode": "BTC", "name": "Bitcoin", "numericCode": 1000, "minorUnit": 8 }, "group": { "id": 1, "name": "Crypto", "caption": "Crypto", "icon": "example.png" } }, "isWhitelisted": false, "clientId": 1, "createTime": "2022-01-01T00:00:00+00:00", "updateTime": "2022-01-01T00:00:00+00:00" }