MultiMarkets API Docs en
HomeGitHubReferenceLanguage
  • Overview
  • Quick Start
    • Status
  • CLIENT API
    • Overview
    • Access
      • Sign
      • Request
      • Limit
      • Error Code
      • API Address
      • API Code
    • Login
      • Captcha
    • Customer
      • Customer registration
      • Replacement Token
      • API Management
        • Apply API
        • Set permissions
        • Delete API
    • Market Data
      • Introduction
      • Limit
      • Error Code
      • Subscribe
        • Ticker
        • Market
        • Cancel
      • Query
        • Heartbeat
        • Historical K-line
    • Open API
      • Readme
        • Sign
        • Request
        • Error Code
        • API Address
      • Order Process
      • Base
        • Symbol Base Info
      • Customer
        • Customer Info
      • Trade
        • Contract order
      • Message
        • Get Msg Token
        • Msg Subscribe
        • Get Msg Token
        • Msg Subscribe
      • More...
    • Auth2 API
      • Readme
      • Auth Code
      • Access Token
      • User Info
      • Refresh Token
    • More...
  • Manager API
    • Overview
    • Access
      • Sign
      • Request
      • Limit
      • Error Code
      • API Address
      • API Code
    • Authorize
    • Basic data
      • Universal dictionaries
      • Company currency
    • Product
      • Product List
    • Customer
      • Customer List
      • Customer registration
      • Customer info
      • Customer Group
      • Account Info
    • Funds
      • Balance Update
      • Get Balance
    • Data Push
    • More...
  • Bridge API
    • Overview
    • Access Instructions
      • Illustrate
      • Sign
      • Request
      • Speed ​​Limit
      • Error Code
      • Product List
    • Basic data
      • Get a list of universal dictionaries
      • Obtain company currency permissions
    • Product Data
      • Product information list
      • Product rule list
    • Customer Management
      • Customer registration
      • Customer list
      • Customer details
      • Customer account cancellation
    • Account Management
      • Add account
      • Update account
      • Check account
      • Delete account
    • Trading interface
      • Check balance
      • Check deposit records
      • Check withdrawal records
      • Query transfer records
      • Place an order
      • Query order
      • Order list
      • Transaction record
      • Current pending order
      • Cancel order
    • News Subscription
      • Notification message description
      • Webhook subscription
      • Information callback notification
  • Webhook API
    • Overview
    • Account balance
    • Execute adjustment balance
    • Cancel adjustment balance
  • Message API
    • Overview
    • Custom message API
  • WEB IFRAME
    • Introduction
    • Process description
  • FAQ
    • How to apply for apikey for an interface?
    • What is the purpose of the public key?
    • What is the interface request timeout?
    • Supported development languages?
    • What are the API call restrictions?
    • How to use APIs more safely?
  • API Reference
    • Manager API
    • Client API
  • CHANGELOGS
    • API
Powered by GitBook
On this page
  1. Webhook API

Execute adjustment balance

PreviousAccount balanceNextCancel adjustment balance

Last updated 11 months ago

# External System Credit Limit Adjustment

1: When a user places an order within the TradeBoss platform, the platform sends this request to an external system. The external system must respond within 3 seconds, otherwise the TradeBoss platform will consider it as a timeout and cancel the operation. At the same time, it will also send a "Cancel external system credit limit adjustment" request to maintain data consistency with the external system.

2: It is important to note that when calling the "Cancel external system credit limit adjustment" interface, if any exceptions occur or if a correct response is not received, there will be specified retries before aborting subsequent operations.

  • # External System Credit Limit Adjustment
  • POSTExternal System Credit Limit Adjustment

External System Credit Limit Adjustment

post

1: When a user places an order within the TradeBoss platform, the platform sends this request to an external system. The external system must respond within 3 seconds, otherwise the TradeBoss platform will consider it as a timeout and cancel the operation. At the same time, it will also send a "Cancel external system credit limit adjustment" request to maintain data consistency with the external system.

2: It is important to note that when calling the "Cancel external system credit limit adjustment" interface, if any exceptions occur or if a correct response is not received, there will be specified retries before aborting subsequent operations.

Header parameters
tracestringRequired

Global Link Identifier.

Example: {{mockTrace}}
companyIdintegerRequired

Company Id,User's company ID

Example: {{companyId}}
timestampnumberRequired

Request initiation timestamp, accurate to the millisecond, 13 digits.

Body
thirdServerCodestringRequired

Third-party system customer unique identifier

userNamestring · max: 48Required

TradeBoss user identity unique identifier

currencystring · max: 16Required

Account currency code, standard ISO 3-character currency unit.

bizTypeintegerRequired

Business types: 1 - Market order open; 2 - Market order close; 10 - Limit price stop order; 11 - Stop loss stop order; 12 - Limit price open

operationTypestringRequired

The operation types are OPEN_POSITION for opening a position, NORMAL_CLOSE for normal closing, and ABNORMAL_OVERTRADING for abnormal overtrading. When the operation type is NORMAL_CLOSE or OPEN_POSITION, the amount can only be a positive number. When it is ABNORMAL_OVERTRADING, the amount should be negative. The third-party system can decide whether to continue deducting quotas to complete this transaction or ignore this request.

amountstringRequired

Amount, used in conjunction with operationType.

amountDigitsintegerRequired

Amount decimal places.

orderIdinteger · longRequired

Order ID.

requestUniqueNostring · max: 48Required

Request for a unique identifier, multiple requests need to maintain business idempotence.

requestTimeinteger · longRequired

Request initiation timestamp, accurate to the millisecond, 13 digits

ipstringRequired

User IP

metadatastring · max: 200Optional

Remarks information, in JSON format.

Responses
200
成功
application/json
post
POST /api/cats-gateway/external-system-credit-limit-adjustment HTTP/1.1
Host: prewppc-3.cmfbl.com
trace: text
companyId: 1
timestamp: 1
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "tradeType": 81,
  "accountId": 15,
  "sortType": "desc",
  "sortFieldName": "orderTime",
  "accountCurrency": "USDT"
}
200

成功

{
  "msgParams": "veniam sit",
  "msg": "anim nisi consectetur sit sed",
  "trace": "laboris",
  "tm": 62,
  "bizCode": "10",
  "data": {},
  "code": "100",
  "fail": false,
  "ok": true
}