Organization

Get purchases for your organization

Retrieve all purchase records for your organization with powerful filtering options.

What is a purchase? A purchase represents a transaction where a trader bought an evaluation plan or funded account from your organization. Each purchase is linked to one or more trading accounts.

What you get:

Purchase details (date, price, currency, status)
The trading plan that was purchased
All trading accounts created from this purchase
Custom metadata you’ve added (any JSON data)

Filtering & Search:

Parameter	Description	Example
`status`	Filter by purchase status	`?status=paid`
`metadata`	Filter by metadata key:value	`?metadata=promoCode:SUMMER25`
`search`	Search in metadata (text)	`?search=stripe_pi_123`
`startDate`	Purchases from this date	`?startDate=2025-01-01`
`endDate`	Purchases until this date	`?endDate=2025-01-31`

Pagination: Results are paginated. Use limit and offset to navigate through large datasets.

Example queries:

# Get all paid purchases
GET /organization/purchases?status=paid

# Get purchases with a specific promo code from January 2025
GET /organization/purchases?metadata=promoCode:SUMMER25&startDate=2025-01-01&endDate=2025-01-31

# Search for a specific transaction
GET /organization/purchases?search=stripe_pi_3ABC123

# Page 2 with 25 results per page
GET /organization/purchases?limit=25&offset=25

Use cases:

Generate revenue reports
Track refunds and chargebacks
Find purchases by a specific trader
Audit purchase history for compliance

GET

organization

purchases

Get purchases for your organization

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/purchases \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/purchases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/purchases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/purchases"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/purchases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "FakePropFirm",
    "purchases": [
      {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "purchaseDate": "2025-01-15T10:00:00.000Z",
        "startDate": "2025-01-15T10:00:00.000Z",
        "endDate": "2025-02-14T10:00:00.000Z",
        "status": "paid",
        "pricePaid": 299,
        "currency": "USD",
        "metadata": {
          "stripePaymentId": "pi_3ABC123",
          "promoCode": "SUMMER25"
        },
        "tradingPlan": {
          "id": "09c93da5-f057-4cc5-82da-ff9220292c94",
          "name": "50K Challenge",
          "accountSize": 50000
        },
        "accounts": [
          {
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "accountNumber": "ACC-7845KXPQ",
            "status": "in_progress",
            "userId": "550e8400-e29b-41d4-a716-446655440000",
            "userEmail": "trader@example.com"
          }
        ],
        "createdAt": "2025-01-15T10:00:00.000Z",
        "updatedAt": "2025-01-15T10:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 150,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This endpoint is only available for organization users",
  "code": "NOT_ORGANIZATION_USER"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Query Parameters

status

enum<string>

Filter by purchase status (pending, paid, refunded, cancelled)

Available options:

pending,

paid,

refunded,

cancelled

metadata

string

Filter by metadata key:value (e.g., "refunded:true", "campaign:affiliate")

string

Search in metadata notes (partial match)

startDate

string

Only include purchases from this date onwards

endDate

string

Only include purchases up to this date

limit

integer

default:50

Results per page (default: 50, max: 100)

Required range: 1 <= x <= 100

offset

integer

default:0

Skip this many results (for pagination)

Required range: x >= 0

cursor

string

Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.

How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.

Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.

sort

string

Sort results. Format: field:direction where direction is asc or desc.

Allowed fields: created_at, purchase_date, price_paid, status

Default: created_at:desc

Examples: created_at:asc, current_balance:desc

Response

Success - Returns paginated list of purchases

success

boolean

Example:

true

data

object

Show child attributes

Example:

{
  "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
  "organizationName": "FakePropFirm",
  "purchases": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "purchaseDate": "2025-01-15T10:00:00.000Z",
      "startDate": "2025-01-15T10:00:00.000Z",
      "endDate": "2025-02-14T10:00:00.000Z",
      "status": "paid",
      "pricePaid": 299,
      "currency": "USD",
      "metadata": {
        "stripePaymentId": "pi_3ABC123",
        "promoCode": "SUMMER25"
      },
      "tradingPlan": {
        "id": "09c93da5-f057-4cc5-82da-ff9220292c94",
        "name": "50K Challenge",
        "accountSize": 50000
      },
      "accounts": [
        {
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "accountNumber": "ACC-7845KXPQ",
          "status": "in_progress",
          "userId": "550e8400-e29b-41d4-a716-446655440000",
          "userEmail": "trader@example.com"
        }
      ],
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-01-15T10:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "offset": 0,
    "hasMore": true
  }
}

⌘I

Get purchases for your organization

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/purchases \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/purchases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/purchases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/purchases"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/purchases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "FakePropFirm",
    "purchases": [
      {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "purchaseDate": "2025-01-15T10:00:00.000Z",
        "startDate": "2025-01-15T10:00:00.000Z",
        "endDate": "2025-02-14T10:00:00.000Z",
        "status": "paid",
        "pricePaid": 299,
        "currency": "USD",
        "metadata": {
          "stripePaymentId": "pi_3ABC123",
          "promoCode": "SUMMER25"
        },
        "tradingPlan": {
          "id": "09c93da5-f057-4cc5-82da-ff9220292c94",
          "name": "50K Challenge",
          "accountSize": 50000
        },
        "accounts": [
          {
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "accountNumber": "ACC-7845KXPQ",
            "status": "in_progress",
            "userId": "550e8400-e29b-41d4-a716-446655440000",
            "userEmail": "trader@example.com"
          }
        ],
        "createdAt": "2025-01-15T10:00:00.000Z",
        "updatedAt": "2025-01-15T10:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 150,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This endpoint is only available for organization users",
  "code": "NOT_ORGANIZATION_USER"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Get purchases for your organization

Authorizations

Query Parameters

Response