DRdrivewealth
Commission Schedules

List Commission Schedules

Retrieves a list of Commissions Schedules by accountID.

get/accounts/{accountID}/commissions

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/accounts/{accountID}/commissions
  • Auth
    HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

Response

Retrieving a list of Commissions Schedules was Successful.

activeboolean

Commission group status.

commissionIDstring

The unique identifier associated with a specific commission related to the account.

descriptionstring

A short description about the commission.

Example response

[
  {
    "active": true,
    "commissionID": "123e4567-e89b-12d3-a456-000000000017",
    "description": "Free",
    "assignmentCriteria": {
      "wplID": "TTC",
      "countries": "USA",
      "defaultStatus": true
    },
    "rates": {
      "fractional": {
        "schema": {
          "rate": 1.49,
          "passThroughFees": true,
          "shareAmountRounding": "CEIL",
          "minimumRate": 1.49
        }
      },
      "default": {
        "schema": {
          "rate": 1.49,
          "passThroughFees": true,
          "shareAmountRounding": "CEIL",
          "minimumRate": 1.49
        }
      }
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.