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 ZEN.

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

Query Parameters

subaccount_namesAny properties in string,array<string>

An array of subaccount names for which to retrieve summary information.

page_numbernumber

The page number to use for the returned data.

Minimum: 1

page_sizenumber

The page size to use for the returned data.

Minimum: 1

curl -X GET "https://app.luxor.tech/api/v1/pool/payment-settings/BTC?subaccount_names=subaccount_1%2Csubaccount_2&page_number=1&page_size=10" \
  -H "authorization: <token>"

Default Response

{
  "payment_settings": [
    {
      "currency_type": "BTC",
      "subaccount": {
        "id": 0,
        "name": "subaccount_1",
        "created_at": "2019-08-24T14:15:22Z",
        "url": "/v1/pool/groups/3fa85f64-5717-4562-b3fc-2c963f66afa6/subaccounts/subaccount_1"
      },
      "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": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "revenue_allocation": 100
        }
      ],
      "pool_discount_rate": 0.01
    }
  ],
  "pagination": {
    "page_number": 0,
    "page_size": 0,
    "item_count": 0,
    "previous_page_url": "string",
    "next_page_url": "string"
  }
}

Get payment settings

Authorization

Path Parameters

Query Parameters

Response

TypeScript