Get Earn withdraw status

Poll the status of a withdrawal by its withdraw_request_id.

organizationId · string · required

Unique identifier for a given Organization.

withdrawRequestId · string · required

The withdraw_request_id returned by EarnWithdraw.

A successful response returns the following fields:

status · enum · required

Status of the withdrawal.

Enum options: PENDING, COMPLETED, FAILED

withdrawTxHash · string

Transaction hash of the withdrawal, once available.

error · string

Reason the withdrawal transaction failed, when status is FAILED.

cURL

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

200

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