PApaxos
Payout Groups

Delete Payout Group

Deletes a payout group. A 200 response indicates the request was accepted; however, if the payout group is registered on a blockchain, it may continue to appear for up to a few minutes while the on-chain removal is confirmed. Once confirmed, the payout group will no longer appear.

Deleting 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.

delete/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:delete_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 payout group to delete

Response

A successful response.

DeletePayoutGroupResponse required

Changes

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