Introduction

Sections

Introduction
- Integration Guide for CRM with Match-Trader Platform
- Single Sign-On (SSO) Integration Guide for External Applications
Authentication
gRPC
Errors
- gRPC Error Handling
- Examples
Branches, Offers, Roles
Accounts
Payments
Trading
Prop Trading
Social Trading
- Retrieve Money Managers Leaderboard
- Retrieve Single Money Manager Statistics
CRM Events
- Webhooks
- gRPC
  - PBTimelineServiceExternal
Prediction Market
FAQ

Get Withdrawals Info

This endpoint retrieves the maximum amount that the user is eligible to withdraw from their challenge. This takes into consideration factors such as account balance, initial balance, and profit split. This endpoint is essential to understand current withdrawal capacity.

Header Parameters

Authorizationstring

Path Parameters

propAccountUuidstring

Response

200

Object

Response Attributes

maxAmountnumber

The total profit made by the trader may be withdrawn. Does not include the profit split

profitSplitobject

Show child attributes

nextWithdrawalDaysstring

lastWithdrawalDatestring

awaitingRequestsboolean

Sections

Get Withdrawals Info

Header Parameters

Path Parameters

ResponseExpand all

Response Attributes

Response

Response