buymeamalt.Register an application ↗

BMM CONNECT DOCUMENTATION

OAuth earnings

Read earnings with an existing support:read grant.

GET/api/connect/v1/me/support

Authentication and parameters

Send Authorization: Bearer ACCESS_TOKEN, X-BMM-Client-ID and X-BMM-API-Key. No body is required. Requires support:read and current earnings consent.

Request and response

sh
curl "$BMM_ORIGIN/api/connect/v1/me/support" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-BMM-Client-ID: $BMM_CLIENT_ID" \
  -H "X-BMM-API-Key: $BMM_API_KEY"
json
{
  "support": [
    { "currency": "NGN", "settled_earnings_minor": 1000000, "verified_payment_count": 8 },
    { "currency": "USD", "settled_earnings_minor": 2500, "verified_payment_count": 2 }
  ]
}

Label this Support received through [your platform], with Settled earnings as the amount description. This is lifetime net credited earnings minus refunds and protective refund deductions, not an available or withdrawable balance. Withdrawals do not reduce these totals.

Amounts are integer minor units: 1000000 NGN means ₦10,000; 2500 USD means $25. Display each currency separately; never add them together without a separate, explicit conversion. Both supported currencies are returned, with zero values when there is no matching activity.

BMM uses existing verified credit after fees, minus its refund deductions. Pending refund holds reduce the figure conservatively until reconciliation resolves them. Verified payment counts include payments subsequently refunded, but not pending attempts. Only this creator’s earnings attributed to your application in this environment are included, including earlier connections to the same application. Other partners and direct contributions are excluded.

The endpoint requires both support:read and current earnings consent, including for payment counts. A 403 means hide earnings/counts, not “zero earnings”. Keep the profile and support button available.

Errors

400 can indicate an invalid callback or invalid/expired grant. 401 indicates credential or access failure. 403 on earnings means permission was not granted. 429 requires backoff. OAuth errors may contain error and error_description; use status and error code, not matching descriptions. Errors and recovery.

← All endpoints