Transfer

This section give's control for system transfers.
Transfer creation must be provided with amount,currency and wallet address to transfer to (wallet must be verified saved in the DB beforehand).
Admin logged in - can approve/decline any pending transfer (must use his authenticator password for this type of actions).
User logged in - can create any transfer request (in case he has sufficent balance and a wallet saved and verified in the DB).

List Transfers

Returns a list of all transfer requests.

Responses
200

List of transfers retrieved successfully

get/transfers
Response samples
application/json
{
  • "api_message": "TRANSFER_GET_LIST_SUCCESS",
  • "api_data": {
    }
}

Create Transfer

Creates a new transfer request.

Request
Request Body schema: application/json
required
amount
string
currency
string
currency_id
string
recipient_address
string
Responses
200

Transfer successfully created

post/transfers
Request samples
application/json
{
  • "amount": "0.000001",
  • "currency": "BTC",
  • "currency_id": "eGFCV203K3VSOGM9",
  • "recipient_address": "bc1q3aqj5aye9ktg7a2hslyuzu5szv4j32cnr62zhh"
}
Response samples
application/json
{
  • "api_message": "TRANSFER_POST_SUCCESS",
  • "api_data": {
    }
}

Show Transfer

Returns details of a specific transfer request.

Request
path Parameters
transfer_id
required
string

ID of the transfer

Responses
200

Transfer details retrieved successfully

get/transfers/{transfer_id}
Response samples
application/json
{
  • "api_message": "TRANSFER_GET_SHOW_SUCCESS",
  • "api_data": {
    }
}

Update Transfer

Updates the status of a specific transfer request.

Request
path Parameters
transfer_id
required
string

ID of the transfer

Request Body schema: application/json
required
status
string
otp
string
reason
string
Responses
200

Transfer updated successfully

put/transfers/{transfer_id}
Request samples
application/json
{
  • "status": "ADMIN_APPROVED",
  • "otp": "123456",
  • "reason": "Verified and approved"
}
Response samples
application/json
{
  • "api_message": "TRANSFER_PUT_SUCCESS",
  • "api_data": {
    }
}