> For the complete documentation index, see [llms.txt](https://docs.fuul.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fuul.xyz/developer-guide/claiming-onchain-rewards/get-claim-checks.md).

# Get Claim Checks

Claim checks are signed vouchers that allow users to claim their rewards onchain. This step is the same regardless of whether you're claiming on EVM, SVM, or Stellar.

Use `Fuul.getClaimableChecks` from `@fuul/sdk`:

```typescript
import { Fuul } from '@fuul/sdk';

const claimChecks = await Fuul.getClaimableChecks({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address', // evm_address | solana_address | xrpl_address | sui_address | stellar_address | email
});
```

Each claim check carries its own `id` (a uuid) alongside the voucher fields (`project_address`, `to`, `currency`, `currency_type`, `amount`, `reason`, `token_id`, `deadline`, `proof`, `signatures`). Use it to correlate a signed voucher with the rows returned by `getClaimChecks`, to deduplicate, or to reference a single check when closing.

{% hint style="info" %}
**Stellar projects.** Claim checks for a `stellar_address` return `currency_type: 0` (Stellar asset). Each `signatures` entry is a base64 XDR `SorobanAuthorizationEntry` pre-signed by Fuul, and each check carries an extra `signers` array with the signer `G…` addresses. Pass them to `@fuul/sdk-stellar` as shown in [Stellar Claiming](/developer-guide/claiming-onchain-rewards/stellar.md).
{% endhint %}

You can also call the [claim check endpoint](https://fuul.readme.io/reference/generateclaimsignature) on the Fuul API directly.

{% hint style="info" %}
`getClaimableChecks` was introduced in SDK version **7.8.0**. Upgrade if you're on an earlier version. The per-check `id` was added in **7.44.0**.
{% endhint %}

## Get claim totals

To show users their claimed and unclaimed balances without building a full transaction ([API reference](https://fuul.readme.io/reference/getclaimabletotals)):

```typescript
import { Fuul } from '@fuul/sdk';

const totals = await Fuul.getClaimCheckTotals({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address', // or 'solana_address' | 'stellar_address'
});
// Returns { claimed: [...], unclaimed: [...] } grouped by currency.
// Every row carries a `status`: 'claimed' in claimed[], 'open' or 'closed' in unclaimed[].

const readyToClaim = totals.unclaimed.filter((row) => row.status === 'closed');
const stillAccumulating = totals.unclaimed.filter((row) => row.status === 'open');
```

{% hint style="warning" %}
`unclaimed[]` is an umbrella: it holds both `open` rows (still aggregating, not signed) and `closed` rows (signed, ready to claim). To show a real "ready to claim" balance, filter on `status === 'closed'`. On projects with aggregation enabled most of the unclaimed total is usually `open`.
{% endhint %}

### Filtering totals

Both filters are optional query params. They narrow which claim checks are summed and do not change the response shape. An unknown value returns `400`.

| Param    | Values                                                 | Effect                                                                                                              |
| -------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| `status` | `claimed`, `unclaimed`, `open`, `closed`               | Return only rows in that state. `unclaimed` returns `open` and `closed` rows together, with `claimed[]` empty       |
| `reason` | `affiliate_payout`, `end_user_payout`, `agency_payout` | Sum only one earning type: commission for referring others, rebate on the user's own activity, or an agency's share |

`closed` in totals is the same state that `getClaimChecks` and every other endpoint report as `unclaimed`. The totals endpoint uses `unclaimed` for the umbrella instead.

| Totals (`getClaimCheckTotals`)          | Everywhere else (`getClaimChecks`, `GET /claim-checks`) |
| --------------------------------------- | ------------------------------------------------------- |
| `open`                                  | `open`                                                  |
| `closed`                                | `unclaimed`                                             |
| `unclaimed` (param only: open + closed) | —                                                       |
| `claimed`                               | `claimed`                                               |

Rows carry no `reason` field, so to show commission and rebate separately call the method twice:

```typescript
import { Fuul, ClaimCheckTotalsReasonFilter, ClaimCheckTotalsStatusFilter } from '@fuul/sdk';

const ids = { user_identifier: '0x1234...', user_identifier_type: 'evm_address' as const };

const commission = await Fuul.getClaimCheckTotals({ ...ids, reason: ClaimCheckTotalsReasonFilter.AffiliatePayout });
const rebate = await Fuul.getClaimCheckTotals({ ...ids, reason: ClaimCheckTotalsReasonFilter.EndUserPayout });

// Only what can be claimed right now
const claimable = await Fuul.getClaimCheckTotals({ ...ids, status: ClaimCheckTotalsStatusFilter.Closed });
```

The two `reason` calls sum to the unfiltered figure.

{% hint style="info" %}
The per-row `status` and the `status` filter were added in SDK **7.46.0**. The `reason` filter was added in **7.47.0**. An older SDK drops `reason` before sending the request and returns merged totals with no error, so check the SDK version if a reason filter appears to do nothing.
{% endhint %}

The public claim-checks endpoints are rate limited at 100 requests per minute per project, user and route. Exceeding it returns `429`.

## Claim check aggregation (open checks)

Some projects enable **claim check aggregation**, which batches multiple rewards into a single on-chain transaction per currency. This is optional and configured per project.

When aggregation is enabled, claim checks start with status `open` — they accumulate rewards over time without being signed yet. New rewards for the same user, currency, and reason are merged into the existing open check by summing amounts and extending deadlines. This reduces on-chain transactions from one per reward event to one per currency/reason combination.

To finalize an open check and make it claimable, call `POST /claim-checks/close`:

```typescript
import { Fuul } from '@fuul/sdk';

await Fuul.closeClaimChecks({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address',
});
```

`closeClaimChecks` returns the same `ClaimResponse` shape as `getClaimableChecks`, so the per-check `id` is available from either method. You can also pass `claim_check_ids` to close a specific subset instead of everything open.

After closing, the check transitions from `open` to `unclaimed` and receives its signature — at which point it's returned by `getClaimableChecks` and ready to claim onchain.

{% hint style="info" %}
If aggregation is not enabled for a project, claim checks are signed immediately at creation time and are returned as `unclaimed` from the start. No `close` call is needed.
{% endhint %}

## List claim checks by status

To inspect a user's checks without generating vouchers, use `getClaimChecks`. This is the SDK method behind `GET /claim-checks`:

```typescript
import { Fuul, ClaimCheckStatus } from '@fuul/sdk';

const { claim_checks } = await Fuul.getClaimChecks({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address',
  status: ClaimCheckStatus.Open, // optional — omit to return every status
});

claim_checks.forEach((check) => {
  console.log(`${check.id}: ${check.amount} ${check.currency_name} (${check.status})`);
});
```

| Status                                       | Meaning                                                                  |
| -------------------------------------------- | ------------------------------------------------------------------------ |
| `ClaimCheckStatus.Open` (`'open'`)           | Aggregating rewards, not signed yet. Call `closeClaimChecks` to finalize |
| `ClaimCheckStatus.Unclaimed` (`'unclaimed'`) | Signed and ready to claim onchain                                        |
| `ClaimCheckStatus.Claimed` (`'claimed'`)     | Already redeemed onchain                                                 |

Each row returns `id`, `currency_address`, `currency_chain_id`, `currency_name`, `currency_decimals`, `reason`, `amount`, `status`, `deadline_seconds`, and `created_at`. Note that these are metadata rows, not vouchers: they carry no `proof` or `signatures`. Use `getClaimableChecks` when you need to submit a transaction.

## Next steps

Once you have your claim checks, follow the guide for your chain:

* [EVM Claiming](/developer-guide/claiming-onchain-rewards/evm.md) for Ethereum, Arbitrum, Base, HyperEVM, Ink, Monad, Optimism
* [SVM Claiming (Solana)](/developer-guide/claiming-onchain-rewards/svm-solana.md) — for Solana Mainnet, Devnet, Fogo Mainnet
* [Stellar Claiming](/developer-guide/claiming-onchain-rewards/stellar.md) — for Stellar Mainnet and Testnet