Deposit

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

get-deposits

Returnes a list of deposits in the system available deposit status
- pending (waiting for the blockchain update)
- completed (the transfer happen on the blockchain)

SecurityAuthorization
Request
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
200

Success

401

Unauthorized

403

Forbidden

get/deposits
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

post-deposit

Create new deposit request. must exist in users deposit address
* If you get "The field not found" it means the address doesn't exist for this user *

SecurityAuthorization
Request
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
Request Body schema: application/json
required
action
string
amount
number
currency
string
from_address
string
to_address
string
Responses
200

Success

401

Unauthorized

422

Unprocessable Content

post/deposits
Request samples
application/json
{
  • "action": "DEPOSIT",
  • "amount": 1,
  • "currency": "TBTC",
  • "from_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  • "to_address": "2Mwc6wXzvoJze7y92Edm66E4fMV1fH6FPKQ"
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": null
}

get-deposit-address

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

SecurityAuthorization
Request
path Parameters
currency
required
string

currency path parameter

Example: <currency>
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
200

Success

401

Unauthorized

500

Internal Server Error

get/deposits/{currency}/address
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

get-pending-external-sell-list

Returns a list of pending external withdrawals.

SecurityAuthorization
Request
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
200

Success

401

Unauthorized

get/deposits/list/PendingExternalSell
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

get-deposit-by-depositId

Returns full details on the provided deposit request.

SecurityAuthorization
Request
path Parameters
deposit_id
required
string

deposit_id pat parameter

Example: <deposit_id>
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
200

Success

401

Unauthorized

403

Forbidden

get/deposits/{deposit_id}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

post-fiat-deposit

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
}

SecurityAuthorization
Request
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Request Body schema: application/json
required
UUID
string
CID
string
currency
string
amount
string
balance
string
Responses
200

Success

401

Unauthorized

403

Forbidden

422

Unprocessable Content

post/deposits/fiat
Request samples
application/json
{
  • "UUID": "Y0ZuTVFCNnl6S3dxNDBnaTdqc1VpUT09",
  • "CID": "SOME-CID",
  • "currency": "USD",
  • "amount": "",
  • "balance": ""
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

update-deposit

Update the provided deposit request.

SecurityAuthorization
Request
path Parameters
deposit_id
required
string

depoist_id path parameter

Example: <deposit_id>
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
200

Success

401

Unauthorized

403

Forbidden

500

Internal Server Error

put/deposits/{deposit_id}/declineSell
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": ""
}