PApaxos
Payout Groups

Create Payout Group

Adds a payout group. A payout group encapsulates common rewards characteristics. All monitored addresses which reference this payout group will accumulate rewards at the same rate and claim their rewards to the payout destination specified for this group.

post/rewards/payout-groups

Request

  • Base URL
    https://api.paxos.com/v2
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://oauth.paxos.com/oauth2/token
      Scopesrewards:create_payout_groups
    • or OAuth 2
      Client credentials
      Token URLhttps://oauth.paxos.com/oauth2/token
      Scopesrewards:write_payout_groups
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

ledgerstring
asset_typestring
jurisdictionstring
namestring
claimer_addressstring

Address with signing authority to claim rewards for this group.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.