Skip to main content
This endpoint is pending implementation and is not currently available in the API.

​
Endpoint

POST /api/v1/users/deposit
This endpoint will allow users to deposit funds into their exchange account.

​
Planned request structure

​
user_id
string
required
The unique identifier of the user making the deposit
​
asset
string
required
The asset to deposit (e.g., “USDC”, “SOL”)
​
amount
decimal
required
The amount to deposit
​
transaction_id
string
required
The blockchain transaction ID or reference

​
Planned response structure

​
status
string
Status message indicating successful deposit
​
user_id
string
The user ID that received the deposit
​
asset
string
The deposited asset
​
amount
decimal
The deposited amount
​
balance
decimal
The user’s new balance for the asset

​
Example request

curl -X POST \
  https://api.exchange.com/api/v1/users/deposit \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "asset": "USDC",
    "amount": "1000.00",
    "transaction_id": "0x123abc..."
  }'

​
Example response

{
  "status": "Deposit successful",
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "asset": "USDC",
  "amount": "1000.00",
  "balance": "1000.00"
}

​
Notes

This functionality will need to:
  • Verify blockchain transactions
  • Update user balances in the exchange engine
  • Handle transaction confirmations
  • Implement appropriate security measures

Build docs developers (and LLMs) love

Get started for freeTalk to us