Earnings

Authentication and permissions

Send X-BMM-Client-ID and X-BMM-API-Key from your server. The API key authenticates the approved application; creator consent controls access to the account. A key alone does not authorise access to a creator.

Also send X-BMM-User-ID, derived from your authenticated server session. No request body is required. Never accept an arbitrary browser-selected user ID.

Requires an active connection and explicit earnings consent. Check earnings_shared on the profile first, then handle a 403 if consent changes.

Request

curl -X GET "$BMM_ORIGIN/api/connect/hosted/me/support" \
  -H "X-BMM-Client-ID: $BMM_CLIENT_ID" \
  -H "X-BMM-API-Key: $BMM_API_KEY" \
  -H "X-BMM-User-ID: $AUTHENTICATED_PARTNER_USER_ID"

Success response

{
  "support": [
    {
      "currency": "NGN",
      "settled_earnings_minor": 1000000,
      "verified_payment_count": 8
    },
    {
      "currency": "USD",
      "settled_earnings_minor": 2500,
      "verified_payment_count": 2
    }
  ]
}

Amounts, refunds and permissions

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 current earnings consent (OAuth integrations additionally need support:read), including for payment counts. A 403 means hide earnings/counts, not “zero earnings”. Keep the profile and support button available.

Missing/revoked connections return 404. Missing consent returns 403; hide the earnings section, not the profile.

Errors

Errors contain {"error":"message"}. Do not match error text or cache private responses. Full error guide.