GET
/
transaction
/
summary
curl --request GET \
  --url https://staging-biz.coinprofile.co/v2/transaction/summary \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-User: <api-key>' \
  --header 'X-User-Version: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "txn": {
      "data": [
        {
          "currency": "<string>",
          "version": "<string>",
          "transactionId": "<string>",
          "sender": "<string>",
          "isFromRegUser": true,
          "prevBalance": 123,
          "senderPrevbalance": 123,
          "type": "<string>",
          "status": "<string>",
          "businessId": "<string>",
          "date": "<string>",
          "fromCurrency": "<string>",
          "fromAmount": 123,
          "amount": 123,
          "username": "<string>",
          "fee": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "total": 123,
      "perPage": 123,
      "page": 123,
      "pages": 123
    },
    "summary": {
      "volume": 123,
      "txnCount": 123,
      "duration": 123
    }
  }
}

Authorizations

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

Query Parameters

​
currency
enum<string>

Currency for which transactions are to be retrieved. When this is not supplied, transactions will be retrieved for all available currencies.

Available options:
NGN,
USD
​
type
enum<string>

Type of transactions to be retrieved. When this is not supplied, transactions will be retrieved for all available types.

Available options:
deposit,
withdrawal,
sent,
transfer,
internalTransfer,
conversion
​
page
number

Number of pages to be retrieved.

​
limit
number

Number of transaction records to be retrieved per page page.

​
duration
enum<number>

Duration of the transaction to be retrieved per page page.

Response

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