Get referral earnings

Use this operation for get referral earnings. Follow the referrals and rewards guide for the complete workflow.

Referrals and rewards guide · All endpoints · SDK: getReferralEarnings

Authentication

Server-to-server HMAC. Your key selects the partner; your backend must authorize the end user.

CRISP enables access to the features agreed for your integration. Contact CRISP if an enabled feature returns an access error.

Idempotency-Key: Not required by this operation. Signing and authentication →

Request fields

Required means the field must be present. Nullable means an explicit JSON null is allowed; it does not mean optional.

Path parameters

Field	Type / presence	Description and constraints
`externalUserId`	`string` Required Non-null	Your stable user ID within the authenticated partner. Derive it from your authorized server session. Validation pattern `^[A-Za-z0-9._:@-]{1,200}$`

Query parameters

Field	Type / presence	Description and constraints
`from`	`string` Optional Non-null	Format: date
`to`	`string` Optional Non-null	Format: date
`granularity`	`string` Optional Non-null	Allowed: "daily", "weekly", "monthly"
`limit`	`integer` Optional Non-null	Maximum number of records requested in one page. Default: 31 minimum: 1 maximum: 366

Header parameters

No operation-specific headers. The HMAC headers above still apply.

JSON body

No request body.

Illustrative identifiers only: replace them with resources from your integration. Keep credentials on your backend. HTTP placeholders must be signed; the SDK signs automatically. Financial intent keys must be persisted and unique per new action.

GET /v1/accounts/user-123/referral-earnings?limit=31
Host: partner-api.crisp.trade
X-Crisp-Partner-Key: <server-key-id>
X-Crisp-Timestamp: <fresh-ISO-8601-UTC-timestamp>
X-Crisp-Nonce: <fresh-unique-nonce>
X-Crisp-Signature: <computed-base64-HMAC>

Response fields

HTTP responses use the envelope below. SDK calls expose its payload as result.data, with HTTP status and request metadata on the SDK wrapper.

200 · Success

Data payload

Field Type / presence Description and constraints

cadence

string

Required

Non-null

—

from

string | null

Required

Nullable

Expand the structure below.

from: expand fields

string

Format: date

to

string | null

Required

Nullable

Expand the structure below.

to: expand fields

string

Format: date

granularity

string

Required

Non-null

—

earnings

array<object>

Required

Non-null

Expand the structure below.

earnings: expand item fields

Field Type / presence Description and constraints

feeDay

string

Required

Non-null

Format: date

accruedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

collectedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

feeDayConcluded

boolean

Required

Non-null

—

claimableUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

claim

object | null

Required

Nullable

Expand the structure below.

claim: expand fields

Field	Type / presence	Description and constraints
`id`	`string` Required Non-null	Format: uuid
`state`	`string` Required Non-null	Allowed: "queued", "submitting", "submitted", "settled", "manual_review"
`amountUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`totalAmountUsdc`	`string` Optional Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`transactionHash`	`string \| null` Required Nullable	Expand the structure below.
transactionHash: expand fields string

Additional fields are not allowed in this object.

series

array<object>

Required

Non-null

Expand the structure below.

series: expand item fields

Field	Type / presence	Description and constraints
`periodStart`	`string` Required Non-null	Format: date
`accruedUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`collectedUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`claimableUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`

Additional fields are not allowed in this object.

levels

array<object>

Required

Non-null

Expand the structure below.

levels: expand item fields

Field	Type / presence	Description and constraints
`level`	`integer` Required Non-null	minimum: 0
`accruedUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`

Additional fields are not allowed in this object.

claimEarnings

array<object>

Required

Non-null

Expand the structure below.

claimEarnings: expand item fields

Field Type / presence Description and constraints

feeDay

string

Required

Non-null

Format: date

accruedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

collectedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

feeDayConcluded

boolean

Required

Non-null

—

claimableUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

claim

object | null

Required

Nullable

Expand the structure below.

claim: expand fields

Field	Type / presence	Description and constraints
`id`	`string` Required Non-null	Format: uuid
`state`	`string` Required Non-null	Allowed: "queued", "submitting", "submitted", "settled", "manual_review"
`amountUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`totalAmountUsdc`	`string` Optional Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`transactionHash`	`string \| null` Required Nullable	Expand the structure below.
transactionHash: expand fields string

Additional fields are not allowed in this object.

Full HTTP envelope

Field Type / presence Description and constraints

data

object

Required

Non-null

Expand the structure below.

data: expand fields

Field Type / presence Description and constraints

cadence

string

Required

Non-null

—

from

string | null

Required

Nullable

Expand the structure below.

from: expand fields

string

Format: date

to

string | null

Required

Nullable

Expand the structure below.

to: expand fields

string

Format: date

granularity

string

Required

Non-null

—

earnings

array<object>

Required

Non-null

Expand the structure below.

earnings: expand item fields

Field Type / presence Description and constraints

feeDay

string

Required

Non-null

Format: date

accruedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

collectedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

feeDayConcluded

boolean

Required

Non-null

—

claimableUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

claim

object | null

Required

Nullable

Expand the structure below.

claim: expand fields

Field	Type / presence	Description and constraints
`id`	`string` Required Non-null	Format: uuid
`state`	`string` Required Non-null	Allowed: "queued", "submitting", "submitted", "settled", "manual_review"
`amountUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`totalAmountUsdc`	`string` Optional Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`transactionHash`	`string \| null` Required Nullable	Expand the structure below.
transactionHash: expand fields string

Additional fields are not allowed in this object.

series

array<object>

Required

Non-null

Expand the structure below.

series: expand item fields

Field	Type / presence	Description and constraints
`periodStart`	`string` Required Non-null	Format: date
`accruedUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`collectedUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`claimableUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`

Additional fields are not allowed in this object.

levels

array<object>

Required

Non-null

Expand the structure below.

levels: expand item fields

Field	Type / presence	Description and constraints
`level`	`integer` Required Non-null	minimum: 0
`accruedUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`

Additional fields are not allowed in this object.

claimEarnings

array<object>

Required

Non-null

Expand the structure below.

claimEarnings: expand item fields

Field Type / presence Description and constraints

feeDay

string

Required

Non-null

Format: date

accruedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

collectedUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

feeDayConcluded

boolean

Required

Non-null

—

claimableUsdc

string

Required

Non-null

Exact decimal string. Never use floating point for ledger arithmetic.

Validation pattern

^\d+(?:\.\d+)?$

claim

object | null

Required

Nullable

Expand the structure below.

claim: expand fields

Field	Type / presence	Description and constraints
`id`	`string` Required Non-null	Format: uuid
`state`	`string` Required Non-null	Allowed: "queued", "submitting", "submitted", "settled", "manual_review"
`amountUsdc`	`string` Required Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`totalAmountUsdc`	`string` Optional Non-null	Exact decimal string. Never use floating point for ledger arithmetic. Validation pattern `^\d+(?:\.\d+)?$`
`transactionHash`	`string \| null` Required Nullable	Expand the structure below.
transactionHash: expand fields string

Additional fields are not allowed in this object.

requestId

string

Required

Non-null

Request correlation ID for debugging and support.

Additional fields are not allowed in this object.

Response example

Schema illustration, not live account data. Null means unavailable or not applicable, never an invented zero. Empty arrays do not imply the endpoint always returns no results.

200 response JSON

{
  "data": {
    "cadence": "example",
    "from": null,
    "to": null,
    "granularity": "example",
    "earnings": [],
    "series": [],
    "levels": [],
    "claimEarnings": []
  },
  "requestId": "example-request-id"
}

Errors and recovery

Status	Meaning
`400`	Inspect error.code and retain the original financial intent.
`401`	Inspect error.code and retain the original financial intent.
`403`	Inspect error.code and retain the original financial intent.
`404`	Not visible for this account. A recovery lookup miss is not proof that an in-flight submission failed.
`409`	Inspect error.code and retain the original financial intent.
`429`	Inspect error.code and retain the original financial intent.
`500`	Inspect error.code and retain the original financial intent.
`502`	Inspect error.code and retain the original financial intent.
`503`	Inspect error.code and retain the original financial intent.

Inspect the error code and outcomeUnknown, not just the HTTP status. Preserve the original intent after financial uncertainty. Read-only retries should honor Retry-After. Recovery workflow →

Error response fields

Field Type / presence Description and constraints

error

object

Required

Non-null

Expand the structure below.

error: expand fields

Field	Type / presence	Description and constraints
`code`	`string` Required Non-null	—
`message`	`string` Required Non-null	—
`requestId`	`string` Required Non-null	Request correlation ID for debugging and support.

Additional fields are not allowed in this object.

Raw contract

OpenAPI download · Advanced schema and legacy anchor

Authentication

Request fields

Path parameters

Query parameters

Header parameters

JSON body

Request example

Response fields

200 · Success

Data payload

Response example

Errors and recovery

Raw contract

On this page