NodeRings Docs

Update Payout Configuration

PUT
/v1/provider/payout-configuration
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

scheduleType?string
  • PAYOUT_SCHEDULE_TYPE_IMMEDIATE: Transfer immediately when payment succeeds
  • PAYOUT_SCHEDULE_TYPE_DAILY: Transfer once per day at specified time
  • PAYOUT_SCHEDULE_TYPE_WEEKLY: Transfer once per week at specified time
  • PAYOUT_SCHEDULE_TYPE_MONTHLY: Transfer once per month at specified time
Default"PAYOUT_SCHEDULE_TYPE_UNSPECIFIED"
Value in"PAYOUT_SCHEDULE_TYPE_UNSPECIFIED" | "PAYOUT_SCHEDULE_TYPE_IMMEDIATE" | "PAYOUT_SCHEDULE_TYPE_DAILY" | "PAYOUT_SCHEDULE_TYPE_WEEKLY" | "PAYOUT_SCHEDULE_TYPE_MONTHLY"
scheduleTime?string
scheduleTimezone?string
enabled?boolean

Response Body

application/json

curl -X PUT "https://api.nrings.io/v1/provider/payout-configuration" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}" \  -H "Content-Type: application/json" \  -d '{  "scheduleType": "PAYOUT_SCHEDULE_TYPE_UNSPECIFIED",  "scheduleTime": "string",  "scheduleTimezone": "string",  "enabled": false}'
{
  "configuration": {
    "scheduleType": "PAYOUT_SCHEDULE_TYPE_UNSPECIFIED",
    "scheduleTime": "string",
    "scheduleTimezone": "string",
    "enabled": true
  }
}