List transactions

api-docs Redoc document (api spec)

get

Required scopes

This endpoint requires the following scopes:

Authorizations

api_key

AuthorizationstringRequired

Path parameters

user_idstringOptional

The user_id of the user for which transactions should be retrieved

user_adminstringOptional

The admin_user of the user for which transactions should be retrieved

Query parameters

pageintegerOptional

The current page of the transactions to be retrieved

page_sizeintegerOptional

The number of items per page to be retrieved

Responses

200Success

application/json

get

/api/transactions/list/{user_id}

HTTPcURLJavaScriptPython

GET /api/transactions/list/{user_id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "error": {
    "code": "040",
    "message": "Wrong email or password"
  },
  "data": {
    "transactions": [
      {
        "_id": "text",
        "admin_user": "text",
        "user": "text",
        "algorand_transaction": "text",
        "transaction_date": "text",
        "ganga_txn": "text",
        "product_category": "text",
        "product_name": "text",
        "transaction_value": 1,
        "transaction_rating_score": 1,
        "transaction_users": [
          {
            "user_id": "text",
            "user_email": "text",
            "token_ratio": 1
          }
        ]
      }
    ],
    "metadata": {
      "page": "text",
      "total_items": 1,
      "page_size": "text"
    }
  }
}

The "/api/transactions/list/{user_id}" endpoint allows you to retrieve a list of transactions for a specified user. It is a GET request and requires an API key with either "partner" or "admin" privileges. The endpoint accepts the following parameters:

• "user_id" (optional): The user_id of the user for which transactions should be retrieved.

• "user_admin" (optional): The admin_user of the user for which transactions should be retrieved.

• "page" (optional): The current page of the transactions to be retrieved.

• "page_size" (optional): The number of items per page to be retrieved.

Upon successful request, the endpoint will return a 200 status code with a JSON response that includes "error" and "data" objects. The "error" object contains the error code and error message, and the "data" object contains an array of transactions and metadata.