Mining Pool/API Documentation/Payments
Create payment settings
Creates the payment settings for a specific subaccount and currency type.
Authorization
authorization
<token>Use your API key here.
In: header
Request Body
application/json
Requiredpayment_frequency
RequiredstringPayment Status
Value in:
"UNSPECIFIED" | "DAILY" | "WEEKLY" | "MONTHLY"
day_of_week
stringPay day
Value in:
"UNSPECIFIED" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY"
addresses
Requiredarray<object>Path Parameters
currency_type
RequiredstringWhich currency to query, e.g. BTC or ZEN.
Value in:
"BTC" | "LTC_DOGE" | "SC" | "ZEC" | "ZEN"
subaccount_name
RequiredstringA subaccount name for which to retrieve summary information.
Minimum length:
1
curl -X POST "https://beta.luxor.tech/api/v1/pool/payment-settings/BTC/subaccount_1" \
-H "authorization: <token>" \
-H "Content-Type: application/json" \
-d '{
"payment_frequency": "DAILY",
"day_of_week": "MONDAY",
"addresses": [
{
"address_name": "address_1",
"external_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"revenue_allocation": 100
}
]
}'
Response with the payment settings for a specific subaccount and currency type.
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"actionName": "DISABLE_ADMIN_APPROVAL_FLOW",
"status": "PROCESSING",
"initiatedAt": "2019-08-24T14:15:22Z",
"initiatedBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"type": "API_KEY"
},
"requiresApproval": true,
"canceledBy": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"type": "API_KEY"
},
"approvedAt": "2019-08-24T14:15:22Z",
"rejectedAt": "2019-08-24T14:15:22Z",
"approvedBy": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"type": "API_KEY"
}
],
"rejectedBy": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"displayName": "string",
"type": "API_KEY"
}
],
"url": "/v1/api/workspace/actions/0123456a-bc78-901d-efg2-h345ij6k78lm",
"metadata": null
}