Get Payout Balance

Returns the payout balance (available / pending / instant, plus paid-out when scoped to an event), grouped by currency. Money is in cents.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Query Parameters

eventIdstring

Scope the balance to one event; omit for account-wide

GET/v1/events/balance

curl -X GET "https://api.3common.com/v1/events/balance?eventId=string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "available_balance": {
        "balance": 0,
        "net": 0,
        "gross": 0,
        "fees": 0,
        "currency": "string",
        "orders": [
          {
            "_id": null,
            "gross": 0,
            "fees": 0,
            "threeCFee": 0,
            "stripeFee": 0,
            "refundedAmount": 0,
            "latest_charge": "string",
            "event_id": "string",
            "property1": null,
            "property2": null
          }
        ],
        "account_limit": 0
      },
      "pending_balance": {
        "balance": 0,
        "net": 0,
        "gross": 0,
        "fees": 0,
        "currency": "string",
        "orders": [
          {
            "_id": null,
            "gross": 0,
            "fees": 0,
            "threeCFee": 0,
            "stripeFee": 0,
            "refundedAmount": 0,
            "latest_charge": "string",
            "event_id": "string",
            "property1": null,
            "property2": null
          }
        ],
        "account_limit": 0
      },
      "instant_balance": {
        "balance": 0,
        "net": 0,
        "gross": 0,
        "fees": 0,
        "currency": "string",
        "orders": [
          {
            "_id": null,
            "gross": 0,
            "fees": 0,
            "threeCFee": 0,
            "stripeFee": 0,
            "refundedAmount": 0,
            "latest_charge": "string",
            "event_id": "string",
            "property1": null,
            "property2": null
          }
        ],
        "account_limit": 0
      },
      "paid_out_balance": {
        "balance": 0,
        "net": 0,
        "gross": 0,
        "fees": 0,
        "currency": "string",
        "orders": [
          {
            "_id": null,
            "gross": 0,
            "fees": 0,
            "threeCFee": 0,
            "stripeFee": 0,
            "refundedAmount": 0,
            "latest_charge": "string",
            "event_id": "string",
            "property1": null,
            "property2": null
          }
        ],
        "account_limit": 0
      },
      "currency": "string"
    }
  ]
}

TypeScript

export interface Response {
  data: {
    available_balance: {
      /**
       * Net available to the host, in cents.
       */
      balance: number;
      /**
       * Gross minus fees minus refunds, in cents.
       */
      net: number;
      /**
       * Gross total, in cents.
       */
      gross: number;
      /**
       * Fees total, in cents.
       */
      fees: number;
      /**
       * Currency code; null on an empty bucket.
       */
      currency: string | null;
      orders: {
        _id?: unknown;
        gross?: number;
        fees?: number;
        threeCFee?: number;
        stripeFee?: number;
        refundedAmount?: number;
        latest_charge?: string;
        event_id?: string;
        [k: string]: unknown;
      }[];
      account_limit?: number;
    };
    pending_balance: {
      /**
       * Net available to the host, in cents.
       */
      balance: number;
      /**
       * Gross minus fees minus refunds, in cents.
       */
      net: number;
      /**
       * Gross total, in cents.
       */
      gross: number;
      /**
       * Fees total, in cents.
       */
      fees: number;
      /**
       * Currency code; null on an empty bucket.
       */
      currency: string | null;
      orders: {
        _id?: unknown;
        gross?: number;
        fees?: number;
        threeCFee?: number;
        stripeFee?: number;
        refundedAmount?: number;
        latest_charge?: string;
        event_id?: string;
        [k: string]: unknown;
      }[];
      account_limit?: number;
    };
    instant_balance: {
      /**
       * Net available to the host, in cents.
       */
      balance: number;
      /**
       * Gross minus fees minus refunds, in cents.
       */
      net: number;
      /**
       * Gross total, in cents.
       */
      gross: number;
      /**
       * Fees total, in cents.
       */
      fees: number;
      /**
       * Currency code; null on an empty bucket.
       */
      currency: string | null;
      orders: {
        _id?: unknown;
        gross?: number;
        fees?: number;
        threeCFee?: number;
        stripeFee?: number;
        refundedAmount?: number;
        latest_charge?: string;
        event_id?: string;
        [k: string]: unknown;
      }[];
      account_limit?: number;
    };
    /**
     * Only present when scoped to an event.
     */
    paid_out_balance?: {
      /**
       * Net available to the host, in cents.
       */
      balance: number;
      /**
       * Gross minus fees minus refunds, in cents.
       */
      net: number;
      /**
       * Gross total, in cents.
       */
      gross: number;
      /**
       * Fees total, in cents.
       */
      fees: number;
      /**
       * Currency code; null on an empty bucket.
       */
      currency: string | null;
      orders: {
        _id?: unknown;
        gross?: number;
        fees?: number;
        threeCFee?: number;
        stripeFee?: number;
        refundedAmount?: number;
        latest_charge?: string;
        event_id?: string;
        [k: string]: unknown;
      }[];
      account_limit?: number;
    };
    currency: string | null;
  }[];
}