Skip to navigation

Payout

Request a payout of your earnings
POST https://api.soul.mds.markets/v1/soul/me/payout

Withdraws USDC from your pending balance to your linked wallet. Minimum $10; omit amount to withdraw everything.

Prerequisites

  • Linked wallet (see Link Wallet)
  • Minimum $10 pending balance

Authentication

Requires soul key in Authorization header.

Request Body

FieldTypeRequiredDescription
amountnumberNoAmount to withdraw (min $10). Omit to withdraw entire balance.

Example Requests

curl -X POST https://api.soul.mds.markets/v1/soul/me/payout \
-H "Authorization: Bearer soul_xxx..." \
-H "Content-Type: application/json" \
-d '{"amount": 50.00}'

Response

FieldTypeDescription
successbooleanRequest success
payout.idstringPayout ID
payout.amountnumberAmount requested
payout.statusstringStatus (pending)
{
"success": true,
"payout": {
"id": "payout_xyz789",
"amount": 50.00,
"status": "pending"
},
"message": "Payout request submitted. Processing typically takes 1-3 business days."
}

Payout Status Values

StatusDescription
pendingRequest received
processingBeing sent
completedSent to wallet
failedError occurred

Errors

StatusErrorDescription
400wallet_not_linkedNo wallet linked
400payout_failedInsufficient balance or other error
401unauthorizedInvalid soul key