FAQ

To change a trading account's group, you need to update its associated offer. Use the following endpoint:

 
curl --location --request PATCH '{{baseURL}}/v1/trading-account?systemUuid={{systemUuid}}&login={{login}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{APIkey}}' \
--data '{
  "offerUuid": "{{offer_uuid}}"
}'

This will move the trading account to the new offer (and consequently to the new group).

Passwords are associated with the user account (not with individual trading accounts). To change a password, use:

 
POST /v1/change-password

The system will automatically encrypt the new password. Neither you nor the Match-Trade system will have access to the plain text password after this change.

To get all trading accounts associated with a specific user account:

 
GET /v1/trading-accounts?query={{email}}

This will return all trading accounts linked to the specified account email.

To check the current balance and equity of a trading account:

 
GET /v1/trading-account?systemUuid={{systemUuid}}&login={{tradingAccountLogin}}

This will return the current balance, equity, and other financial information for the specified trading account.

• Branch is used in our CRM, e.g., for organizing clients by country. For external integrations, the "Default" branch should be used, which is always set up by Match-Trade.
• The system is an internal service that connects the platform to the backend. There is only one, and it is unchangeable per server. The Match-Trade team configures it.
• Operation is an internal service responsible for the proper creation of accounts. There is only one and it is unchangeable, set up during the client’s setup by Match-Trade.

Some endpoints require the UUIDs of these services, which can be obtained, for example, from the endpoint:

 
GET /v1/offers

Equity = Balance + Credit

• Balance includes deposits and closed trade results. 
• Credit is extra funds (e.g., bonuses) that cannot be withdrawn.

Credit allows an account to have a negative balance if it has been granted. For example, if an account has a balance of $100 and a credit of $50, and will lose $130, the balance will be -$30, while the credit will remain $50.

To change the leverage on a trading account, you need to retrieve the systemUuid and the trading account login. Then, send the following request:

 
curl --location --request PUT '{{baseURL}}/v1/trading-account/leverage?systemUuid={{systemUuid}}&login={{login}}' \
--header 'Authorization: {{APIkey}}' \
--header 'Content-Type: application/json' \
--data '{
  "leverage": "100"
}'

A 204 status indicates that the leverage has been successfully changed.

The trading account parameters such as currency, leverage, account type (Demo or Real) and more, are determined by the settings of the group and the corresponding offer in the Match-Trader system. If you want to create, for example, a Demo trading account with 1:30 leverage and currency set to EUR, you first need to:

1. Create a group in the admin panel (backend) with the desired parameters.
2. Create an offer assigned to that group, with EUR as the currency, leverage set to 30, and the Demo type enabled.

Once the group and offer are configured, you can send a request to create the account: For a usser account:

 
POST {{baseURL}}/v1/accounts

For a trading account under an exsiting user account:

 
POST {{baseURL}}/v1/accounts/{{accountUuid}}/trading-accounts 

Make sure to include the offerUuid in the request body. The system will then create the trading account using the parameters defined in the selected offer.

An Offer is a trading account configuration created and managed manually in the CRM. It cannot be created or modified via API - the API allows read-only access (GET) to Offer data.

An Offer maps to a specific trading group configured in the trading system backend (admin). That group defines all detailed trading conditions for the trader, such as commissions, markups, symbols, execution rules, and other broker-specific settings.

For the end user (trader):

• the Offer name is displayed in the top-left corner of the trading platform,
• the Offer type (e.g. Demo or Real) is clearly indicated.

From a functional perspective, an Offer defines:

• what type of trading account will be created for the client,
• with which basic parameters, such as: real or demo account, trading system (e.g. MTT / MT5), account currency, initial leverage and more.

An Offer must exist in order to create a trading account correctly. It is mandatory when creating a trading account via API - the request must include a valid offerUUID.

Based on the provided offerUUID, the system automatically creates the trading account using the configuration defined in the Offer and its mapped trading group.