API Reference

Generated reference for the Soledgic API. The treasury resources are the canonical surface for new integrations.

The public treasury API is resource-first. If you are migrating older integrations, use the resource mapping guide in docs/RESOURCE_MODEL_MIGRATION.md.

This reference is for the supported public integration surface. Dashboard/session routes such as/api/identity/* and/api/ecosystems/* are operator-only and intentionally excluded from the public SDK and OpenAPI spec.

Base URLs

https://api.soledgic.com/v1

https://YOUR_PROJECT.supabase.co/functions/v1

Most endpoints use x-api-key. Billing, bootstrap, and webhook endpoints use JWT or signature-based auth as shown per endpoint below.

Quick Reference

92 endpoints (78 public, 10 internal, 4 deprecated) organized into 17 resource groups.

Treasury

Endpoint	Methods	Auth	Status	Details
Release Hold `/v1/holds/{hold_id}/release`	POST	API key	Public	View details
Holds `/v1/holds`	GET	API key	Public	View details
Holds Summary `/v1/holds/summary`	GET	API key	Public	View details
Participant Detail `/v1/participants/{participant_id}`	GET	API key	Public	View details
Participant Payout Eligibility `/v1/participants/{participant_id}/payout-eligibility`	GET	API key	Public	View details
Participants `/v1/participants`	GETPOST	API key	Public	View details
Transfers `/v1/transfers`	POST	API key	Public	View details
Wallet Topup `/v1/wallets/{wallet_id}/topups`	POST	API key	Public	View details
Wallet Detail `/v1/wallets/{wallet_id}`	GET	API key	Public	View details
Wallet Entries `/v1/wallets/{wallet_id}/entries`	GET	API key	Public	View details
Wallet Withdrawal `/v1/wallets/{wallet_id}/withdrawals`	POST	API key	Public	View details

Release Hold

/v1/holds/{hold_id}/release

POSTAPI key

Release a held-funds entry and optionally execute the transfer.

Gateway path

https://api.soledgic.com/v1/holds/{hold_id}/release

Supabase function

/functions/v1/hold-release

Source

supabase/functions/holds/index.ts

Parameters

Location	Name	Type	Required
path	`hold_id`	string	Yes
body	`execute_transfer`	boolean	No

Example Request

curl -X POST "https://api.soledgic.com/v1/holds/hold_id_123/release" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "execute_transfer": true
}'

Holds

/v1/holds

GETAPI key

List held funds across participants, with optional readiness filtering.

Gateway path

https://api.soledgic.com/v1/holds

Supabase function

/functions/v1/holds

Source

supabase/functions/holds/index.ts

Parameters

Location	Name	Type	Required
query	`participant_id`	string	No
query	`venture_id`	string	No
query	`ready_only`	boolean	No
query	`limit`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/holds?participant_id=participant_id_123&venture_id=venture_id_123&ready_only=true&limit=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Holds Summary

/v1/holds/summary

GETAPI key

Get an aggregate summary of held and releasable funds.

Gateway path

https://api.soledgic.com/v1/holds/summary

Supabase function

/functions/v1/holds-summary

Source

supabase/functions/holds/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X GET "https://api.soledgic.com/v1/holds/summary" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Participant Detail

/v1/participants/{participant_id}

GETAPI key

Get a participant balance snapshot, including active holds.

Gateway path

https://api.soledgic.com/v1/participants/{participant_id}

Supabase function

/functions/v1/participant-detail

Source

supabase/functions/participants/index.ts

Parameters

Location	Name	Type	Required
path	`participant_id`	string	Yes

Example Request

curl -X GET "https://api.soledgic.com/v1/participants/participant_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Participant Payout Eligibility

/v1/participants/{participant_id}/payout-eligibility

GETAPI key

Check whether a participant is currently eligible for payout.

Gateway path

https://api.soledgic.com/v1/participants/{participant_id}/payout-eligibility

Supabase function

/functions/v1/participant-payout-eligibility

Source

supabase/functions/participants/index.ts

Parameters

Location	Name	Type	Required
path	`participant_id`	string	Yes

Example Request

curl -X GET "https://api.soledgic.com/v1/participants/participant_id_123/payout-eligibility" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Participants

/v1/participants

GETPOSTAPI key

List treasury participants or create a new participant-backed account.

Gateway path

https://api.soledgic.com/v1/participants

Supabase function

/functions/v1/participants

Source

supabase/functions/participants/index.ts

Parameters

Location	Name	Type	Required
body	`participant_id`	string	Yes
body	`user_id`	string	No
body	`display_name`	string	No
body	`email`	string	No
body	`default_split_percent`	number	No
body	`tax_info`	{	No
body	`payout_preferences`	{	No
body	`metadata`	Record<string, unknown>	No

Example Request

curl -X GET "https://api.soledgic.com/v1/participants" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Transfers

/v1/transfers

POSTAPI key

Move funds between wallets when both wallets explicitly permit transfer.

Gateway path

https://api.soledgic.com/v1/transfers

Supabase function

/functions/v1/transfers

Source

supabase/functions/transfers/index.ts

Parameters

Location	Name	Type	Required
body	`from_wallet_id`	string	No
body	`to_wallet_id`	string	No
body	`from_participant_id`	string	No
body	`to_participant_id`	string	No
body	`amount`	number	Yes
body	`reference_id`	string	Yes
body	`description`	string	No
body	`metadata`	Record<string, unknown>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/transfers" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "reference_id": "reference_id_123",
  "from_wallet_id": "from_wallet_id_123",
  "to_wallet_id": "to_wallet_id_123",
  "from_participant_id": "from_participant_id_123",
  "to_participant_id": "to_participant_id_123",
  "description": "value",
  "metadata": {}
}'

Wallet Topup

/v1/wallets/{wallet_id}/topups

POSTAPI key

Top up a wallet when its wallet type supports external funding.

Gateway path

https://api.soledgic.com/v1/wallets/{wallet_id}/topups

Supabase function

/functions/v1/wallet-deposit

Source

supabase/functions/wallets/index.ts

Parameters

Location	Name	Type	Required
path	`wallet_id`	string	Yes
body	`amount`	number	Yes
body	`reference_id`	string	Yes
body	`description`	string	No
body	`metadata`	Record<string, unknown>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/wallets/wallet_id_123/topups" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "reference_id": "reference_id_123",
  "description": "value",
  "metadata": {}
}'

Wallet Detail

/v1/wallets/{wallet_id}

GETAPI key

Get a wallet object by wallet id.

Gateway path

https://api.soledgic.com/v1/wallets/{wallet_id}

Supabase function

/functions/v1/wallet-detail

Source

supabase/functions/wallets/index.ts

Parameters

Location	Name	Type	Required
path	`wallet_id`	string	Yes

Example Request

curl -X GET "https://api.soledgic.com/v1/wallets/wallet_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Wallet Entries

/v1/wallets/{wallet_id}/entries

GETAPI key

List wallet ledger entries for a wallet object.

Gateway path

https://api.soledgic.com/v1/wallets/{wallet_id}/entries

Supabase function

/functions/v1/wallet-entries

Source

supabase/functions/wallets/index.ts

Parameters

Location	Name	Type	Required
path	`wallet_id`	string	Yes
query	`limit`	number	No
query	`offset`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/wallets/wallet_id_123/entries?limit=1000&offset=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Wallet Withdrawal

/v1/wallets/{wallet_id}/withdrawals

POSTAPI key

Withdraw or debit funds from a wallet when the wallet is redeemable.

Gateway path

https://api.soledgic.com/v1/wallets/{wallet_id}/withdrawals

Supabase function

/functions/v1/wallet-withdrawal

Source

supabase/functions/wallets/index.ts

Parameters

Location	Name	Type	Required
path	`wallet_id`	string	Yes
body	`amount`	number	Yes
body	`reference_id`	string	Yes
body	`description`	string	No
body	`metadata`	Record<string, unknown>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/wallets/wallet_id_123/withdrawals" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "reference_id": "reference_id_123",
  "description": "value",
  "metadata": {}
}'

Payments

Endpoint	Methods	Auth	Status	Details
Checkout Sessions `/v1/checkout-sessions`	POST	API key	Public	View details
Payouts `/v1/payouts`	POST	API key	Public	View details
Refunds `/v1/refunds`	GETPOST	API key	Public	View details

Checkout Sessions

/v1/checkout-sessions

POSTAPI key

Create a hosted or direct checkout session for a participant sale.

Gateway path

https://api.soledgic.com/v1/checkout-sessions

Supabase function

/functions/v1/checkout-sessions

Source

supabase/functions/checkout-sessions/index.ts

Parameters

Location	Name	Type	Required
body	`participant_id`	string	Yes
body	`amount`	number	Yes
body	`currency`	string	No
body	`product_id`	string	No
body	`product_name`	string	No
body	`customer_email`	string	No
body	`customer_id`	string	No
body	`payment_method_id`	string	No
body	`source_id`	string	No
body	`success_url`	string	No
body	`cancel_url`	string	No
body	`idempotency_key`	string	No
body	`metadata`	Record<string, string>	No

Example Request

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": "participant_id_123",
  "amount": 1000,
  "currency": "value",
  "product_id": "product_id_123",
  "product_name": "value",
  "customer_email": "user@example.com",
  "customer_id": "customer_id_123",
  "payment_method_id": "payment_method_id_123"
}'

Payouts

/v1/payouts

POSTAPI key

Create a payout for a creator earnings wallet or participant.

Gateway path

https://api.soledgic.com/v1/payouts

Supabase function

/functions/v1/payouts

Source

supabase/functions/payouts/index.ts

Parameters

Location	Name	Type	Required
body	`wallet_id`	string	No
body	`participant_id`	string	No
body	`amount`	number	Yes
body	`reference_id`	string	Yes
body	`reference_type`	string	No
body	`description`	string	No
body	`payout_method`	string	No
body	`fees`	number	No
body	`fees_paid_by`	'platform' \| 'creator'	No
body	`metadata`	Record<string, unknown>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/payouts" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "reference_id": "reference_id_123",
  "wallet_id": "wallet_id_123",
  "participant_id": "participant_id_123",
  "reference_type": "value",
  "description": "value",
  "payout_method": "value",
  "fees": 1000
}'

Refunds

/v1/refunds

GETPOSTAPI key

List refunds or create a refund against a recorded sale.

Gateway path

https://api.soledgic.com/v1/refunds

Supabase function

/functions/v1/refunds

Source

supabase/functions/refunds/index.ts

Parameters

Location	Name	Type	Required
query	`sale_reference`	string	No
query	`limit`	number	No
body	`original_sale_reference`	string	Yes
body	`reason`	string	Yes
body	`amount`	number	No
body	`refund_from`	'both' \| 'platform_only' \| 'creator_only'	No
body	`external_refund_id`	string	No
body	`idempotency_key`	string	No
body	`mode`	'ledger_only' \| 'processor_refund'	No
body	`processor_payment_id`	string	No
body	`metadata`	Record<string, unknown>	No

Example Request

curl -X GET "https://api.soledgic.com/v1/refunds?sale_reference=value&limit=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Transactions

Endpoint	Methods	Auth	Status	Details
Get Transactions `/v1/get-transactions`	GET	API key	Public	View details
Import Transactions `/v1/import-transactions`	POST	API key	Public	View details
Pay Bill `/v1/pay-bill`	POST	API key	Public	View details
Record Adjustment `/v1/record-adjustment`	POST	API key	Public	View details
Record Bill `/v1/record-bill`	POST	API key	Public	View details
Record Expense `/v1/record-expense`	POST	API key	Public	View details
Record Income `/v1/record-income`	POST	API key	Public	View details
Record Opening Balance `/v1/record-opening-balance`	POST	API key	Public	View details
Record Sale `/v1/record-sale`	POST	API key	Public	View details
Record Transfer `/v1/record-transfer`	POST	API key	Public	View details
Reverse Transaction `/v1/reverse-transaction`	POST	API key	Public	View details

Get Transactions

/v1/get-transactions

GETAPI key

Get Transactions

Gateway path

https://api.soledgic.com/v1/get-transactions

Supabase function

/functions/v1/get-transactions

Source

supabase/functions/get-transactions/index.ts

Parameters

Location	Name	Type	Required
query	`creator_id`	string	No
query	`type`	string	No
query	`status`	string	No
query	`start_date`	string	No
query	`end_date`	string	No
query	`page`	string	No
query	`per_page`	string	No
query	`include_entries`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/get-transactions?creator_id=creator_id_123&type=value&status=value&start_date=2026-01-01" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Import Transactions

/v1/import-transactions

POSTAPI key

Import Transactions

Gateway path

https://api.soledgic.com/v1/import-transactions

Supabase function

/functions/v1/import-transactions

Source

supabase/functions/import-transactions/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'parse_preview' \| 'import' \| 'get_templates' \| 'save_template'	Yes
body	`format`	'csv' \| 'ofx' \| 'qfx' \| 'camt053' \| 'bai2' \| 'mt940' \| 'auto'	No
body	`data`	string	No
body	`mapping`	ColumnMapping	No
body	`template_id`	string	No
body	`template`	ImportTemplate	No
body	`transactions`	ParsedTransaction[]	No
body	`account_name`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/import-transactions" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "parse_preview",
  "format": "csv",
  "data": "value",
  "mapping": "value",
  "template_id": "template_id_123",
  "template": "value",
  "transactions": [
    "item_1"
  ],
  "account_name": "value"
}'

Pay Bill

/v1/pay-bill

POSTAPI key

Records payment of a bill (reduces A/P, reduces Cash)

Gateway path

https://api.soledgic.com/v1/pay-bill

Supabase function

/functions/v1/pay-bill

Source

supabase/functions/pay-bill/index.ts

Parameters

Location	Name	Type	Required
body	`bill_transaction_id`	string	No
body	`amount`	number	Yes
body	`vendor_name`	string	No
body	`reference_id`	string	No
body	`payment_method`	string	No
body	`payment_date`	string	No
body	`metadata`	Record<string, any>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/pay-bill" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "bill_transaction_id": "bill_transaction_id_123",
  "vendor_name": "value",
  "reference_id": "reference_id_123",
  "payment_method": "value",
  "payment_date": "2026-01-01",
  "metadata": {}
}'

Record Adjustment

/v1/record-adjustment

POSTAPI key

Record Adjustment Journal

Gateway path

https://api.soledgic.com/v1/record-adjustment

Supabase function

/functions/v1/record-adjustment

Source

supabase/functions/record-adjustment/index.ts

Parameters

Location	Name	Type	Required
body	`adjustment_type`	string	Yes
body	`adjustment_date`	string	No
body	`entries`	AdjustmentEntry[]	Yes
body	`reason`	string	Yes
body	`original_transaction_id`	string	No
body	`supporting_documentation`	string	No
body	`prepared_by`	string	Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/record-adjustment" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "adjustment_type": "value",
  "entries": [
    "item_1"
  ],
  "reason": "value",
  "prepared_by": "value",
  "adjustment_date": "2026-01-01",
  "original_transaction_id": "original_transaction_id_123",
  "supporting_documentation": "value"
}'

Record Bill

/v1/record-bill

POSTAPI key

Record Bill

Gateway path

https://api.soledgic.com/v1/record-bill

Supabase function

/functions/v1/record-bill

Source

supabase/functions/record-bill/index.ts

Parameters

Location	Name	Type	Required
body	`amount`	number	Yes
body	`description`	string	Yes
body	`vendor_name`	string	Yes
body	`vendor_id`	string	No
body	`reference_id`	string	No
body	`due_date`	string	No
body	`expense_category`	string	No
body	`paid`	boolean	No
body	`metadata`	Record<string, any>	No
body	`authorizing_instrument_id`	string	No
body	`risk_evaluation_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-bill" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "description": "value",
  "vendor_name": "value",
  "vendor_id": "vendor_id_123",
  "reference_id": "reference_id_123",
  "due_date": "2026-01-01",
  "expense_category": "value",
  "paid": true
}'

Record Expense

/v1/record-expense

POSTAPI key

Record Expense

Gateway path

https://api.soledgic.com/v1/record-expense

Supabase function

/functions/v1/record-expense

Source

supabase/functions/record-expense/index.ts

Parameters

Location	Name	Type	Required
body	`reference_id`	string	Yes
body	`amount`	number	Yes
body	`description`	string	Yes
body	`category`	string	No
body	`vendor_id`	string	No
body	`vendor_name`	string	No
body	`paid_from`	'cash' \| 'credit_card' \| string	No
body	`receipt_url`	string	No
body	`tax_deductible`	boolean	No
body	`metadata`	Record<string, any>	No
body	`authorizing_instrument_id`	string	No
body	`risk_evaluation_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-expense" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reference_id": "reference_id_123",
  "amount": 1000,
  "description": "value",
  "category": "value",
  "vendor_id": "vendor_id_123",
  "vendor_name": "value",
  "paid_from": "cash",
  "receipt_url": "value"
}'

Record Income

/v1/record-income

POSTAPI key

Record Income

Gateway path

https://api.soledgic.com/v1/record-income

Supabase function

/functions/v1/record-income

Source

supabase/functions/record-income/index.ts

Parameters

Location	Name	Type	Required
body	`reference_id`	string	Yes
body	`amount`	number	Yes
body	`description`	string	Yes
body	`category`	string	No
body	`customer_id`	string	No
body	`customer_name`	string	No
body	`received_to`	'cash' \| string	No
body	`invoice_id`	string	No
body	`metadata`	Record<string, any>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-income" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reference_id": "reference_id_123",
  "amount": 1000,
  "description": "value",
  "category": "value",
  "customer_id": "customer_id_123",
  "customer_name": "value",
  "received_to": "cash",
  "invoice_id": "invoice_id_123"
}'

Record Opening Balance

/v1/record-opening-balance

POSTAPI key

Record Opening Balances

Gateway path

https://api.soledgic.com/v1/record-opening-balance

Supabase function

/functions/v1/record-opening-balance

Source

supabase/functions/record-opening-balance/index.ts

Parameters

Location	Name	Type	Required
body	`as_of_date`	string	Yes
body	`source`	'manual' \| 'imported' \| 'migrated' \| 'year_start'	Yes
body	`source_description`	string	No
body	`balances`	OpeningBalanceEntry[]	Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/record-opening-balance" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "as_of_date": "2026-01-01",
  "source": "manual",
  "balances": [
    "item_1"
  ],
  "source_description": "value"
}'

Record Sale

/v1/record-sale

POSTAPI key

Record Sale

Gateway path

https://api.soledgic.com/v1/record-sale

Supabase function

/functions/v1/record-sale

Source

supabase/functions/record-sale/index.ts

Parameters

Location	Name	Type	Required
body	`reference_id`	string	Yes
body	`creator_id`	string	Yes
body	`amount`	number	Yes
body	`processing_fee`	number	No
body	`processing_fee_paid_by`	'platform' \| 'creator' \| 'split'	No
body	`product_id`	string	No
body	`product_name`	string	No
body	`creator_percent`	number	No
body	`skip_withholding`	boolean	No
body	`metadata`	Record<string, any>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-sale" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reference_id": "reference_id_123",
  "creator_id": "creator_id_123",
  "amount": 1000,
  "processing_fee": 1000,
  "processing_fee_paid_by": "platform",
  "product_id": "product_id_123",
  "product_name": "value",
  "creator_percent": 20
}'

Record Transfer

/v1/record-transfer

POSTAPI key

Record Internal Transfer

Gateway path

https://api.soledgic.com/v1/record-transfer

Supabase function

/functions/v1/record-transfer

Source

supabase/functions/record-transfer/index.ts

Parameters

Location	Name	Type	Required
body	`from_account_type`	string	Yes
body	`to_account_type`	string	Yes
body	`amount`	number	Yes
body	`transfer_type`	'tax_reserve' \| 'payout_reserve' \| 'owner_draw' \|	Yes
body	`description`	string	No
body	`reference_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-transfer" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "from_account_type": "value",
  "to_account_type": "value",
  "amount": 1000,
  "transfer_type": "tax_reserve",
  "description": "value",
  "reference_id": "reference_id_123"
}'

Reverse Transaction

/v1/reverse-transaction

POSTAPI key

Reverse Transaction

Gateway path

https://api.soledgic.com/v1/reverse-transaction

Supabase function

/functions/v1/reverse-transaction

Source

supabase/functions/reverse-transaction/index.ts

Parameters

Location	Name	Type	Required
body	`transaction_id`	string	Yes
body	`reason`	string	Yes
body	`partial_amount`	number	No
body	`idempotency_key`	string	No
body	`metadata`	Record<string, any>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/reverse-transaction" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "transaction_id": "transaction_id_123",
  "reason": "value",
  "partial_amount": 1000,
  "idempotency_key": "idempotency_key_123",
  "metadata": {}
}'

Payouts

Endpoint	Methods	Auth	Status	Details
Execute Payout `/v1/execute-payout`	POST	API key	Public	View details
Scheduled Payouts `/v1/scheduled-payouts`	POST	API key	Internal	View details

Execute Payout

/v1/execute-payout

POSTAPI key

Soledgic Processor Adapter

Gateway path

https://api.soledgic.com/v1/execute-payout

Supabase function

/functions/v1/execute-payout

Source

supabase/functions/execute-payout/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'execute' \| 'batch_execute' \| 'get_status' \| 'configure_rail' \| 'list_rails' ...	Yes
body	`payout_id`	string	No
body	`payout_ids`	string[]	No
body	`rail`	PayoutRail	No
body	`rail_config`	RailConfig	No

Example Request

curl -X POST "https://api.soledgic.com/v1/execute-payout" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "execute",
  "payout_id": "payout_id_123",
  "payout_ids": [
    "item_1"
  ],
  "rail": "value",
  "rail_config": "value"
}'

Scheduled Payouts

/v1/scheduled-payouts

POSTAPI keyInternal

Scheduled Payouts

Gateway path

https://api.soledgic.com/v1/scheduled-payouts

Supabase function

/functions/v1/scheduled-payouts

Source

supabase/functions/scheduled-payouts/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/scheduled-payouts" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Checkouts

Endpoint	Methods	Auth	Status	Details
Preflight Authorization `/v1/preflight-authorization`	POST	API key	Public	View details
Receive Payment `/v1/receive-payment`	POST	API key	Public	View details

Preflight Authorization

/v1/preflight-authorization

POSTAPI key

Preflight Authorization

Gateway path

https://api.soledgic.com/v1/preflight-authorization

Supabase function

/functions/v1/preflight-authorization

Source

supabase/functions/preflight-authorization/index.ts

Parameters

Location	Name	Type	Required
body	`idempotency_key`	string	Yes
body	`amount`	number	Yes
body	`currency`	string	No
body	`counterparty_name`	string	No
body	`authorizing_instrument_id`	string	No
body	`expected_date`	string	No
body	`category`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/preflight-authorization" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "idempotency_key": "idempotency_key_123",
  "amount": 1000,
  "currency": "value",
  "counterparty_name": "value",
  "authorizing_instrument_id": "authorizing_instrument_id_123",
  "expected_date": "2026-01-01",
  "category": "value"
}'

Receive Payment

/v1/receive-payment

POSTAPI key

Receive Payment

Gateway path

https://api.soledgic.com/v1/receive-payment

Supabase function

/functions/v1/receive-payment

Source

supabase/functions/receive-payment/index.ts

Parameters

Location	Name	Type	Required
body	`invoice_transaction_id`	string	No
body	`amount`	number	Yes
body	`customer_name`	string	No
body	`customer_id`	string	No
body	`reference_id`	string	No
body	`payment_method`	string	No
body	`payment_date`	string	No
body	`metadata`	Record<string, any>	No

Example Request

curl -X POST "https://api.soledgic.com/v1/receive-payment" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "invoice_transaction_id": "invoice_transaction_id_123",
  "customer_name": "value",
  "customer_id": "customer_id_123",
  "reference_id": "reference_id_123",
  "payment_method": "value",
  "payment_date": "2026-01-01",
  "metadata": {}
}'

Accounts

Endpoint	Methods	Auth	Status	Details
Delete Creator `/v1/delete-creator`	POST	API key	Public	View details
Manage Splits `/v1/manage-splits`	POST	API key	Public	View details
Register Instrument `/v1/register-instrument`	POST	API key	Public	View details

Delete Creator

/v1/delete-creator

POSTAPI key

Soft-delete a creator (sets is_active = false with transaction guard)

Gateway path

https://api.soledgic.com/v1/delete-creator

Supabase function

/functions/v1/delete-creator

Source

supabase/functions/delete-creator/index.ts

Parameters

Location	Name	Type	Required
body	`creator_id`	string	Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/delete-creator" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "creator_id": "creator_id_123"
}'

Manage Splits

/v1/manage-splits

POSTAPI key

Manage Splits

Gateway path

https://api.soledgic.com/v1/manage-splits

Supabase function

/functions/v1/manage-splits

Source

supabase/functions/manage-splits/index.ts

Parameters

Location	Name	Type	Required
body	`action`	Action	Yes
body	`creator_id`	string	No
body	`creator_percent`	number	No
body	`product_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/manage-splits" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "value",
  "creator_id": "creator_id_123",
  "creator_percent": 20,
  "product_id": "product_id_123"
}'

/v1/register-instrument

POSTAPI key

Gateway path

https://api.soledgic.com/v1/register-instrument

Supabase function

/functions/v1/register-instrument

Source

supabase/functions/register-instrument/index.ts

Parameters

Location	Name	Type	Required
body	`external_ref`	string	Yes
body	`extracted_terms`	ExtractedTerms	Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/register-instrument" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "external_ref": "value",
  "extracted_terms": "value"
}'

Ledgers

Endpoint	Methods	Auth	Status	Details
Close Period `/v1/close-period`	POST	API key	Public	View details
Create Ledger `/v1/create-ledger`	POST	Public/JWT	Public	View details
Frozen Statements `/v1/frozen-statements`	POST	API key	Public	View details
List Ledgers `/v1/list-ledgers`	GET	Public/JWT	Public	View details

Close Period

/v1/close-period

POSTAPI key

Close Accounting Period

Gateway path

https://api.soledgic.com/v1/close-period

Supabase function

/functions/v1/close-period

Source

supabase/functions/close-period/index.ts

Parameters

Location	Name	Type	Required
body	`year`	number	Yes
body	`month`	number	No
body	`quarter`	number	No
body	`notes`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/close-period" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "year": 1000,
  "month": 1000,
  "quarter": 1000,
  "notes": "value"
}'

Create Ledger

/v1/create-ledger

POSTPublic/JWT

Create Ledger

Gateway path

https://api.soledgic.com/v1/create-ledger

Supabase function

/functions/v1/create-ledger

Source

supabase/functions/create-ledger/index.ts

Parameters

Location	Name	Type	Required
body	`business_name`	string	Yes
body	`owner_email`	string	No
body	`ledger_mode`	'standard' \| 'marketplace' \| 'platform'	No
body	`settings`	{	No
body	`default_tax_rate`	number	No
body	`fiscal_year_start`	string	No
body	`receipt_threshold`	number	No
body	`default_split_percent`	number	No
body	`platform_fee_percent`	number	No
body	`min_payout_amount`	number	No
body	`payout_schedule`	'manual' \| 'weekly' \| 'monthly'	No
body	`tax_withholding_percent`	number	No
body	`currency`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/create-ledger" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "business_name": "value",
  "owner_email": "user@example.com",
  "ledger_mode": "standard",
  "settings": {},
  "default_tax_rate": 1000,
  "fiscal_year_start": "value",
  "receipt_threshold": 1000,
  "default_split_percent": 20
}'

Frozen Statements

/v1/frozen-statements

POSTAPI key

Frozen Statements

Gateway path

https://api.soledgic.com/v1/frozen-statements

Supabase function

/functions/v1/frozen-statements

Source

supabase/functions/frozen-statements/index.ts

Parameters

Location	Name	Type	Required
body	`action`	Action	Yes
body	`period_id`	string	No
body	`statement_type`	StatementType	No

Example Request

curl -X POST "https://api.soledgic.com/v1/frozen-statements" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "value",
  "period_id": "period_id_123",
  "statement_type": "value"
}'

List Ledgers

/v1/list-ledgers

GETPublic/JWT

List Ledgers

Gateway path

https://api.soledgic.com/v1/list-ledgers

Supabase function

/functions/v1/list-ledgers

Source

supabase/functions/list-ledgers/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X GET "https://api.soledgic.com/v1/list-ledgers" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Reports

Endpoint	Methods	Auth	Status	Details
Ap Aging `/v1/ap-aging`	GET	API key	Public	View details
Ar Aging `/v1/ar-aging`	GET	API key	Public	View details
Balance Sheet `/v1/balance-sheet`	GET	API key	Public	View details
Export Report `/v1/export-report`	POST	API key	Public	View details
Generate Pdf `/v1/generate-pdf`	POST	API key	Public	View details
Generate Report `/v1/generate-report`	POST	API key	Public	View details
Get Runway `/v1/get-runway`	GET	API key	Public	View details
Profit Loss `/v1/profit-loss`	GETPOST	API key	Public	View details
Send Statements `/v1/send-statements`	POST	API key	Public	View details
Trial Balance `/v1/trial-balance`	GETPOST	API key	Public	View details

Ap Aging

/v1/ap-aging

GETAPI key

Accounts Payable Aging Report

Gateway path

https://api.soledgic.com/v1/ap-aging

Supabase function

/functions/v1/ap-aging

Source

supabase/functions/ap-aging/index.ts

Parameters

Location	Name	Type	Required
query	`as_of_date`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/ap-aging?as_of_date=2026-01-01" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Ar Aging

/v1/ar-aging

GETAPI key

Accounts Receivable Aging Report

Gateway path

https://api.soledgic.com/v1/ar-aging

Supabase function

/functions/v1/ar-aging

Source

supabase/functions/ar-aging/index.ts

Parameters

Location	Name	Type	Required
query	`as_of_date`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/ar-aging?as_of_date=2026-01-01" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Balance Sheet

/v1/balance-sheet

GETAPI key

Balance Sheet Report

Gateway path

https://api.soledgic.com/v1/balance-sheet

Supabase function

/functions/v1/balance-sheet

Source

supabase/functions/balance-sheet/index.ts

Parameters

Location	Name	Type	Required
query	`as_of_date`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/balance-sheet?as_of_date=2026-01-01" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Export Report

/v1/export-report

POSTAPI key

Export Report

Gateway path

https://api.soledgic.com/v1/export-report

Supabase function

/functions/v1/export-report

Source

supabase/functions/export-report/index.ts

Parameters

Location	Name	Type	Required
body	`report_type`	'transaction_detail' \| 'creator_earnings' \| 'platform_revenue' \|	Yes
body	`format`	'csv' \| 'json'	Yes
body	`start_date`	string	No
body	`end_date`	string	No
body	`creator_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/export-report" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "report_type": "transaction_detail",
  "format": "csv",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "creator_id": "creator_id_123"
}'

Generate Pdf

/v1/generate-pdf

POSTAPI key

Generate PDF Reports

Gateway path

https://api.soledgic.com/v1/generate-pdf

Supabase function

/functions/v1/generate-pdf

Source

supabase/functions/generate-pdf/index.ts

Parameters

Location	Name	Type	Required
body	`report_type`	ReportType	Yes
body	`period_id`	string	No
body	`creator_id`	string	No
body	`start_date`	string	No
body	`end_date`	string	No
body	`tax_year`	number	No
body	`ledger_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/generate-pdf" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "report_type": "value",
  "period_id": "period_id_123",
  "creator_id": "creator_id_123",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "tax_year": 1000,
  "ledger_id": "ledger_id_123"
}'

Generate Report

/v1/generate-report

POSTAPI key

Generate Report

Gateway path

https://api.soledgic.com/v1/generate-report

Supabase function

/functions/v1/generate-report

Source

supabase/functions/generate-report/index.ts

Parameters

Location	Name	Type	Required
body	`report_type`	ReportType	Yes
body	`start_date`	string	No
body	`end_date`	string	No
body	`creator_id`	string	No
body	`format`	'json' \| 'csv'	No

Example Request

curl -X POST "https://api.soledgic.com/v1/generate-report" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "report_type": "value",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "creator_id": "creator_id_123",
  "format": "json"
}'

Get Runway

/v1/get-runway

GETAPI key

Get Runway

Gateway path

https://api.soledgic.com/v1/get-runway

Supabase function

/functions/v1/get-runway

Source

supabase/functions/get-runway/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X GET "https://api.soledgic.com/v1/get-runway" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Profit Loss

/v1/profit-loss

GETPOSTAPI key

Profit & Loss Report

Gateway path

https://api.soledgic.com/v1/profit-loss

Supabase function

/functions/v1/profit-loss

Source

supabase/functions/profit-loss/index.ts

Parameters

Location	Name	Type	Required
query	`year`	string	No
query	`month`	string	No
query	`quarter`	string	No
query	`breakdown`	string	No
query	`start_date`	string	No
query	`end_date`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/profit-loss?year=value&month=value&quarter=value&breakdown=value" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Send Statements

/v1/send-statements

POSTAPI key

Soledgic Auto-Email Service

Gateway path

https://api.soledgic.com/v1/send-statements

Supabase function

/functions/v1/send-statements

Source

supabase/functions/send-statements/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'send_monthly_statements' \| 'send_single_statement' \| 'preview' \| 'get_queue'...	Yes
body	`ledger_id`	string	No
body	`creator_id`	string	No
body	`year`	number	No
body	`month`	number	No
body	`email_config`	EmailConfig	No

Example Request

curl -X POST "https://api.soledgic.com/v1/send-statements" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "send_monthly_statements",
  "ledger_id": "ledger_id_123",
  "creator_id": "creator_id_123",
  "year": 1000,
  "month": 1000,
  "email_config": "user@example.com"
}'

Trial Balance

/v1/trial-balance

GETPOSTAPI key

Trial Balance

Gateway path

https://api.soledgic.com/v1/trial-balance

Supabase function

/functions/v1/trial-balance

Source

supabase/functions/trial-balance/index.ts

Parameters

Location	Name	Type	Required
query	`snapshot`	string	No
query	`as_of`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/trial-balance?snapshot=value&as_of=value" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Invoices

Endpoint	Methods	Auth	Status	Details
Invoices `/v1/invoices`	GETPOST	API key	Public	View details

Invoices

/v1/invoices

GETPOSTAPI key

Invoice Management

Gateway path

https://api.soledgic.com/v1/invoices

Supabase function

/functions/v1/invoices

Source

supabase/functions/invoices/index.ts

Parameters

Location	Name	Type	Required
query	`status`	string	No
query	`customer_id`	string	No
query	`limit`	string	No
query	`offset`	string	No
body	`customer_name`	string	Yes
body	`customer_email`	string	No
body	`customer_id`	string	No
body	`customer_address`	{	No
body	`line1`	string	No
body	`line2`	string	No
body	`city`	string	No
body	`state`	string	No
body	`postal_code`	string	No
body	`country`	string	No
body	`line_items`	InvoiceLineItem[]	Yes
body	`due_date`	string	No
body	`notes`	string	No
body	`terms`	string	No
body	`reference_id`	string	No
body	`metadata`	Record<string, any>	No

Example Request

curl -X GET "https://api.soledgic.com/v1/invoices?status=value&customer_id=customer_id_123&limit=value&offset=value" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Budgets & Recurring

Endpoint	Methods	Auth	Status	Details
Manage Budgets `/v1/manage-budgets`	GETPOST	API key	Public	View details
Manage Contractors `/v1/manage-contractors`	GETPOST	API key	Public	View details
Manage Recurring `/v1/manage-recurring`	GETPOST	API key	Public	View details

Manage Budgets

/v1/manage-budgets

GETPOSTAPI key

Manage Budgets

Gateway path

https://api.soledgic.com/v1/manage-budgets

Supabase function

/functions/v1/manage-budgets

Source

supabase/functions/manage-budgets/index.ts

Parameters

Location	Name	Type	Required
body	`name`	string	Yes
body	`category_code`	string	No
body	`budget_amount`	number	Yes
body	`budget_period`	'weekly' \| 'monthly' \| 'quarterly' \| 'annual'	Yes
body	`alert_at_percentage`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-budgets" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Manage Contractors

/v1/manage-contractors

GETPOSTAPI key

Manage Contractors

Gateway path

https://api.soledgic.com/v1/manage-contractors

Supabase function

/functions/v1/manage-contractors

Source

supabase/functions/manage-contractors/index.ts

Parameters

Location	Name	Type	Required
body	`contractor_id`	string	Yes
body	`amount`	number	Yes
body	`payment_date`	string	Yes
body	`payment_method`	string	No
body	`payment_reference`	string	No
body	`description`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-contractors" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Manage Recurring

/v1/manage-recurring

GETPOSTAPI key

Manage Recurring Expenses

Gateway path

https://api.soledgic.com/v1/manage-recurring

Supabase function

/functions/v1/manage-recurring

Source

supabase/functions/manage-recurring/index.ts

Parameters

Location	Name	Type	Required
query	`days`	string	No
body	`name`	string	Yes
body	`merchant_name`	string	Yes
body	`category_code`	string	Yes
body	`amount`	number	Yes
body	`recurrence_interval`	'weekly' \| 'monthly' \| 'quarterly' \| 'annual'	Yes
body	`recurrence_day`	number	No
body	`start_date`	string	Yes
body	`end_date`	string	No
body	`business_purpose`	string	Yes
body	`is_variable_amount`	boolean	No

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-recurring?days=value" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Webhooks

Endpoint	Methods	Auth	Status	Details
Configure Alerts `/v1/configure-alerts`	POST	API key	Public	View details
Webhooks `/v1/webhooks`	POST	API key	Public	View details

Configure Alerts

/v1/configure-alerts

POSTAPI key

Configure Alerts

Gateway path

https://api.soledgic.com/v1/configure-alerts

Supabase function

/functions/v1/configure-alerts

Source

supabase/functions/configure-alerts/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'list' \| 'create' \| 'update' \| 'delete' \| 'test'	Yes
body	`config_id`	string	No
body	`alert_type`	'breach_risk' \| 'projection_created' \| 'instrument_invalidated'	No
body	`channel`	'slack' \| 'email' \| 'webhook'	No
body	`config`	{	No
body	`webhook_url`	string	No
body	`channel`	string	No
body	`recipients`	string[]	No
body	`thresholds`	{	No
body	`coverage_ratio_below`	number	No
body	`shortfall_above`	number	No
body	`is_active`	boolean	No
body	`limit`	number	No

Example Request

curl -X POST "https://api.soledgic.com/v1/configure-alerts" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "list",
  "config_id": "config_id_123",
  "alert_type": "breach_risk",
  "channel": "value",
  "config": {},
  "webhook_url": "value",
  "recipients": [
    "item_1"
  ]
}'

Webhooks

/v1/webhooks

POSTAPI key

Webhooks Management

Gateway path

https://api.soledgic.com/v1/webhooks

Supabase function

/functions/v1/webhooks

Source

supabase/functions/webhooks/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'list' \| 'create' \| 'update' \| 'delete' \| 'test' \| 'deliveries' \| 'retry' \| '...	Yes
body	`endpoint_id`	string	No
body	`delivery_id`	string	No
body	`url`	string	No
body	`description`	string	No
body	`events`	string[]	No
body	`is_active`	boolean	No

Example Request

curl -X POST "https://api.soledgic.com/v1/webhooks" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "list",
  "endpoint_id": "endpoint_id_123",
  "delivery_id": "delivery_id_123",
  "url": "value",
  "description": "value",
  "events": [
    "item_1"
  ],
  "is_active": true
}'

Tax

Endpoint	Methods	Auth	Status	Details
Tax Calculation `/v1/tax/calculations/{participant_id}`	GET	API key	Public	View details
Tax Document Detail `/v1/tax/documents/{document_id}`	GET	API key	Public	View details
Mark Tax Document Filed `/v1/tax/documents/{document_id}/mark-filed`	POST	API key	Public	View details
Export Tax Documents `/v1/tax/documents/export`	GET	API key	Public	View details
Generate Tax Documents `/v1/tax/documents/generate`	POST	API key	Public	View details
Tax Documents `/v1/tax/documents`	GET	API key	Public	View details
Tax Summary `/v1/tax/summaries/{tax_year}`	GET	API key	Public	View details
Submit Tax Info `/v1/submit-tax-info`	POST	Public/JWT	Deprecated	View details

Tax Calculation

/v1/tax/calculations/{participant_id}

GETAPI key

Calculate participant-level tax totals and shared tax profile status for a year.

Gateway path

https://api.soledgic.com/v1/tax/calculations/{participant_id}

Supabase function

/functions/v1/tax-calculation

Source

supabase/functions/tax/index.ts

Parameters

Location	Name	Type	Required
path	`participant_id`	string	Yes
query	`tax_year`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/tax/calculations/participant_id_123?tax_year=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Tax Document Detail

/v1/tax/documents/{document_id}

GETAPI key

Fetch a single generated tax document.

Gateway path

https://api.soledgic.com/v1/tax/documents/{document_id}

Supabase function

/functions/v1/tax-document-detail

Source

supabase/functions/tax/index.ts

Parameters

Location	Name	Type	Required
path	`document_id`	string	Yes

Example Request

curl -X GET "https://api.soledgic.com/v1/tax/documents/document_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Mark Tax Document Filed

/v1/tax/documents/{document_id}/mark-filed

POSTAPI key

Mark a generated tax document as filed.

Gateway path

https://api.soledgic.com/v1/tax/documents/{document_id}/mark-filed

Supabase function

/functions/v1/tax-document-mark-filed

Source

supabase/functions/tax/index.ts

Parameters

Location	Name	Type	Required
path	`document_id`	string	Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/tax/documents/document_id_123/mark-filed" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Export Tax Documents

/v1/tax/documents/export

GETAPI key

Export generated tax documents as CSV or JSON.

Gateway path

https://api.soledgic.com/v1/tax/documents/export

Supabase function

/functions/v1/tax-documents-export

Source

supabase/functions/tax/index.ts

Parameters

Location	Name	Type	Required
query	`tax_year`	number	No
query	`format`	'csv' \| 'json'	No

Example Request

curl -X GET "https://api.soledgic.com/v1/tax/documents/export?tax_year=1000&format=csv" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Generate Tax Documents

/v1/tax/documents/generate

POSTAPI key

Generate tax documents for all participants that cross the filing threshold.

Gateway path

https://api.soledgic.com/v1/tax/documents/generate

Supabase function

/functions/v1/tax-documents-generate

Source

supabase/functions/tax/index.ts

Parameters

Location	Name	Type	Required
body	`tax_year`	number	No

Example Request

curl -X POST "https://api.soledgic.com/v1/tax/documents/generate" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "tax_year": 1000
}'

Tax Documents

/v1/tax/documents

GETAPI key

List generated tax documents for a tax year.

Gateway path

https://api.soledgic.com/v1/tax/documents

Supabase function

/functions/v1/tax-documents-v2

Source

supabase/functions/tax/index.ts

Parameters

Location	Name	Type	Required
query	`tax_year`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/tax/documents?tax_year=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Tax Summary

/v1/tax/summaries/{tax_year}

GETAPI key

Generate and return tax summary totals for one year, optionally filtered to a participant.

Gateway path

https://api.soledgic.com/v1/tax/summaries/{tax_year}

Supabase function

/functions/v1/tax-summary

Source

supabase/functions/tax/index.ts

Parameters

Location	Name	Type	Required
path	`tax_year`	number	Yes
query	`participant_id`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/tax/summaries/1000?participant_id=participant_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Submit Tax Info

/v1/submit-tax-info

POSTPublic/JWTDeprecated

Submit Tax Info

Gateway path

https://api.soledgic.com/v1/submit-tax-info

Supabase function

/functions/v1/submit-tax-info

Source

supabase/functions/submit-tax-info/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/submit-tax-info" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Reconciliation

Endpoint	Methods	Auth	Status	Details
Import Bank Statement `/v1/import-bank-statement`	POST	API key	Public	View details
Manage Bank Accounts `/v1/manage-bank-accounts`	GETPOST	API key	Public	View details
Auto Match Settlement Transaction `/v1/reconciliations/auto-match`	POST	API key	Public	View details
Create Reconciliation Match `/v1/reconciliations/matches`	POST	API key	Public	View details
Delete Reconciliation Match `/v1/reconciliations/matches/{transaction_id}`	DELETE	API key	Public	View details
Create Reconciliation Snapshot `/v1/reconciliations/snapshots`	POST	API key	Public	View details
Reconciliation Snapshot Detail `/v1/reconciliations/snapshots/{period_id}`	GET	API key	Public	View details
Reconciliations Unmatched `/v1/reconciliations/unmatched`	GET	API key	Public	View details
Reconcile `/v1/reconcile`	POST	API key	Deprecated	View details

Import Bank Statement

/v1/import-bank-statement

POSTAPI key

Import Bank Statement

Gateway path

https://api.soledgic.com/v1/import-bank-statement

Supabase function

/functions/v1/import-bank-statement

Source

supabase/functions/import-bank-statement/index.ts

Parameters

Location	Name	Type	Required
body	`bank_account_id`	string	Yes
body	`lines`	BankStatementLine[]	Yes
body	`auto_match`	boolean	No

Example Request

curl -X POST "https://api.soledgic.com/v1/import-bank-statement" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bank_account_id": "bank_account_id_123",
  "lines": [
    "item_1"
  ],
  "auto_match": true
}'

Manage Bank Accounts

/v1/manage-bank-accounts

GETPOSTAPI key

Manage Bank Accounts

Gateway path

https://api.soledgic.com/v1/manage-bank-accounts

Supabase function

/functions/v1/manage-bank-accounts

Source

supabase/functions/manage-bank-accounts/index.ts

Parameters

Location	Name	Type	Required
body	`bank_name`	string	Yes
body	`account_name`	string	Yes
body	`account_type`	'checking' \| 'savings' \| 'credit_card' \| 'other'	Yes
body	`account_last_four`	string	No

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-bank-accounts" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Auto Match Settlement Transaction

/v1/reconciliations/auto-match

POSTAPI key

Attempt to automatically match a bank aggregator transaction to a ledger transaction.

Gateway path

https://api.soledgic.com/v1/reconciliations/auto-match

Supabase function

/functions/v1/reconciliations-auto-match

Source

supabase/functions/reconciliations/index.ts

Parameters

Location	Name	Type	Required
body	`bank_aggregator_transaction_id`	string	Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/reconciliations/auto-match" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bank_aggregator_transaction_id": "bank_aggregator_transaction_id_123"
}'

Create Reconciliation Match

/v1/reconciliations/matches

POSTAPI key

Match a ledger transaction to an external bank or settlement transaction.

Gateway path

https://api.soledgic.com/v1/reconciliations/matches

Supabase function

/functions/v1/reconciliations-match-create

Source

supabase/functions/reconciliations/index.ts

Parameters

Location	Name	Type	Required
body	`transaction_id`	string	Yes
body	`bank_transaction_id`	string	Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/reconciliations/matches" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "transaction_id": "transaction_id_123",
  "bank_transaction_id": "bank_transaction_id_123"
}'

Delete Reconciliation Match

/v1/reconciliations/matches/{transaction_id}

DELETEAPI key

Remove an existing reconciliation match for a transaction.

Gateway path

https://api.soledgic.com/v1/reconciliations/matches/{transaction_id}

Supabase function

/functions/v1/reconciliations-match-delete

Source

supabase/functions/reconciliations/index.ts

Parameters

Location	Name	Type	Required
path	`transaction_id`	string	Yes

Example Request

curl -X DELETE "https://api.soledgic.com/v1/reconciliations/matches/transaction_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Create Reconciliation Snapshot

/v1/reconciliations/snapshots

POSTAPI key

Create a reconciliation snapshot for an accounting period or as-of date.

Gateway path

https://api.soledgic.com/v1/reconciliations/snapshots

Supabase function

/functions/v1/reconciliations-snapshot-create

Source

supabase/functions/reconciliations/index.ts

Parameters

Location	Name	Type	Required
body	`period_id`	string	No
body	`as_of_date`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/reconciliations/snapshots" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "period_id": "period_id_123",
  "as_of_date": "2026-01-01"
}'

Reconciliation Snapshot Detail

/v1/reconciliations/snapshots/{period_id}

GETAPI key

Fetch the latest reconciliation snapshot for a period and verify its integrity hash.

Gateway path

https://api.soledgic.com/v1/reconciliations/snapshots/{period_id}

Supabase function

/functions/v1/reconciliations-snapshot-detail

Source

supabase/functions/reconciliations/index.ts

Parameters

Location	Name	Type	Required
path	`period_id`	string	Yes

Example Request

curl -X GET "https://api.soledgic.com/v1/reconciliations/snapshots/period_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Reconciliations Unmatched

/v1/reconciliations/unmatched

GETAPI key

List unmatched ledger transactions that still need settlement or bank reconciliation.

Gateway path

https://api.soledgic.com/v1/reconciliations/unmatched

Supabase function

/functions/v1/reconciliations-unmatched

Source

supabase/functions/reconciliations/index.ts

Parameters

Location	Name	Type	Required
query	`limit`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/reconciliations/unmatched?limit=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Reconcile

/v1/reconcile

POSTAPI keyDeprecated

Reconciliation

Gateway path

https://api.soledgic.com/v1/reconcile

Supabase function

/functions/v1/reconcile

Source

supabase/functions/reconcile/index.ts

Parameters

Location	Name	Type	Required
body	`action`	Action	Yes
body	`transaction_id`	string	No
body	`bank_transaction_id`	string	No
body	`period_id`	string	No
body	`as_of_date`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/reconcile" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "value",
  "transaction_id": "transaction_id_123",
  "bank_transaction_id": "bank_transaction_id_123",
  "period_id": "period_id_123",
  "as_of_date": "2026-01-01"
}'

Risk & Security

Endpoint	Methods	Auth	Status	Details
Compliance Access Patterns `/v1/compliance/access-patterns`	GET	API key	Public	View details
Compliance Financial Activity `/v1/compliance/financial-activity`	GET	API key	Public	View details
Compliance Overview `/v1/compliance/overview`	GET	API key	Public	View details
Compliance Security Summary `/v1/compliance/security-summary`	GET	API key	Public	View details
Fraud Evaluation Detail `/v1/fraud/evaluations/{evaluation_id}`	GET	API key	Public	View details
Fraud Evaluations `/v1/fraud/evaluations`	POST	API key	Public	View details
Fraud Policies `/v1/fraud/policies`	GETPOST	API key	Public	View details
Delete Fraud Policy `/v1/fraud/policies/{policy_id}`	DELETE	API key	Public	View details
Security Alerts `/v1/security-alerts`	POST	Public/JWT	Internal	View details
Send Breach Alert `/v1/send-breach-alert`	POST	API key	Internal	View details
Configure Risk Policy `/v1/configure-risk-policy`	POST	API key	Deprecated	View details
Risk Evaluation `/v1/risk-evaluation`	POST	API key	Deprecated	View details

Compliance Access Patterns

/v1/compliance/access-patterns

GETAPI key

List suspicious or high-volume access patterns for the current ledger.

Gateway path

https://api.soledgic.com/v1/compliance/access-patterns

Supabase function

/functions/v1/compliance-access-patterns

Source

supabase/functions/compliance/index.ts

Parameters

Location	Name	Type	Required
query	`hours`	number	No
query	`limit`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/compliance/access-patterns?hours=1000&limit=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Compliance Financial Activity

/v1/compliance/financial-activity

GETAPI key

Summarize payout, sale, refund, and dispute activity for compliance review.

Gateway path

https://api.soledgic.com/v1/compliance/financial-activity

Supabase function

/functions/v1/compliance-financial-activity

Source

supabase/functions/compliance/index.ts

Parameters

Location	Name	Type	Required
query	`days`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/compliance/financial-activity?days=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Compliance Overview

/v1/compliance/overview

GETAPI key

Get a ledger-scoped overview of compliance and monitoring signals.

Gateway path

https://api.soledgic.com/v1/compliance/overview

Supabase function

/functions/v1/compliance-overview

Source

supabase/functions/compliance/index.ts

Parameters

Location	Name	Type	Required
query	`days`	number	No
query	`hours`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/compliance/overview?days=1000&hours=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Compliance Security Summary

/v1/compliance/security-summary

GETAPI key

Summarize risk-scored security and audit events for the current ledger.

Gateway path

https://api.soledgic.com/v1/compliance/security-summary

Supabase function

/functions/v1/compliance-security-summary

Source

supabase/functions/compliance/index.ts

Parameters

Location	Name	Type	Required
query	`days`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/compliance/security-summary?days=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Fraud Evaluation Detail

/v1/fraud/evaluations/{evaluation_id}

GETAPI key

Get a previously created fraud evaluation.

Gateway path

https://api.soledgic.com/v1/fraud/evaluations/{evaluation_id}

Supabase function

/functions/v1/fraud-evaluation-detail

Source

supabase/functions/fraud/index.ts

Parameters

Location	Name	Type	Required
path	`evaluation_id`	string	Yes

Example Request

curl -X GET "https://api.soledgic.com/v1/fraud/evaluations/evaluation_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Fraud Evaluations

/v1/fraud/evaluations

POSTAPI key

Evaluate a proposed transaction against configured fraud and policy rules.

Gateway path

https://api.soledgic.com/v1/fraud/evaluations

Supabase function

/functions/v1/fraud-evaluations

Source

supabase/functions/fraud/index.ts

Parameters

Location	Name	Type	Required
body	`idempotency_key`	string	Yes
body	`amount`	number	Yes
body	`currency`	string	No
body	`counterparty_name`	string	No
body	`authorizing_instrument_id`	string	No
body	`expected_date`	string	No
body	`category`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/fraud/evaluations" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "idempotency_key": "idempotency_key_123",
  "amount": 1000,
  "currency": "value",
  "counterparty_name": "value",
  "authorizing_instrument_id": "authorizing_instrument_id_123",
  "expected_date": "2026-01-01",
  "category": "value"
}'

Fraud Policies

/v1/fraud/policies

GETPOSTAPI key

List configured fraud policies or create a new policy rule.

Gateway path

https://api.soledgic.com/v1/fraud/policies

Supabase function

/functions/v1/fraud-policies

Source

supabase/functions/fraud/index.ts

Parameters

Location	Name	Type	Required
body	`policy_type`	'require_instrument' \| 'budget_cap' \| 'projection_guard'	No
body	`config`	Record<string, unknown>	No
body	`severity`	'hard' \| 'soft'	No
body	`priority`	number	No

Example Request

curl -X GET "https://api.soledgic.com/v1/fraud/policies" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Delete Fraud Policy

/v1/fraud/policies/{policy_id}

DELETEAPI key

Delete a configured fraud policy.

Gateway path

https://api.soledgic.com/v1/fraud/policies/{policy_id}

Supabase function

/functions/v1/fraud-policy-delete

Source

supabase/functions/fraud/index.ts

Parameters

Location	Name	Type	Required
path	`policy_id`	string	Yes

Example Request

curl -X DELETE "https://api.soledgic.com/v1/fraud/policies/policy_id_123" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Security Alerts

/v1/security-alerts

POSTPublic/JWTInternal

Security Alerts

Gateway path

https://api.soledgic.com/v1/security-alerts

Supabase function

/functions/v1/security-alerts

Source

supabase/functions/security-alerts/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/security-alerts" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Send Breach Alert

/v1/send-breach-alert

POSTAPI keyInternal

Send Breach Alert

Gateway path

https://api.soledgic.com/v1/send-breach-alert

Supabase function

/functions/v1/send-breach-alert

Source

supabase/functions/send-breach-alert/index.ts

Parameters

Location	Name	Type	Required
body	`cash_balance`	number	Yes
body	`pending_total`	number	Yes
body	`shortfall`	number	Yes
body	`coverage_ratio`	number	Yes
body	`triggered_by`	'project_intent' \| 'get_runway' \| 'manual'	Yes
body	`instrument_id`	string	No
body	`external_ref`	string	No
body	`projections_created`	number	No
body	`channel`	'slack' \| 'email' \| 'webhook'	No

Example Request

curl -X POST "https://api.soledgic.com/v1/send-breach-alert" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cash_balance": 1000,
  "pending_total": 1000,
  "shortfall": 1000,
  "coverage_ratio": 1000,
  "triggered_by": "project_intent",
  "instrument_id": "instrument_id_123",
  "external_ref": "value",
  "projections_created": 1000
}'

Configure Risk Policy

/v1/configure-risk-policy

POSTAPI keyDeprecated

Configure Risk Policy

Gateway path

https://api.soledgic.com/v1/configure-risk-policy

Supabase function

/functions/v1/configure-risk-policy

Source

supabase/functions/configure-risk-policy/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'create' \| 'list' \| 'delete'	Yes
body	`policy_type`	'require_instrument' \| 'budget_cap' \| 'projection_guard'	No
body	`config`	Record<string, any>	No
body	`severity`	'hard' \| 'soft'	No
body	`priority`	number	No
body	`policy_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/configure-risk-policy" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "create",
  "policy_type": "require_instrument",
  "config": {},
  "severity": "hard",
  "priority": 1000,
  "policy_id": "policy_id_123"
}'

Risk Evaluation

/v1/risk-evaluation

POSTAPI keyDeprecated

Risk Evaluation

Gateway path

https://api.soledgic.com/v1/risk-evaluation

Supabase function

/functions/v1/risk-evaluation

Source

supabase/functions/risk-evaluation/index.ts

Parameters

Location	Name	Type	Required
body	`idempotency_key`	string	Yes
body	`amount`	number	Yes
body	`currency`	string	No
body	`counterparty_name`	string	No
body	`authorizing_instrument_id`	string	No
body	`expected_date`	string	No
body	`category`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/risk-evaluation" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "idempotency_key": "idempotency_key_123",
  "amount": 1000,
  "currency": "value",
  "counterparty_name": "value",
  "authorizing_instrument_id": "authorizing_instrument_id_123",
  "expected_date": "2026-01-01",
  "category": "value"
}'

Billing

Endpoint	Methods	Auth	Status	Details
Billing `/v1/billing`	POST	Public/JWT	Public	View details
Project Intent `/v1/project-intent`	POST	API key	Public	View details

Billing

/v1/billing

POSTPublic/JWT

Usage-based billing summary (overages). Subscription actions are disabled.

Gateway path

https://api.soledgic.com/v1/billing

Supabase function

/functions/v1/billing

Source

supabase/functions/billing/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'get_subscription' \| 'get_usage' \| 'get_plans' \| 'get_invoices' \| 'get_payment_methods'	Yes
body	`organization_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/billing" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "get_subscription",
  "organization_id": "organization_id_123"
}'

Project Intent

/v1/project-intent

POSTAPI key

Project Intent

Gateway path

https://api.soledgic.com/v1/project-intent

Supabase function

/functions/v1/project-intent

Source

supabase/functions/project-intent/index.ts

Parameters

Location	Name	Type	Required
body	`authorizing_instrument_id`	string	Yes
body	`until_date`	string	Yes
body	`horizon_count`	number	No

Example Request

curl -X POST "https://api.soledgic.com/v1/project-intent" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "authorizing_instrument_id": "authorizing_instrument_id_123",
  "until_date": "2026-01-01",
  "horizon_count": 1000
}'

Health

Endpoint	Methods	Auth	Status	Details
Health Check `/v1/health-check`	POST	Public/JWT	Internal	View details

Health Check

/v1/health-check

POSTPublic/JWTInternal

Health Check

Gateway path

https://api.soledgic.com/v1/health-check

Supabase function

/functions/v1/health-check

Source

supabase/functions/health-check/index.ts

Parameters

Location	Name	Type	Required
body	`action`	'run' \| 'status' \| 'history' \| 'run_all'	Yes
body	`ledger_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/health-check" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "run",
  "ledger_id": "ledger_id_123"
}'

Internal

Endpoint	Methods	Auth	Status	Details
Bill Overages `/v1/bill-overages`	POST	Custom/internal	Internal	View details
Ops Monitor `/v1/ops-monitor`	POST	Custom/internal	Internal	View details
Process Processor Inbox `/v1/process-processor-inbox`	POST	Custom/internal	Internal	View details
Process Webhooks `/v1/process-webhooks`	POST	Custom/internal	Internal	View details
Reconcile Checkout Ledger `/v1/reconcile-checkout-ledger`	POST	Custom/internal	Internal	View details
Test Cleanup `/v1/test-cleanup`	POST	API key	Internal	View details
Upload Receipt `/v1/upload-receipt`	POST	API key	Public	View details

Bill Overages

/v1/bill-overages

POSTCustom/internalInternal

Calculate and record usage-based billing overages

Gateway path

https://api.soledgic.com/v1/bill-overages

Supabase function

/functions/v1/bill-overages

Source

supabase/functions/bill-overages/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/bill-overages" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Ops Monitor

/v1/ops-monitor

POSTCustom/internalInternal

Production observability: monitors payment pipeline health

Gateway path

https://api.soledgic.com/v1/ops-monitor

Supabase function

/functions/v1/ops-monitor

Source

supabase/functions/ops-monitor/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/ops-monitor" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Process Processor Inbox

/v1/process-processor-inbox

POSTCustom/internalInternal

Process pending processor webhook inbox events

Gateway path

https://api.soledgic.com/v1/process-processor-inbox

Supabase function

/functions/v1/process-processor-inbox

Source

supabase/functions/process-processor-inbox/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/process-processor-inbox" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Process Webhooks

/v1/process-webhooks

POSTCustom/internalInternal

Process Webhooks

Gateway path

https://api.soledgic.com/v1/process-webhooks

Supabase function

/functions/v1/process-webhooks

Source

supabase/functions/process-webhooks/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/process-webhooks" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Reconcile Checkout Ledger

/v1/reconcile-checkout-ledger

POSTCustom/internalInternal

Retry charged-but-unrecorded checkout sessions (charged_pending_ledger → sale)

Gateway path

https://api.soledgic.com/v1/reconcile-checkout-ledger

Supabase function

/functions/v1/reconcile-checkout-ledger

Source

supabase/functions/reconcile-checkout-ledger/index.ts

Parameters

Location	Name	Type	Required
body	`limit`	number	No
body	`dry_run`	boolean	No

Example Request

curl -X POST "https://api.soledgic.com/v1/reconcile-checkout-ledger" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 1000,
  "dry_run": true
}'

Test Cleanup

/v1/test-cleanup

POSTAPI keyInternal

Test Data Cleanup

Gateway path

https://api.soledgic.com/v1/test-cleanup

Supabase function

/functions/v1/test-cleanup

Source

supabase/functions/test-cleanup/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/test-cleanup" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'

Upload Receipt

/v1/upload-receipt

POSTAPI key

Upload Receipt

Gateway path

https://api.soledgic.com/v1/upload-receipt

Supabase function

/functions/v1/upload-receipt

Source

supabase/functions/upload-receipt/index.ts

Parameters

Location	Name	Type	Required
body	`file_url`	string	Yes
body	`file_name`	string	No
body	`file_size`	number	No
body	`mime_type`	string	No
body	`merchant_name`	string	No
body	`transaction_date`	string	No
body	`total_amount`	number	No
body	`transaction_id`	string	No

Example Request

curl -X POST "https://api.soledgic.com/v1/upload-receipt" \
  -H "x-api-key: slk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "file_url": "value",
  "file_name": "value",
  "file_size": 1000,
  "mime_type": "value",
  "merchant_name": "value",
  "transaction_date": "2026-01-01",
  "total_amount": 1000,
  "transaction_id": "transaction_id_123"
}'

Other

Endpoint	Methods	Auth	Status	Details
Wallets `/v1/wallets`	GETPOST	API key	Public	View details

Wallets

/v1/wallets

GETPOSTAPI key

List scoped wallets or create a consumer credit wallet.

Gateway path

https://api.soledgic.com/v1/wallets

Supabase function

/functions/v1/wallets

Source

supabase/functions/wallets/index.ts

Parameters

Location	Name	Type	Required
query	`owner_id`	string	No
query	`owner_type`	string	No
query	`wallet_type`	'consumer_credit' \| 'creator_earnings'	No
query	`limit`	number	No
query	`offset`	number	No
body	`owner_id`	string	No
body	`participant_id`	string	No
body	`owner_type`	string	No
body	`wallet_type`	'consumer_credit' \| 'creator_earnings'	Yes
body	`name`	string	No
body	`metadata`	Record<string, unknown>	No

Example Request

curl -X GET "https://api.soledgic.com/v1/wallets?owner_id=owner_id_123&owner_type=value&wallet_type=consumer_credit&limit=1000" \
  -H "x-api-key: slk_test_YOUR_API_KEY"

Error Responses

All endpoints return a consistent error envelope.

{
  "success": false,
  "error": "Error message here",
  "request_id": "req_xxx"
}

Code	Meaning
`400`	Validation or malformed request
`401`	Missing or invalid authentication
`403`	Forbidden or account inactive
`404`	Resource not found
`409`	State conflict (duplicate or invalid transition)
`413`	Payload too large
`429`	Rate limit exceeded
`500`	Internal server error