Wallet Actions

Earn incentive claim

Changed on

Claim incentive rewards for a wallet.

post/v1/wallets/{wallet_id}/earn/ethereum/incentive/claim

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/wallets/{wallet_id}/earn/ethereum/incentive/claim
  • Auth
    HTTP basic

Path parameters

wallet_idstring required

ID of the wallet.

Headers

privy-app-idstring required

ID of your Privy app.

privy-authorization-signaturestring

Request authorization signature. If multiple signatures are required, they should be comma separated.

privy-request-expirystring

Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed.

privy-idempotency-keystring

Idempotency keys ensure API requests are executed only once within a 24-hour window.

Request body

noncestring

Unique caller-generated nonce used to prevent replaying a signed wallet action request. Must be at least 24 characters (e.g. a cuid2 or UUID).

chainstring required

The blockchain network on which to perform the incentive claim. Supported chains include: 'tempo', 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more, along with their respective testnets.

reference_idstring

Developer-provided identifier for this request. Must be unique per app.

Example request

{
  "chain": "tempo"
}

Response

Earn incentive claim initiated successfully.

idstring required

The ID of the wallet action.

status'pending' | 'succeeded' | 'rejected' | 'failed' required

The current status of the wallet action.

wallet_idstring required

The ID of the wallet involved in the action.

created_atstring date-time required

ISO 8601 timestamp of when the wallet action was created.

reference_idstring nullable

Developer-provided reference ID, if one was included in the request.

type'earn_incentive_claim' required
chainstring required

EVM chain name (e.g. "tempo", "base").

Example response

{
  "steps": [
    {
      "gas_credits_charged": {
        "value": "100.00",
        "currency": "usd"
      }
    }
  ]
}

Changes

  • 527110c2c2f4Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      response property steps/items/oneOf[subschema #1: EVMTransactionWalletActionStep]/gas_credits_charged_usd deprecated

    • info

      response property steps/items/oneOf[subschema #2: EVMUserOperationWalletActionStep]/gas_credits_charged_usd deprecated

    • info

      response property steps/items/oneOf[subschema #3: SVMTransactionWalletActionStep]/gas_credits_charged_usd deprecated

    • info

      response property steps/items/oneOf[subschema #4: TVMTransactionWalletActionStep]/gas_credits_charged_usd deprecated

  • a77e516e7c57Revision changes
    • info

      added the optional property /// to the response with the status