Skip to content

Conduct balance operation MT5#

About#

Conduct balance operation MT5.

POST /users/current/mt5/provisioning-profiles/:profileId/accounts/:login/manageBalance

For more information see swagger documentation

Headers#

Name Type Required Description
auth-token string Yes MetaApi account token. See Authentication & authorization

Path parameters#

Name Type Required Description
profileId string Yes Id of the provisioning profile that will be used as the basis
login number Yes MT5 account login

Body#

Name Type Required Description
amount number Yes The amount to add or subtract from an account. In order to deposit to the account, specify a positive value; to withdraw, specify a negative value
type string Yes Type of the balance operation enum: DEAL_BALANCE, DEAL_CREDIT
comment string A comment to a balance operation

Response#

  • 200 - Successfully conduct balance operation.
  • 400 - Validation failed. Response schema: Error
  • 401 - Authorization failed. Response schema: Error
  • 403 - user is not permitted to create account. Response schema: Error
  • 404 - Provisioning profile with specified id not found. Response schema: Error

Examples#

Example request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'auth-token: token' -d '{
  "amount": 100,
  "type": "DEAL_BALANCE",
  "comment": "Deposit"
}' 'https://mt-manager-api-v1.vint-hill.agiliumtrade.ai/users/current/mt5/provisioning-profiles/profileId/accounts/login/manageBalance'

Example response:

{
  "dealId": 86053193
}