Wallet API

Check wallet balance, estimate payout amounts, and manage wallet transactions.

Get Wallet Details

GET/api/v1/wallet
Requires API Key

Returns wallet balance and details for the authenticated user.

Success Response

200
{
  "success": true,
  "data": {
    "balance": 10000.5,
    "currency": "USD",
    "availableBalance": 9500,
    "pendingBalance": 500.5,
    "lastUpdated": "2024-01-01T12:00:00Z"
  }
}

Estimate Payout Amount

POST/api/v1/wallet/estimate-payout
Requires API Key

Calculates fees and net amount for a payout before processing.

Request Body

{
  "amount": 500.00,
  "currency": "USD"
}

Request Parameters

ParameterTypeRequiredDescription
amountnumberYesPayout amount
currencystringYesCurrency code (3 letters)

Success Response

200
{
  "success": true,
  "data": {
    "grossAmount": 500,
    "fee": 2.5,
    "netAmount": 497.5,
    "currency": "USD"
  }
}