List settlement payouts for account

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "broker-openapi MCP server": {
    "url": "https://bump.sh/tie-tech/hub/b2b-api/doc/broker-openapi/mcp"
  }
}

Close
GET /trading/accounts/{account_id}/payouts

Headers

  • PRE-ACCESS-KEY string Required

    Broker access key identifier.

    Format should match the following pattern: ^[A-Za-z0-9._~-]{1,64}$.

  • PRE-ACCESS-SIGNATURE string Required

    Keyed BLAKE2b-256 signature (hex lowercase, 64 characters).

    Format should match the following pattern: ^[0-9a-f]{64}$.

  • PRE-ACCESS-TIMESTAMP string(date-time) Required

    RFC3339 timestamp with milliseconds (e.g., 2025-10-30T06:00:34.075Z). Must be within clock_skew_tolerance (default 5m) of server time.

Path parameters

  • account_id string Required

    Broker-supplied account identifier; length 1..128; charset [A-Za-z0-9._~-].

    Maximum length is 128. Format should match the following pattern: ^[A-Za-z0-9._~-]{1,128}$.

Query parameters

  • market_id string

    Filter payouts by specific market ID

  • event_id string

    Filter payouts by specific event ID

  • cursor string
  • limit integer

    Minimum value is 1, maximum value is 100. Default value is 50.

Responses

  • 200 application/json

    Payout list

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • market_id string Required

        Identifier of the settled market

      • account_id string Required

        Account identifier

      • qty_held_at_settlement object Required

        Net position at settlement. Positive (+) values indicate Long (YES) contracts held. Negative (-) values indicate Short (NO) contracts held.

        Hide qty_held_at_settlement attributes Show qty_held_at_settlement attributes object
        • units integer(int64) Required
        • nanos integer(int32) Required

          Minimum value is -999999999, maximum value is 999999999.

      • settlement_price object Required
        Hide settlement_price attributes Show settlement_price attributes object
        • units integer(int64) Required
        • nanos integer(int32) Required

          Minimum value is -999999999, maximum value is 999999999.

      • payout_amount object Required
        Hide payout_amount attributes Show payout_amount attributes object
        • units integer(int64) Required
        • nanos integer(int32) Required

          Minimum value is -999999999, maximum value is 999999999.

      • settled_at_wall_time_ns integer(int64) Required

        UTC timestamp (nanoseconds) when the settlement was recorded

    • next_cursor string | null
  • 400 application/json

    Validation / semantic error

    Hide response attributes Show response attributes object
    • error_code string Required
    • message string Required
    • details object

      Additional properties are allowed.

  • 503 application/json

    Backpressure / temporary unavailability

    Hide response attributes Show response attributes object
    • error_code string Required
    • message string Required
    • details object

      Additional properties are allowed.

GET /trading/accounts/{account_id}/payouts
curl \
 --request GET 'https://api.example.com/v1/trading/accounts/{account_id}/payouts' \
 --header "PRE-ACCESS-KEY: string" \
 --header "PRE-ACCESS-SIGNATURE: string" \
 --header "PRE-ACCESS-TIMESTAMP: 2026-05-04T09:42:00Z"
Response examples (200)
{
  "items": [
    {
      "market_id": "TRUMP-WIN-2024",
      "account_id": "broker-client-1",
      "qty_held_at_settlement": {
        "units": 10,
        "nanos": 0
      },
      "settlement_price": {
        "units": 1,
        "nanos": 0
      },
      "payout_amount": {
        "units": 10,
        "nanos": 0
      },
      "settled_at_wall_time_ns": 1701388800000000000
    }
  ],
  "next_cursor": "string"
}
Response examples (400)
{
  "error_code": "string",
  "message": "string",
  "details": {}
}
Response examples (503)
{
  "error_code": "string",
  "message": "string",
  "details": {}
}