Get Kickback Balance

Returns the available and pending kickback balance grouped by currency, each bucket listing its contributing orders and tickets. Money is in cents.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

GET/v1/orders/kickback/balance

curl -X GET "https://api.3common.com/v1/orders/kickback/balance" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "available_balance": {
        "kickback_balance": 0,
        "kickback_balance_orders": [
          {
            "_id": null,
            "gross": 0,
            "fees": 0,
            "threeCFee": 0,
            "stripeFee": 0,
            "refundedAmount": 0,
            "latest_charge": "string",
            "event_id": "string",
            "property1": null,
            "property2": null
          }
        ],
        "currency": "string"
      },
      "pending_balance": {
        "kickback_balance": 0,
        "kickback_balance_orders": [
          {
            "_id": null,
            "gross": 0,
            "fees": 0,
            "threeCFee": 0,
            "stripeFee": 0,
            "refundedAmount": 0,
            "latest_charge": "string",
            "event_id": "string",
            "property1": null,
            "property2": null
          }
        ],
        "currency": "string"
      },
      "currency": "string"
    }
  ]
}

TypeScript

export interface Response {
  data: {
    available_balance: {
      /**
       * Kickback total for this bucket, in cents.
       */
      kickback_balance: number;
      kickback_balance_orders: {
        _id?: unknown;
        gross?: number;
        fees?: number;
        threeCFee?: number;
        stripeFee?: number;
        refundedAmount?: number;
        latest_charge?: string;
        event_id?: string;
        [k: string]: unknown;
      }[];
      currency: string | null;
    };
    pending_balance: {
      /**
       * Kickback total for this bucket, in cents.
       */
      kickback_balance: number;
      kickback_balance_orders: {
        _id?: unknown;
        gross?: number;
        fees?: number;
        threeCFee?: number;
        stripeFee?: number;
        refundedAmount?: number;
        latest_charge?: string;
        event_id?: string;
        [k: string]: unknown;
      }[];
      currency: string | null;
    };
    currency: string | null;
  }[];
}