Get payment settings

Retrieves a subaccount in a subaccounts group, together with the Mining Pool discount rates associated for each of the currencies mined using that subaccount.

Authorization

authorization<token>

Use your API key here.

In: header

Path Parameters

currency_typeRequiredstring

Which currency to query, e.g. BTC or DOGE.

Value in: "BTC" | "LTC_DOGE" | "SC" | "ZEC"

Query Parameters

subaccount_namesAny properties in Any properties in string,array<string>,array<string>

site_idAny properties in string,string

page_numberinteger

Default: 1Minimum: 1

page_sizeinteger

Default: 10Minimum: 1

curl -X GET "https://app.luxor.tech/api/v1/pool/payment-settings/BTC?subaccount_names=my_subaccount%2Canother_subaccount&site_id=b0a5fad8-0e09-4f10-ac20-ccd80fb2d138&page_number=1&page_size=10" \
  -H "authorization: <token>"

Default Response

{
  "payment_settings": [
    {
      "currency_type": "BTC",
      "subaccount": {
        "id": 0,
        "name": "my_subaccount",
        "site": {
          "id": "b0a5fad8-0e09-4f10-ac20-ccd80fb2d138",
          "name": "My Site"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "url": "string"
      },
      "balance": 0.00066154,
      "status": "PENDING_APPROVAL",
      "wallet_id": 0,
      "payment_frequency": "DAILY",
      "day_of_week": "MONDAY",
      "addresses": [
        {
          "address_id": 0,
          "address_name": "address_1",
          "external_address": "YOUR_WALLET_ADDRESS",
          "revenue_allocation": 100
        }
      ],
      "next_payout_at": "2025-01-01T00:00:00Z",
      "frozen_until": "2025-01-01T00:00:00Z",
      "pool_discount_rate": 0.01
    }
  ],
  "pagination": {
    "page_number": 1,
    "page_size": 1,
    "item_count": 0,
    "previous_page_url": null,
    "next_page_url": null
  }
}

Get payment settings

Authorization

Path Parameters

Query Parameters

Response

TypeScript