Skip to main content
POST
/
v1
/
users
/
{userId}
/
withdrawals
Create withdrawal
curl --request POST \
  --url https://api.ledger.so/v1/users/{userId}/withdrawals \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chainId": 123,
  "tokenAddress": "<string>",
  "amount": 123,
  "recipientAddress": "<string>"
}
'
{
  "id": "<string>",
  "userId": "<string>",
  "chainId": 123,
  "tokenAddress": "<string>",
  "amount": 123,
  "status": "pending",
  "createdAt": 123,
  "recipientAddress": "<string>",
  "transactionHash": "<string>"
}

Authorizations

Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

userId
string
required

The user ID

Body

application/json
chainId
integer
required

Chain ID to withdraw on

tokenAddress
string
required

Token contract address

amount
integer
required

Amount in cents

recipientAddress
string

Destination wallet address

Response

Withdrawal created

id
string
required
userId
string
required
chainId
integer
required
tokenAddress
string
required
amount
integer
required
status
enum<string>
required
Available options:
pending,
submitted,
confirmed,
failed
createdAt
integer
required

Unix timestamp in milliseconds

recipientAddress
string
transactionHash
string