> ## Documentation Index
> Fetch the complete documentation index at: https://tickblaze.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Check potential withdrawal details

> Return estimated payout details and the next withdrawal date for a user's account.



## OpenAPI

````yaml /openapi.json get /api/withdrawals/{account_id}/request/
openapi: 3.0.3
info:
  title: TBBO API
  version: 1.0.0
  description: >
    Authentication uses short-lived session tokens (3 hours).


    Send the token with every request using the `Authorization` header:


    ```

    Authorization: Token <token>

    ```


    Example:


    ```

    Authorization: Token 123abc456def789

    ```


    To obtain a token, call `POST /auth/login/` with valid credentials. The
    response includes a `key` value. Use that value in the header above for
    subsequent API calls.


    How to find required IDs:


    - `challenge_id`: Prop Tech Configuration -> Challenges

    - `user_id`: Tickblaze Manager -> Users

    - `account_id`: Tickblaze Manager -> Accounts 
servers: []
security: []
tags:
  - name: withdrawals
    description: Withdrawal related endpoints
    x-displayName: Withdrawals
paths:
  /api/withdrawals/{account_id}/request/:
    get:
      tags:
        - withdrawals
      summary: Check potential withdrawal details
      description: >-
        Return estimated payout details and the next withdrawal date for a
        user's account.
      operationId: api_withdrawals_request_retrieve
      parameters:
        - in: path
          name: account_id
          schema:
            type: integer
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithdrawalDetails'
              examples:
                PotentialWithdrawalDetailsExample:
                  value:
                    profit_split: 0.2
                    client_payout: 350
                    withdrawable_profit: 500
                    on_demand: false
                    next_withdrawal_date: '2024-07-15'
                  summary: Potential Withdrawal Details Example
          description: Potential withdrawal details provided.
        '403':
          description: Withdrawal is not allowed for the requested account.
        '404':
          description: Account not found.
      security:
        - tokenAuth: []
components:
  schemas:
    WithdrawalDetails:
      type: object
      properties:
        profit_split:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          description: The fraction of available funds the user will receive.
        client_payout:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        withdrawable_profit:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
        on_demand:
          type: boolean
        next_withdrawal_date:
          type: string
          format: date
      required:
        - client_payout
        - next_withdrawal_date
        - on_demand
        - profit_split
        - withdrawable_profit
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.