POST
/
balance
/
transfer
curl --request POST \
  --url https://staging-biz.coinprofile.co/v2/balance/transfer \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-User: <api-key>' \
  --header 'X-User-Version: <api-key>' \
  --data '{
  "receiverUsername": "<string>",
  "currency": "NGN",
  "amount": "<string>",
  "token": "<string>",
  "otpType": "otp",
  "memo": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "transactionId": "<string>",
    "sender": "<string>",
    "status": "fullfiled",
    "date": "2023-12-25",
    "toCurrency": "NGN",
    "fromCurrency": "NGN",
    "receiveAmount": "<string>",
    "amount": "<string>",
    "username": "<string>",
    "senderPrevbalance": "<string>"
  }
}

Authorizations

X-Api-User
string
header
required
X-Api-Key
string
header
required
X-User-Version
string
header
required

Body

application/json
receiverUsername
string
required

Receiver's coinprofile username.

currency
enum<string>
required

Currency being sent.

Available options:
NGN,
USD
amount
string

Amount to transfer.

token
string

The token to be used for OTP.

otpType
enum<string>

The type of OTP to be used.

Available options:
otp,
totp
memo
string

Transaction memo.

Maximum length: 28

Response

200 - application/json
successful operation
success
boolean
message
string
data
object