Quickstart

Get a platform treasury flow running in a few requests.

1

Create an Account

Sign up for Soledgic and start in sandbox. Sandbox and live ledgers are isolated from each other.

Create Account
2

Get Your API Key

Grab your key from Settings → API Keys. Use slk_test_* while you are integrating.

3

Create a Participant

Participants are the treasury identities that receive balances, holds, transfers, and payouts.

curl -X POST https://api.soledgic.com/v1/participants \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participant_id": "creator_456",
    "display_name": "Jane Creator",
    "email": "jane@example.com",
    "default_split_percent": 80
  }'
{
  "success": true,
  "participant": {
    "id": "creator_456",
    "account_id": "0e8e3fd8-7b7c-4f41-8b62-4a95a9fd6a30",
    "display_name": "Jane Creator",
    "email": "jane@example.com",
    "default_split_percent": 80
  }
}
4

Create a Checkout Session

Checkouts book the commercial flow while the ledger records the downstream treasury state.

curl -X POST https://api.soledgic.com/v1/checkout-sessions \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participant_id": "creator_456",
    "amount": 2999,
    "currency": "USD",
    "product_name": "Premium asset pack",
    "success_url": "https://example.com/success",
    "cancel_url": "https://example.com/cancel"
  }'
{
  "success": true,
  "checkout_session": {
    "id": "chk_abc123",
    "mode": "session",
    "checkout_url": "https://checkout.example/session/chk_abc123",
    "status": "pending",
    "amount": 2999,
    "currency": "USD"
  }
}
5

Inspect Wallet and Holds

Once payment settles, inspect the wallet objects for that owner and any active hold state separately.

curl -X GET "https://api.soledgic.com/v1/wallets?owner_id=creator_456&wallet_type=creator_earnings" \
  -H "x-api-key: slk_test_YOUR_API_KEY"
curl -X GET "https://api.soledgic.com/v1/holds?participant_id=creator_456" \
  -H "x-api-key: slk_test_YOUR_API_KEY"
6

Check Eligibility and Create a Payout

Payout creation is separate from hold release and balance inspection, which keeps the treasury flow explicit.

curl -X GET "https://api.soledgic.com/v1/participants/creator_456/payout-eligibility" \
  -H "x-api-key: slk_test_YOUR_API_KEY"
curl -X POST https://api.soledgic.com/v1/payouts \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participant_id": "creator_456",
    "reference_id": "payout_2026_03_12_001",
    "amount": 1500,
    "payout_method": "card"
  }'

Use a unique reference_id for payouts and transfers. Today that is the replay-safe key for those treasury writes.

Next Steps