The Privata Partner Dashboard (Documentation Index
Fetch the complete documentation index at: https://docs.privataswap.com/llms.txt
Use this file to discover all available pages before exploring further.
dashboard.privataswap.com) is the control plane for your integration. Use it to issue API keys, configure webhooks, monitor live orders, track earnings, and manage your team - all without contacting Privata support for routine operations.
Sign up and complete onboarding
Register, verify your email, and finish the KYB-lite onboarding to receive your first API keys.
Create API keys
Issue scoped live and test keys, configure IP allowlists, and rotate without downtime.
Configure webhooks
Register your HTTPS endpoint, rotate secrets, and inspect delivery logs.
Monitor orders
Search, filter, inspect event timelines, and trigger refund actions.
Set up alerts
Configure email and in-app notifications for operational events.
Manage payouts
Add verified payout addresses and request revenue withdrawals.
1. Sign up and complete onboarding
Create an account
Go to dashboard.privataswap.com/signup. Enter your business email and choose a password (minimum 12 characters).A 6-digit verification code is sent to your email. Enter it to confirm your address. The code is valid for 10 minutes.
Complete KYB-lite
Before your live API key is issued, you must complete a four-step onboarding form:
- Company - Legal name, registered country, business type, website.
- Volume - Expected monthly order count and primary integration method.
- Jurisdictions - Countries where your end-users are located, plus AML compliance acknowledgement.
- Technical contact - Name, email, and optional Telegram handle for ops notifications.
Receive your test key
After completing onboarding, a See the Sandbox guide for available test scenarios.
pk_test_... key is displayed once. Copy it immediately - it will not be shown again. Your live key is issued from API Keys → Create key once your account is reviewed.Use the test key with sandbox scenarios to validate your integration before going live:2. Create and manage API keys
Key types
| Prefix | Environment | Counts toward payouts |
|---|---|---|
pk_test_... | Sandbox | No |
pk_live_... | Production | Yes |
/currencies, /pairs, /estimate, /limits) work without a key at 60 req/min per IP. With a key: 600 req/min. Write endpoints require a key. See Authentication for full scope and rate-limit details.
Creating a key
Configure the key
- Name - Internal label (e.g., “Production mobile app”).
- Environment - Live or Test.
- Scopes - Select only the scopes your integration requires:
| Scope | What it allows |
|---|---|
orders:rw | All /order/* endpoints (default) |
webhook:admin | Resume a paused webhook; configure webhook URLs |
payouts:read | /me and payout history |
payouts:trigger | On-demand payout request (minimum $500) |
- IP allowlist - Optional. Enter CIDR blocks to restrict the key to specific server IPs (e.g.,
203.0.113.0/24). Leave empty to allow all IPs. - Expiry - Optional. The key auto-revokes at midnight UTC on the selected date.
Rotating a key without downtime
Key rotation uses a 5-minute dual-sign grace window: both the old and new key are accepted by the API during this period.Start rotation
On the key’s detail page, click Rotate. A new key is generated and displayed once - copy it immediately.
Deploy the new key
Update your environment variable or secrets manager with the new key value and deploy. You have 5 minutes before the old key is revoked.
3. Configure webhooks
Privata sends signed HTTP POST requests to your registered endpoint on every order status change and on operational events. See the Webhooks guide for full signature verification, retry schedule, and event payload documentation.Adding an endpoint
Enter the URL
Provide your HTTPS endpoint URL. Requirements:
- Must use HTTPS (HTTP only permitted for
localhostwith apk_test_key). - Must be publicly reachable (private IP ranges are blocked as an SSRF guard).
- Must return a 2xx response within 5 seconds per delivery.
Select endpoint type
- Order events - Receives
order.*lifecycle events (status changes, refund_required, etc.). - Ops events - Receives
webhook_paused,api_key_locked,sla_breach_threshold, and similar operational alerts.
Rotating the webhook secret
Navigate to Webhooks → [endpoint] → Secret → Rotate. A 5-minute dual-sign window activates: both old and new secrets are valid. Deploy your updated secret value within this window.Inspecting delivery logs
Navigate to Webhooks → [endpoint] → Deliveries to view all delivery attempts with HTTP status codes, response bodies, and retry timestamps. From a delivery detail page you can:- Retry - Re-enqueue the delivery for immediate re-attempt (new delivery record, new signature).
- Replay - Re-send the exact original payload with the current secret (use this to re-trigger processing of a specific event).
Resuming a paused endpoint
After 50 delivery failures within 6 hours, your endpoint is auto-paused. You receive awebhook_paused ops event. To resume:
Option 1 - Dashboard: Navigate to Webhooks and click Resume on the paused endpoint.
Option 2 - API: Call POST /partner/v1/webhook/resume with an API key that has webhook:admin scope:
4. Monitor orders
Searching orders
Navigate to Orders to access the order table. Available filters:| Filter | Type |
|---|---|
| Order ID | Exact (prv-... prefix) |
| Partner order ref | Exact (your internal ID) |
| Status | Multi-select |
| Trading pair | Token picker |
| Provider | Multi-select |
| Date range | Date picker |
| Amount (USD) | Numeric range |
Order detail
Click any order to open its detail page.- Summary
- Event timeline
- Transactions
- Webhook deliveries
Displays pair, provider, markup applied (bps), current status badge, and all amounts:
amount_from- What the user sent.amount_to_expected- Rate at order creation.amount_to_actual- Final delivered amount (available oncompletedorders). If actual differs from expected by more than 0.5%, a slippage delta is shown.
Triggering a refund action
When an order reachesrefund_required status and the provider supports programmatic refunds (refund_capability: programmatic), a Refund action panel appears on the order detail page.
Check the window
A countdown timer shows the remaining
refund_window_hours. After this window, the order auto-applies your refund_preference.default (set at order creation).Choose an action
- Refund to address - Returns funds to the
refund_addressprovided at order creation. - Convert to stable - Converts funds to a stablecoin before returning. Select target:
USDT-TRC20,USDT-ERC20,USDC-ERC20, orUSDC-SOL.
5. Set up alerts and notifications
Email notifications
The technical contact email (set during onboarding) receives email alerts for operational events. Navigate to Settings → Organization to update this address.| Event | Recipients | Can opt out |
|---|---|---|
| Webhook endpoint paused | Technical contact | No |
| SLA breach detected | Technical contact + Owners | No |
| API key expiring in 7 days | Key creator + Admins | No |
| API key expiring in 24 hours | Key creator + Admins | No |
| Payout sent | Finance + Owner | Yes |
| New login from unrecognized device | The affected user | No |
In-app notifications
The dashboard displays banners and toasts for the following conditions:- Webhook paused - Banner on the Webhooks page with a direct Resume button.
- SLA breach - Persistent banner on all pages linking to the SLA details page.
- API key expiry approaching - Banner on the API Keys page for keys expiring within 7 days.
- Payout confirmed - Toast notification when a payout transaction is sent.
Monitoring your SLA
Navigate to SLA to view:- Live uptime percentage for the current calendar month, measured by your registered external prober against
GET /partner/v1/health. - Compensation accrual - If uptime falls below your tier’s target, the accrued SLA credit for the month is displayed and applied automatically to your next payout.
- Incident log - All historical incidents with duration and RCA links.
| Phase | Target |
|---|---|
| Pilot (day 0 - 30) | 99.5% with tiered compensation |
| Post-pilot (day 31+) | 99.9% contractual |
| Enterprise tier | 99.9% from day 1 |
6. Manage payouts
Revenue earned through rev-share and markup is visible in the Revenue section. Payouts are processed to your registered and verified cryptocurrency address.Adding a payout address
Enter address and currency
Select the target currency (
USDT-TRC20, USDT-ERC20, USDC-ERC20, or USDC-SOL) and enter the address. The dashboard validates the address format and checksum before saving.Verify ownership
A micro-payment of 0.01 USDT is sent to the address. Confirm receipt in the dashboard within 24 hours. Unverified addresses cannot receive payouts.
Requesting a payout
Minimum payout: 50,000.Open Revenue → Request Payout
Navigate to Revenue → Request Payout. The current pending balance is displayed.
Enter amount and select address
Enter the amount or click Request full balance. Select a verified payout address.
Complete HMAC confirmation
To prevent unauthorized withdrawals, the dashboard requires you to prove control of your webhook secret:
- The dashboard displays a one-time challenge string.
- Compute
HMAC-SHA256(your_webhook_secret, challenge_string)and paste the result. - Click Confirm.
Team management
Navigate to Team to invite members and assign roles.| Role | Typical user | Key permissions |
|---|---|---|
| Owner | Company account owner | Full access, billing, delete org |
| Admin | Technical lead | All except billing and payout initiation |
| Developer | Backend engineer | API keys, webhooks, orders, SSE |
| Finance | Finance team member | Revenue view, payout addresses, payout requests, order read |
| Read-only | Auditor, external reviewer | View orders, webhook logs, SLA |
Audit log
Every action taken in the dashboard - key creation, role changes, payout requests, webhook replays - is recorded in the Audit Log with the actor’s identity, IP address, and timestamp. The log is append-only at the database level and retained for 2 years. Export as NDJSON or CSV for compliance reporting.Related guides
Authentication
API key scopes, prefixes, rotation, and lockout behavior.
Webhooks
Signature verification, retry schedule, ops events, and sandbox behavior.
Order lifecycle
All order statuses, transitions, and terminal states.
Refund flow
Programmatic vs. ticket refunds, window handling, stable conversion.
SSE streaming
Real-time order status via Server-Sent Events and reconnection with Last-Event-ID.
SLA
Uptime tiers, compensation tables, probe contract.