Skip to content

GetCopyTradeRewards

Endpoint

GET /copytrade/rewards

Authorization

Requires SESSION_CUSTOMER.

Description

Returns reward accruals where either master_login or follower_login belongs to the authenticated customer.

Profit-share-per-trade rewards are created automatically when a copied follower trade closes with positive profit. Settlement uses follower balance-out and master payout balance-in operations with TR_REASON_COPY_REWARD.

The endpoint uses the standard table filter payload. Supported request fields:

  • limit
  • offset
  • where
  • whereNot
  • whereIn
  • whereNotIn
  • whereBetween
  • whereNotBetween
  • orderBy

The response is returned as a table: structure, rows, count.

Response

{
  "structure": [
    "id",
    "subscription_id",
    "master_login",
    "follower_login",
    "payout_account_login",
    "reward_type",
    "source_order",
    "charge_order",
    "payout_order",
    "period_from",
    "period_to",
    "base_amount",
    "fee_amount",
    "currency",
    "state",
    "failure_reason",
    "created_time",
    "updated_time"
  ],
  "rows": [
    [1, 10, 100001, 100002, 100001, 3, 123456, 123457, 123458, 1778160000, 1780838400, 1000, 200, "USD", 2, "", 1780838400, 1780838400]
  ],
  "count": 1
}

Errors

HTTP Error Description
401 INVALID_CUSTOMER_SESSION Customer session is missing or invalid
400 INVALID_DATA Filter payload is invalid