Authorizations
Query Parameters
Currency for which balance is to be retrieved. When this is not supplied, balance will be retrieved for all available currencies.
Available options:
NGN, USD, USDT Collect & Onramp
- GETRetrieve merchant account balance
- GETRetrieve merchant record
- PATCHUpdate merchant record
- POSTMake a mock payment
- GETRetrieves conversion rates
- GETRetrieve merchant transaction summary
- POSTCreate a new voucher payment
- GETRetrieve voucher record
- GETGet multiple records
- PATCHRedeem existing unused voucher
- PATCHRedeem and withdraw
- GETRetrieves conversion rates
- GETRetrieves minimum and maximum voucher amounts
- POSTCreate a new bank account
- GETRetrieve static accounts for a user
Offramp
- POSTCreate api key
- POSTCreate payment
- GETGet a single payment
- GETGet a transaction
- GETGet current rates
- GETGet minimum amount allowed
- GETGet supported currencies
- GETGet supported cryptocurrencies and network
- GETResolve overpaid Transaction
- GETRetrieve subscribed webhook url
- GETRetrieve user's transaction records
- GETRetrieve user's transaction summary
- GETRetrieves a user's crypto wallet addresses
- PUTSubscribe to webhook
Payout
- GETGet current rates
- POSTWithdraw balance
- GETGet a transaction
- POSTResolve bank account
- GETGet minimum amount allowed
- GETRetrieve a list of supported banks
- GETRetrieve subscribed webhook url
- GETRetrieve user's account balance
- GETRetrieve user's transaction records
- GETRetrieve user's transaction summary
- PUTSubscribe to webhook
- POSTTransfer funds
- POSTWallet transfer
Retrieve user's account balance
Copy
curl --request GET \
--url https://staging-biz.coinprofile.co/v2/balance \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--header 'X-User-Version: <api-key>'Copy
{
"success": true,
"message": "<string>",
"data": {
"balances": {
"totalRecieved": 123,
"totalSent": 123,
"txnCount": 123,
"toCurrency": "<string>",
"amount": 123,
"formattedAmount": 123
}
}
}Payout
Retrieve user's account balance
Retrieves account balance for each currency
GET
/
balance
Retrieve user's account balance
Copy
curl --request GET \
--url https://staging-biz.coinprofile.co/v2/balance \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--header 'X-User-Version: <api-key>'Copy
{
"success": true,
"message": "<string>",
"data": {
"balances": {
"totalRecieved": 123,
"totalSent": 123,
"txnCount": 123,
"toCurrency": "<string>",
"amount": 123,
"formattedAmount": 123
}
}
}⌘I