Deposit Savings
Deposit savings into an agent’s account
Investment Creation: Creates a new investment by depositing funds into an agent’s savings account. The operation converts the agent ID to UUID format if provided in short format, validates the deposit amount, and creates a new investment record.
Request Headers
Your API key for authentication
Request Body
The short ID or UUID of the agent
Amount to deposit (must be positive)
Response
Whether the deposit was successful
Information about the deposit
The ID of the newly created investment
Status Codes
Status Code | Description |
---|---|
200 | Deposit completed successfully |
400 | Bad Request - Invalid or missing parameters |
401 | Unauthorized - Invalid or missing API key |
404 | Not Found - Agent not found |
500 | Internal Server Error |
Agent ID Format: The API accepts both short ID format (agent_xxx) and UUID format for the agent ID parameter.
Amount Validation: The deposit amount must be a positive number. The system will validate this before processing the transaction.
Investment Record: A new investment record is created when the deposit is processed successfully. This can be used to track the investment’s growth over time.