Luxor Documentation Hub Logo
Mining Pool/API Documentation/Payments

Get subaccount payment settings

Returns the payment settings for a specific subaccount and currency type.

GET
/v1/pool/payment-settings/{currency_type}/{subaccount_name}

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"
subaccount_nameRequiredstring

A subaccount name for which to retrieve summary information.

Minimum length: 1
curl -X GET "https://beta.luxor.tech/api/v1/pool/payment-settings/BTC/subaccount_1" \
  -H "authorization: <token>"

Default Response

{
  "currecy_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/1",
    "pool_fee": 0
  },
  "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
    }
  ]
}

Previous

Get payment settings

Next

Get transactions