Get Earn deposit status

Poll the status of a deposit by its deposit_request_id (for the async/sponsored deposit path).

organizationId · string · required

Unique identifier for a given Organization.

depositRequestId · string · required

The deposit_request_id returned by EarnDeposit.

A successful response returns the following fields:

status · enum · required

Status of the deposit.

Enum options: PENDING, COMPLETED, FAILED

depositTxHash · string

Transaction hash of the deposit, once available.

error · string

Reason the deposit transaction failed, when status is FAILED.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_earn_deposit_status \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "depositRequestId": "<string>"
}'

200

{
  "status": "<PENDING>",
  "depositTxHash": "<string>",
  "error": "<string>"
}