Payout Groups

Update Payout Group

Updates a payout group. Any changes to a payout group which has an on-chain component will cause the unclaimed rewards for that group to be implicitly claimed. No details of the implicit claiming are returned in this API response.

put/rewards/payout-groups/{id}

Request

  • Base URL
    https://api.paxos.com/v2
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://oauth.paxos.com/oauth2/token
      Scopesrewards:update_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.

Path parameters

idstring required

UUID direct reference to the existing payout group

Request body

namestring
jurisdictionstring

Response

A successful response.

Changes

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