claimEligibleEarnings([payload,])
Claim eligible cryptocurrency earnings for a user of your campaign
This method allows you request a user's earnings to be paid out from your Gnosis Safe.
Note - this endpoint is asynchronous of the actual payouts from your Gnosis Safe, which occur on-chain. ChainVine handles reconciling earnings owed with those that are transferred successfully on-chain via this SDK method.
Params
Param | Required | Type | Description |
---|---|---|---|
campaign.id | required | string | the id of the program/campaign requirement belongs to Note: this campaign/program must belong to your account |
Response
Field | Type | Description |
---|---|---|
message | String | Ok status message on success |
How this method claims earnings for your user
All unpaid earnings are flagged for pay-out
Pay-outs are reflected on ChainVine asynchronously of the request
Earnings that are paid out successfully on chain are marked as paid out ChainVine side
Earnings that fail on-chain are not marked as failed on ChainVine and can be re-attempted
Earnings that are being paid out will not be retried while on-chain transfer confirmation is pending
Examples
In this approach, we claim a user's earnings on their behalf.
Last updated