API Reference

Release a hold when money is allowed to become available.

Call this from an approved admin or automated release process.

Confirm the hold is ready and the release policy allows it.

Required: hold_id (path)

Release status, amount, and transfer details if the release executed.

List money that is held instead of immediately available.

Call this for admin dashboards, delayed release policies, disputes, or payout review.

Optionally filter by participant id or show only holds ready for release.

Required: No required fields were inferred. Check the example body for the normal call shape.

Held-fund rows with reason, age, release readiness, and related transaction references.

Create and inspect the money-facing people and wallets inside a platform.

Use these endpoints when your app needs a buyer wallet, a creator earnings wallet, a balance, a transfer, or a held-funds view.

Know the external user or creator id from your app and whether the account is a buyer wallet or creator earnings account.

Required: No required fields were inferred. Check the example body for the normal call shape.

A Soledgic resource id, current balance information, or an activity list that your app can show back to the user.

Look up one creator or participant balance.

Call this when showing a creator balance page or checking held versus available earnings.

You need the `participant_id` you used when creating the participant.

Required: participant_id (path)

The participant balance, available amount, held amount, and active holds.

Ask whether a creator can request or receive a payout right now.

Call this before showing a payout button or explaining why payouts are blocked.

The participant must already exist and have any required identity, tax, and payout setup.

Required: participant_id (path)

An eligibility result, available balance, and a list of blocking issues if payout is not ready.

Create or list creators/sellers that can earn money in your platform.

Call this when your app adds a creator, seller, teacher, artist, or other earning participant.

Choose a stable `participant_id` from your app, such as your creator id. You can also include name, email, split percent, and payout preferences.

Required: participant_id (body)

A participant-backed account that Soledgic can use for earnings, holds, reports, and payout checks.

Create and inspect the money-facing people and wallets inside a platform.

Use these endpoints when your app needs a buyer wallet, a creator earnings wallet, a balance, a transfer, or a held-funds view.

Know the external user or creator id from your app and whether the account is a buyer wallet or creator earnings account.

Required: amount (body), reference_id (body)

A Soledgic resource id, current balance information, or an activity list that your app can show back to the user.

Create and inspect the money-facing people and wallets inside a platform.

Use these endpoints when your app needs a buyer wallet, a creator earnings wallet, a balance, a transfer, or a held-funds view.

Know the external user or creator id from your app and whether the account is a buyer wallet or creator earnings account.

Required: wallet_id (path), amount (body), reference_id (body)

A Soledgic resource id, current balance information, or an activity list that your app can show back to the user.

Get one wallet and its current balance.

Call this for wallet screens, balance checks, or support review.

You need the Soledgic `wallet_id`.

Required: wallet_id (path)

The wallet status, balance, available amount, held amount, and supported actions.

Show the activity feed for a wallet.

Call this for receipts, transaction history, or user wallet activity screens.

You need the `wallet_id`; use `limit` and `offset` for pagination.

Required: wallet_id (path)

Ledger entries with amounts, debit/credit direction, references, descriptions, and timestamps.

Create and inspect the money-facing people and wallets inside a platform.

Use these endpoints when your app needs a buyer wallet, a creator earnings wallet, a balance, a transfer, or a held-funds view.

Know the external user or creator id from your app and whether the account is a buyer wallet or creator earnings account.

Required: wallet_id (path), amount (body), reference_id (body)

A Soledgic resource id, current balance information, or an activity list that your app can show back to the user.

Create a purchase flow for a buyer.

Call this when a user buys a product, session, content item, membership, or order in your app.

Have the creator participant id, amount in cents, product/order ids, and either a hosted success URL or a direct payment method/source.

Required: participant_id (body), amount (body)

A checkout URL or direct payment result, plus sale references and split breakdowns.

Request a payout from available creator earnings.

Call this after payout eligibility says the creator is ready and has available balance.

Have the participant id, amount, and a stable `reference_id` for idempotency.

Required: amount (body), reference_id (body)

A payout object with gross amount, fees, net amount, transaction id, and balance movement.

Generate or fetch Soledgic-owned financial receipts.

Call this after checkout completion when your app needs a durable receipt reference.

Have the checkout id or sale transaction id plus any external order reference your app uses.

Required: No required fields were inferred. Check the example body for the normal call shape.

A receipt id and hosted URL your app can store and display.

Generate or fetch Soledgic-owned financial receipts.

Call this after checkout completion when your app needs a durable receipt reference.

Have the checkout id or sale transaction id plus any external order reference your app uses.

Required: receipt_id (path)

A receipt id and hosted URL your app can store and display.

Execute or list refunds through Soledgic.

Call this after your platform approves a refund. Buyers should start with refund requests; do not route users to request refunds through the processor directly.

Use the original `sale_reference`, the refund reason, and optionally the amount for partial refunds.

Required: original_sale_reference (body), reason (body)

A refund object, status, refund amount, and the split of funds returned from platform and creator balances.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: No required fields were inferred. Check the example body for the normal call shape.

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: action (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: amount (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: idempotency_key (body), adjustment_type (body), entries (body), reason (body), prepared_by (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: amount (body), description (body), vendor_name (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: reference_id (body), amount (body), description (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: reference_id (body), amount (body), description (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: as_of_date (body), source (body), balances (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: from_account_type (body), to_account_type (body), amount (body), transfer_type (body)

A transaction id and accounting status that can be reconciled later.

Record accounting activity that is not the standard checkout flow.

Use these endpoints for expenses, income, bills, transfers, reversals, imports, and corrections.

Use a stable reference id and only call these when your app intentionally wants a ledger record.

Required: transaction_id (body), reason (body)

A transaction id and accounting status that can be reconciled later.

Move available creator earnings out of Soledgic tracking and into the payout workflow.

Use this when a creator requests money or an approved platform process releases earnings.

Check payout eligibility first, including active access, tax profile, payout setup, and available balance.

Required: No required fields were inferred. Check the example body for the normal call shape.

A payout request or transaction status, including amounts and balance changes.

Create or finish a buyer purchase flow.

Use this when a user is buying access, content, a session, a product, or another app item.

Know the buyer, creator, amount, success URL, and a stable order id from your app.

Required: idempotency_key (body), amount (body)

A checkout URL or direct payment result plus the sale reference Soledgic will use for receipts and refunds.

Create or finish a buyer purchase flow.

Use this when a user is buying access, content, a session, a product, or another app item.

Know the buyer, creator, amount, success URL, and a stable order id from your app.

Required: amount (body)

A checkout URL or direct payment result plus the sale reference Soledgic will use for receipts and refunds.

Manage creator-facing account setup and account lifecycle.

Use these endpoints when onboarding, updating, or deactivating creator account records.

Confirm the creator belongs to your platform and that deactivation will not break open transactions.

Required: creator_id (body)

Updated creator/account status or split settings.

Manage creator-facing account setup and account lifecycle.

Use these endpoints when onboarding, updating, or deactivating creator account records.

Confirm the creator belongs to your platform and that deactivation will not break open transactions.

Required: action (body)

Updated creator/account status or split settings.

Manage creator-facing account setup and account lifecycle.

Use these endpoints when onboarding, updating, or deactivating creator account records.

Confirm the creator belongs to your platform and that deactivation will not break open transactions.

Required: external_ref (body), extracted_terms (body)

Updated creator/account status or split settings.

Manage the platform ledger and accounting periods.

Use these endpoints when setting up a platform, closing a period, or producing locked statements.

Know the ledger you are operating on and whether the action affects reporting periods.

Required: year (body)

Ledger, period, or statement information.

Manage the platform ledger and accounting periods.

Use these endpoints when setting up a platform, closing a period, or producing locked statements.

Know the ledger you are operating on and whether the action affects reporting periods.

Required: action (body)

Ledger, period, or statement information.

Manage the platform ledger and accounting periods.

Use these endpoints when setting up a platform, closing a period, or producing locked statements.

Know the ledger you are operating on and whether the action affects reporting periods.

Required: No required fields were inferred. Check the example body for the normal call shape.

Ledger, period, or statement information.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: No required fields were inferred. Check the example body for the normal call shape.

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: No required fields were inferred. Check the example body for the normal call shape.

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: No required fields were inferred. Check the example body for the normal call shape.

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: report_type (body), format (body)

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: report_type (body)

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: report_type (body)

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: No required fields were inferred. Check the example body for the normal call shape.

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: No required fields were inferred. Check the example body for the normal call shape.

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: action (body)

Report rows, totals, CSV files, PDFs, or summary metrics.

Read financial summaries that explain what happened.

Use these endpoints for dashboards, exports, statements, runway, and accounting reports.

Use a date range for large reports so exports stay small and fast.

Required: No required fields were inferred. Check the example body for the normal call shape.

Report rows, totals, CSV files, PDFs, or summary metrics.

Create and settle invoice-style receivables.

Use this when your platform needs invoice records instead of an instant checkout.

Know the customer, invoice line items, due date, and payment status.

Required: customer_name (body), line_items (body)

Invoice status and related accounting transactions.

Track planned spending, recurring work, and contractor activity.

Use these endpoints for internal platform operations that need recurring accounting records.

Know the schedule, counterparty, category, and amount.

Required: name (body), budget_amount (body), budget_period (body)

Budget, recurring, contractor, or payment records.

Track planned spending, recurring work, and contractor activity.

Use these endpoints for internal platform operations that need recurring accounting records.

Know the schedule, counterparty, category, and amount.

Required: contractor_id (body), amount (body), payment_date (body)

Budget, recurring, contractor, or payment records.

Track planned spending, recurring work, and contractor activity.

Use these endpoints for internal platform operations that need recurring accounting records.

Know the schedule, counterparty, category, and amount.

Required: name (body), merchant_name (body), category_code (body), amount (body), recurrence_interval (body), start_date (body), business_purpose (body)

Budget, recurring, contractor, or payment records.

Tell Soledgic where to send event notifications.

Use these endpoints when your app wants to receive checkout, refund, payout, or ledger lifecycle events.

Have a public HTTPS endpoint in your app and decide which events it should receive.

Required: action (body)

Webhook endpoint configuration, delivery records, test results, or secret rotation status.

Create and manage where Soledgic sends event notifications.

Call this when your app wants to be notified about checkouts, refunds, payouts, or ledger events.

Your endpoint must be HTTPS and able to verify Soledgic webhook signatures.

Required: action (body)

Webhook endpoint records, test results, delivery logs, or rotated secrets.

Prepare tax summaries and document workflows for creators and participants.

Use these endpoints when reviewing tax readiness, generating summaries, or exporting tax documents.

Have the participant id and tax year, and make sure tax profiles are collected through the supported flow.

Required: participant_id (path)

Tax calculations, summaries, document statuses, or exports.

Prepare tax summaries and document workflows for creators and participants.

Use these endpoints when reviewing tax readiness, generating summaries, or exporting tax documents.

Have the participant id and tax year, and make sure tax profiles are collected through the supported flow.

Required: document_id (path)

Tax calculations, summaries, document statuses, or exports.

Prepare tax summaries and document workflows for creators and participants.

Use these endpoints when reviewing tax readiness, generating summaries, or exporting tax documents.

Have the participant id and tax year, and make sure tax profiles are collected through the supported flow.

Required: document_id (path)

Tax calculations, summaries, document statuses, or exports.

Prepare tax summaries and document workflows for creators and participants.

Use these endpoints when reviewing tax readiness, generating summaries, or exporting tax documents.

Have the participant id and tax year, and make sure tax profiles are collected through the supported flow.

Required: No required fields were inferred. Check the example body for the normal call shape.

Tax calculations, summaries, document statuses, or exports.

Prepare tax summaries and document workflows for creators and participants.

Use these endpoints when reviewing tax readiness, generating summaries, or exporting tax documents.

Have the participant id and tax year, and make sure tax profiles are collected through the supported flow.

Required: No required fields were inferred. Check the example body for the normal call shape.

Tax calculations, summaries, document statuses, or exports.

Prepare tax summaries and document workflows for creators and participants.

Use these endpoints when reviewing tax readiness, generating summaries, or exporting tax documents.

Have the participant id and tax year, and make sure tax profiles are collected through the supported flow.

Required: No required fields were inferred. Check the example body for the normal call shape.

Tax calculations, summaries, document statuses, or exports.

Prepare tax summaries and document workflows for creators and participants.

Use these endpoints when reviewing tax readiness, generating summaries, or exporting tax documents.

Have the participant id and tax year, and make sure tax profiles are collected through the supported flow.

Required: tax_year (path)

Tax calculations, summaries, document statuses, or exports.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: bank_account_id (body), lines (body)

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: bank_name (body), account_name (body), account_type (body)

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: bank_aggregator_transaction_id (body)

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: transaction_id (body), bank_transaction_id (body)

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: transaction_id (path)

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: No required fields were inferred. Check the example body for the normal call shape.

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: period_id (path)

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Match Soledgic records to external bank or processor records.

Use these endpoints when checking whether money records line up across systems.

Import or identify the external transaction and the Soledgic transaction you want to compare.

Required: No required fields were inferred. Check the example body for the normal call shape.

Matched/unmatched status, reconciliation snapshots, or suggested matches.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: No required fields were inferred. Check the example body for the normal call shape.

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: No required fields were inferred. Check the example body for the normal call shape.

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: No required fields were inferred. Check the example body for the normal call shape.

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: No required fields were inferred. Check the example body for the normal call shape.

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: evaluation_id (path)

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: idempotency_key (body), amount (body)

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: No required fields were inferred. Check the example body for the normal call shape.

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: policy_id (path)

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: No required fields were inferred. Check the example body for the normal call shape.

Risk evaluations, policy records, compliance summaries, or alert details.

Review risky activity, fraud signals, security alerts, and compliance summaries.

Use these endpoints for operator dashboards, policy checks, or incident review.

Use admin-approved keys and keep outputs internal to platform operators.

Required: cash_balance (body), pending_total (body), shortfall (body), coverage_ratio (body), triggered_by (body)

Risk evaluations, policy records, compliance summaries, or alert details.