List Commission Accounts

Retrieves a paginated list of commission accounting configurations.

This endpoint returns information about pool accounts and commission accounts associated with different currencies, providing visibility into how commissions are managed and allocated financially.

Endpoint

GET/v2/billing/commission/account

Link

Gateway APIstagep.tst-apidmndelss.com

Request

Authentication

An API key is required for authentication. Include it in the Authorization header.

• Header: Authorization
• Value: Your API key token

HTTP Method & URL

• Method: GET
• URL: https://stagep.tst-apidmndelss.com/v2/billing/commission/account

Headers

Key	Value	Required
Authorization	Bearer <JWT>	Yes
Accept	application/json	Yes

---

Response (200 OK)

Returns a paginated list of commission account configurations with metadata.

Response Fields

Meta Object (meta)

Field	Type	Description	Example
pageSize	integer	Items per page.	50
page	integer	Current page number.	0
total	string	Total accounts available.	"25"

Commission Account Object (items[])

Field	Type	Description	Example
currencyIso	string	Currency ISO code.	USD
poolAccountId	string	Pool account identifier.	pool_acc_123abc
commissionAccountId	string	Commission account identifier.	comm_acc_456def

Example Response:

{
  "items": [
    {
      "currencyIso": "USD",
      "poolAccountId": "pool_acc_123abc",
      "commissionAccountId": "comm_acc_456def"
    },
    {
      "currencyIso": "EUR",
      "poolAccountId": "pool_acc_789ghi",
      "commissionAccountId": "comm_acc_012jkl"
    },
    {
      "currencyIso": "GBP",
      "poolAccountId": "pool_acc_345mno",
      "commissionAccountId": "comm_acc_678pqr"
    }
  ],
  "meta": {
    "pageSize": 50,
    "page": 0,
    "total": "25"
  }
}

---

Examples

Basic Request (cURL)

curl --request GET \
  --url https://stagep.tst-apidmndelss.com/v2/billing/commission/account \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJhbGci...wNLGA'

---

Error Responses

1. Unauthorized:

   { "error": "Unauthorized" }

2. Invalid Request:

   { "error": "Invalid parameters" }

---

Notes

Account Types Explanation

• poolAccountId: Refers to the main account where funds are pooled for a specific currency before commission distribution
• commissionAccountId: Refers to the specific account where commission earnings are accumulated for the partner
• Each currency typically has separate pool and commission accounts

Pagination

• The endpoint supports pagination through the meta object
• Use page and pageSize parameters if supported (though not shown in request parameters)
• The total field indicates the total number of commission accounts available

Best Practices

• Cache this information as it doesn't change frequently
• Use the account IDs for financial reconciliation and reporting
• Monitor for new currencies being added to the system
• Integrate with accounting systems using these account identifiers

Common Use Cases:

• Financial reconciliation and reporting
• Commission earnings tracking
• Accounting system integration
• Audit and compliance reporting
• Currency-wise commission management

Integration Examples:

• Syncing with accounting software like QuickBooks or Xero
• Automated financial reporting systems
• Commission payout processing systems
• Audit trail generation for financial compliance

Security Considerations:

• Account IDs are sensitive financial information
• Access should be restricted to authorized financial personnel
• Consider masking account IDs in user interfaces
• Ensure secure storage and transmission of financial data

Typical Workflow:

1. Retrieve commission accounts list
2. Use account IDs for financial reconciliation
3. Monitor commission accruals in commission accounts
4. Process commission payouts from pool accounts
5. Generate financial reports using account identifiers

Request sample

Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxNTczODIyLCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.OP992847T1VlkgUa0zx9Wc8Zp17_KdzaZ4DcE-KtoRE

Response sample

{
  "items": [
    {
      "currencyCode": "BTC",
      "poolAccountId": "BoaZoNne9k9h",
      "commissionAccountId": "BoaZoNne9k9h"
    },
    {
      "currencyCode": "ETH",
      "poolAccountId": "EIji1yB6o6I6",
      "commissionAccountId": "EIji1yB6o6I6"
    },
    {
      "currencyCode": "EUR",
      "poolAccountId": "EgiHENynfhYe",
      "commissionAccountId": "EgiHENynfhYe"
    },
    {
      "currencyCode": "USD",
      "poolAccountId": "UcJlzOBpEhCE",
      "commissionAccountId": "UcJlzOBpEhCE"
    },
    {
      "currencyCode": "USD",
      "poolAccountId": "UnLHMfwnumW7",
      "commissionAccountId": "UnLHMfwnumW7"
    },
    {
      "currencyCode": "USDC_ERC20",
      "poolAccountId": "UG1Gfm2MM4rV",
      "commissionAccountId": "UG1Gfm2MM4rV"
    },
    {
      "currencyCode": "USDT_ERC20",
      "poolAccountId": "U66YAuLlvhj5",
      "commissionAccountId": "U66YAuLlvhj5"
    },
    {
      "currencyCode": "USDT_TRC20",
      "poolAccountId": "Ur4dSIJ9gJ5v",
      "commissionAccountId": "Ur4dSIJ9gJ5v"
    }
  ],
  "meta": null
}