This section give's control over the deposits (Internal or external) of Crypto currencies.
Deposit request can be created by any user with a an approved wallet registered in the system.
To create a deposit, a valid deposit address must be saved in the DB.
Admin logged in - can see and control deposits of all the system's users.
User logged in - can see and control it's own deposits.
Deposits are for Crypto only, this section will show all deposits customers done,
as it is crypto deposits we are define deposit as crypto transfer from customer personal wallet (white listed) to the system defined wallets.
you must first call "api/deposits/:currency/address" in order to get deposit address
Returnes a list of deposits in the system available deposit status
- pending (waiting for the blockchain update)
- completed (the transfer happen on the blockchain)
Success
Unauthorized
Forbidden
{- "api_message": "<string>",
- "api_data": {
- "last_at": "<datetime string>",
- "total_items": 1,
- "deposits": [
- {
- "id": "<string>",
- "user_id": "<string>",
- "from_address": "<string>",
- "to_address": "<string>",
- "amount": 1,
- "currency": "<string>",
- "type": "<string>",
- "action": "<string>",
- "status": "<string>",
- "match": true,
- "tx_hash": "<string>",
- "ip": "<string>",
- "created_by_id": "<string>",
- "created_at": "<string>",
- "updated_at": "<string>",
- "wallet_id": "<string>",
- "address": "<string>",
- "wallet_updated_at": "<datetime string>",
- "wallet_created_at": "<datetime string>"
}
]
}
}Create new deposit request.
* If you get "The field not found" it means the address doesn't exist for this user *
Success
Unauthorized
Unprocessable Content
{- "action": "DEPOSIT",
- "amount": 1,
- "currency": "TBTC",
- "from_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
- "to_address": "2Mwc6wXzvoJze7y92Edm66E4fMV1fH6FPKQ"
}{- "api_message": "<string>",
- "api_data": null
}Returnes an active wallet address for the currency provided in the route url.
The deposit address is unique per user, if a user has aleady requested an address,
it will return the address from the system db,
otherwise a new address will be created per user and per symbol
Success
Unauthorized
Internal Server Error
{- "api_message": "<string>",
- "api_data": {
- "address": "<string>"
}
}Returns a list of pending external withdrawals.
Success
Unauthorized
{- "api_message": "<string>",
- "api_data": {
- "last_at": "<datetime string>",
- "total_items": 1,
- "deposits": [
- {
- "id": "<string>",
- "user_id": "<string>",
- "from_address": "<string>",
- "to_address": "<string>",
- "amount": 1,
- "currency": "<string>",
- "type": "<string>",
- "action": "<string>",
- "status": "<string>",
- "match": true,
- "tx_hash": "<string>",
- "ip": "<string>",
- "created_by_id": "<string>",
- "created_at": "<string>",
- "updated_at": "<string>",
- "wallet_id": "<string>",
- "address": "<string>",
- "wallet_updated_at": "<datetime string>",
- "wallet_created_at": "<datetime string>"
}
]
}
}Returns full details on the provided deposit request.
Success
Unauthorized
Forbidden
{- "api_message": "<string>",
- "api_data": {
- "deposits": {
- "id": "<string>",
- "user_id": "<string>",
- "from_address": "<string>",
- "to_address": "<string>",
- "amount": 1,
- "currency": "<string>",
- "type": "<string>",
- "action": "<string>",
- "status": "<string>",
- "match": true,
- "tx_hash": "<string>",
- "ip": "<string>",
- "created_by_id": "<string>",
- "created_at": "<string>",
- "updated_at": "<string>",
- "wallet_id": "<string>",
- "address": "<string>",
- "wallet_updated_at": "<datetime string>",
- "wallet_created_at": "<datetime string>"
}
}
}Create new fiat deposit.
The payload's object explanation:
{
UUID: Crymbo's internal user id
CID: External user id
currency: USD/EUR
amount:: new balance
balance: previous balance
}
Success
Unauthorized
Forbidden
Unprocessable Content
{- "UUID": "Y0ZuTVFCNnl6S3dxNDBnaTdqc1VpUT09",
- "CID": "SOME-CID",
- "currency": "USD",
- "amount": "",
- "balance": ""
}{- "api_message": "<string>",
- "api_data": {
- "deposit_id": "<string>"
}
}