Skip to main content

Overview

Follow a disbursement end to end, from funding the distribution account and uploading a CSV to the receiver registering a wallet and getting paid.

Getting Started

Install the prerequisites, generate your configuration with the setup wizard, and log in to your own SDP dashboard for the first time.

Architecture

Learn how the SDP's components, databases, distribution accounts and multi-tenancy work, including how each request is matched to a tenant.

Deployment

Deploy the SDP on Kubernetes with the Stellar Helm chart or on a single machine with Docker Compose.

Configuration

Understand the configuration options available for the Stellar Disbursement Platform (SDP)

Advanced Configuration

Understand how to configure the SDP for various scenarios. This includes multi-tenancy, testnet vs. mainnet, etc.

CLI Manual

Guide to using the Stellar Disbursement Platform CLI

Embedded Wallets

Learn how to use Embedded Wallets to enable receivers without existing Stellar wallets to receive disbursements using passkey authentication.

Security

Learn how the SDP protects sign-in and limits requests, how roles, account access and API key permissions work, and how to manage hot and cold wallets.

Monitoring

How the SDP exposes runtime metrics and logs, and how to wire them into Prometheus and Grafana

Making Your Wallet SDP-Ready

Integrate your wallet with the SDP, from being added to an SDP instance to handling registration links and completing receiver sign-up.

Troubleshooting

Find the likely cause and fix for stuck or failed payments, missing invitations and OTPs, locked-out receivers, and channel account problems.

User Interface

Dashboard Home

Navigate the dashboard's tabs, and add, share and archive distribution accounts as an Owner.

Disbursements

Find, filter and export disbursements, open drafts, start a new disbursement, and read each disbursement's payment counts and amounts.

Receivers

Find receivers by phone number or email, filter and export the list, and check how many of their payments succeeded.

Payments

Search, filter and export payments, send direct payments, and learn when a payment can be paused, retried or canceled.

Distribution Accounts

View an account's public key, balances and history, manage its trustlines, set up Bridge funding and add funds to it.

Analytics

See payment success rates, payment counts by status, balances, amounts disbursed and recipient totals for the selected distribution accounts.

Reports

Turn on the Reports feature, check which roles can use it, and choose the account, period or payment each report covers.

Account Picker

Learn when the picker lets you switch accounts, what the All accounts view shows, and which actions need a single account selected.

Circle Configuration

Enter your Circle API key and wallet ID, and learn how the SDP stores and uses them.