# Dexxify

> Crypto Infrastructure API for Africa — deposit accounts, Naira settlement, payouts, and swaps.

- [Introduction](https://docs.dexxify.com/index.md): The single API for adding crypto deposit accounts, Naira settlement, and payouts to your product.
- [Quickstart](https://docs.dexxify.com/quickstart.md): Get an API key and issue your first deposit address, in test mode.
- [Authentication](https://docs.dexxify.com/authentication.md): API keys, the dashboard session, and how Dexxify tells them apart.
- [Environments](https://docs.dexxify.com/concepts/environments.md): Live and test mode, and how a request ends up in one or the other.
- [Deposit Accounts](https://docs.dexxify.com/concepts/deposit-accounts.md): Deposit accounts, deposit identities, and how funds arrive.
- [Withdrawals](https://docs.dexxify.com/concepts/withdrawals.md): Sending stablecoins or Naira out of a deposit account.
- [Swaps](https://docs.dexxify.com/concepts/swaps.md): Converting between crypto and fiat at a locked rate.
- [Webhooks](https://docs.dexxify.com/concepts/webhooks.md): Receiving and verifying real-time event notifications.
- [Accept a deposit](https://docs.dexxify.com/guides/accept-a-deposit.md): End-to-end walkthrough of getting a customer's crypto or NGN deposit into your business.
- [Send a payout](https://docs.dexxify.com/guides/send-a-payout.md): Withdraw stablecoins to an external address, or Naira to a bank account.
- [Handle webhook events](https://docs.dexxify.com/guides/handle-webhook-events.md): Set up a receiver, verify signatures, and stay idempotent.
- [Errors](https://docs.dexxify.com/errors.md): The error response shape and status codes you'll see across the API.
- [Changelog](https://docs.dexxify.com/changelog.md): What's new in the Dexxify API.
- [Register new user](https://docs.dexxify.com/api-reference/authentication/register-new-user.md): Register a new user account with email verification
- [Verify OTP](https://docs.dexxify.com/api-reference/authentication/verify-otp.md): Verify email using one-time password sent during registration
- [Resend OTP](https://docs.dexxify.com/api-reference/authentication/resend-otp.md): Resend one-time password for email verification
- [Forgot password](https://docs.dexxify.com/api-reference/authentication/forgot-password.md): Request password reset link via email
- [Reset password](https://docs.dexxify.com/api-reference/authentication/reset-password.md): Reset password using token from forgot password email
- [Login](https://docs.dexxify.com/api-reference/authentication/login.md): Authenticate user and set refresh token cookie
- [Refresh token](https://docs.dexxify.com/api-reference/authentication/refresh-token.md): Get new access token using refresh token cookie
- [Select active business](https://docs.dexxify.com/api-reference/authentication/select-active-business.md): Activate a specific business workspace. Required after login when the user owns multiple businesses. Issues a new JWT with the selected business_id embedded.
- [Switch environment mode](https://docs.dexxify.com/api-reference/authentication/switch-environment-mode.md): Switch between live and test mode. Issues a new JWT with the updated mode claim and refreshes the cookie.
- [Logout](https://docs.dexxify.com/api-reference/authentication/logout.md): Clear authentication cookies and logout user
- [Logout all devices](https://docs.dexxify.com/api-reference/authentication/logout-all-devices.md): Revoke every active session for this account — every device, every browser, including this one.
- [List active sessions](https://docs.dexxify.com/api-reference/authentication/list-active-sessions.md): List every currently active session (login) for this account — device, IP, when it was issued, and which one is this request.
- [Revoke a single session](https://docs.dexxify.com/api-reference/authentication/revoke-a-single-session.md): Log out one specific device/session by the id returned from GET /auth/sessions, without affecting the account's other sessions.
- [Get profile](https://docs.dexxify.com/api-reference/authentication/get-profile.md): Get authenticated user profile information
- [Get all deposit accounts](https://docs.dexxify.com/api-reference/deposit-account/get-all-deposit-accounts.md): Retrieve all deposit accounts for the authenticated user with optional filtering
- [Create a new deposit account](https://docs.dexxify.com/api-reference/deposit-account/create-a-new-deposit-account.md): Create a new deposit account for the authenticated user
- [Get deposit account by ID](https://docs.dexxify.com/api-reference/deposit-account/get-deposit-account-by-id.md): Retrieve a specific deposit account by its ID
- [Get detailed deposit account info](https://docs.dexxify.com/api-reference/deposit-account/get-detailed-deposit-account-info.md): Get comprehensive deposit account details from the crypto provider
- [Get all deposit account details](https://docs.dexxify.com/api-reference/deposit-account/get-all-deposit-account-details.md): Retrieve detailed information for all deposit accounts
- [Issue a deposit identity](https://docs.dexxify.com/api-reference/deposit-account/issue-a-deposit-identity.md): Provisions a new static crypto deposit address (per chain) or an NGN virtual bank account onto an existing deposit account.
- [Get withdrawal addresses](https://docs.dexxify.com/api-reference/deposit-account/get-withdrawal-addresses.md): Fetch all withdrawal (payout) wallet addresses
- [Add withdrawal address](https://docs.dexxify.com/api-reference/deposit-account/add-withdrawal-address.md): Add a withdrawal (payout) wallet address for stable coins
- [Get saved withdrawal addresses](https://docs.dexxify.com/api-reference/deposit-account/get-saved-withdrawal-addresses.md): Fetch all saved withdrawal (payout) wallet addresses
- [Remove withdrawal address](https://docs.dexxify.com/api-reference/deposit-account/remove-withdrawal-address.md): Remove a saved withdrawal address by its ID
- [Initiate stable coin withdrawal](https://docs.dexxify.com/api-reference/deposit-account/initiate-stable-coin-withdrawal.md): Initiate a stable coin withdrawal from a wallet
- [Initiate withdrawal for local currencies](https://docs.dexxify.com/api-reference/deposit-account/initiate-withdrawal-for-local-currencies.md): Initiate a withdrawal for local currencies from a wallet
- [Get withdrawals](https://docs.dexxify.com/api-reference/deposit-account/get-withdrawals.md): Fetch all payouts / withdrawals
- [List all customers](https://docs.dexxify.com/api-reference/customers/list-all-customers.md)
- [Create a customer](https://docs.dexxify.com/api-reference/customers/create-a-customer.md)
- [Get a customer by ID](https://docs.dexxify.com/api-reference/customers/get-a-customer-by-id.md)
- [Update a customer](https://docs.dexxify.com/api-reference/customers/update-a-customer.md)
- [Delete a customer](https://docs.dexxify.com/api-reference/customers/delete-a-customer.md)
- [Get or provision a customer's deposit account](https://docs.dexxify.com/api-reference/customers/get-or-provision-a-customers-deposit-account.md): Returns all crypto deposit addresses and NGN virtual accounts from CoincircuitMCP. Creates the deposit account if one does not exist yet.
- [Verify BVN](https://docs.dexxify.com/api-reference/kyc-verification/verify-bvn.md): Submit a BVN for identity verification. One per user across all businesses.
- [Verify NIN](https://docs.dexxify.com/api-reference/kyc-verification/verify-nin.md): Submit a NIN for identity verification. One per user across all businesses.
- [Verify virtual NIN (vNIN)](https://docs.dexxify.com/api-reference/kyc-verification/verify-virtual-nin-vnin.md): Submit a vNIN for identity verification. One per user across all businesses.
- [Verify CAC](https://docs.dexxify.com/api-reference/kyc-verification/verify-cac.md): Submit a CAC RC number for business verification. One per business.
- [Get individual KYC status](https://docs.dexxify.com/api-reference/kyc-verification/get-individual-kyc-status.md): Returns all identity verifications (BVN/NIN/vNIN) for the current user.
- [Get business KYC status](https://docs.dexxify.com/api-reference/kyc-verification/get-business-kyc-status.md): Returns CAC verification status for the active business.
- [Get verification by reference](https://docs.dexxify.com/api-reference/kyc-verification/get-verification-by-reference.md): Proxy to Kora, fetches a verification record by its provider reference.
- [Create off-ramp transaction](https://docs.dexxify.com/api-reference/off-ramp/create-off-ramp-transaction.md): Initiate a crypto off-ramp (sell crypto for fiat) transaction
- [Get off-ramp transaction](https://docs.dexxify.com/api-reference/off-ramp/get-off-ramp-transaction.md): Retrieve the status of an off-ramp, keyed by the id returned from POST /offramp. Tracks the full lifecycle — before the swap settles, only swap status is available;
- [Create payout](https://docs.dexxify.com/api-reference/payouts/create-payout.md): Create a new fiat payout to a bank account
- [Create batch payouts](https://docs.dexxify.com/api-reference/payouts/create-batch-payouts.md): Create multiple payouts in a single batch request
- [Resolve bank account](https://docs.dexxify.com/api-reference/payouts/resolve-bank-account.md): Verify and resolve bank account details to get account name
- [Get payout by ID](https://docs.dexxify.com/api-reference/payouts/get-payout-by-id.md): Retrieve details of a specific payout by its ID
- [Get the webhook endpoint for the current mode](https://docs.dexxify.com/api-reference/webhooks/get-the-webhook-endpoint-for-the-current-mode.md)
- [Create or update the webhook endpoint for the current mode](https://docs.dexxify.com/api-reference/webhooks/create-or-update-the-webhook-endpoint-for-the-current-mode.md)
- [Delete the webhook endpoint for the current mode](https://docs.dexxify.com/api-reference/webhooks/delete-the-webhook-endpoint-for-the-current-mode.md)
- [Regenerate the webhook signing secret](https://docs.dexxify.com/api-reference/webhooks/regenerate-the-webhook-signing-secret.md)
- [List webhook delivery events for the current mode](https://docs.dexxify.com/api-reference/webhooks/list-webhook-delivery-events-for-the-current-mode.md)
- [Get a single webhook delivery event](https://docs.dexxify.com/api-reference/webhooks/get-a-single-webhook-delivery-event.md)
- [Handle Coincircuit webhooks](https://docs.dexxify.com/api-reference/incoming-webhooks/handle-coincircuit-webhooks.md): Receives deposit, payment, and payout events from CoincircuitMCP. Verified via HMAC-SHA256 signature.
- [Live event stream (SSE) for the current business + mode](https://docs.dexxify.com/api-reference/realtime/live-event-stream-sse-for-the-current-business-+-mode.md): Pushes the same events dispatched to configured webhooks — payment, deposit, payout, swap, refund, etc. — to the dashboard in real time. Connect with EventSource({ withCredentials: true }) and listen per event name (e.g. addEventListener("payment.completed", ...)).
- [Get all transactions](https://docs.dexxify.com/api-reference/ledger/get-all-transactions.md): Retrieve all ledger transactions with filtering and pagination
- [Get transaction by ID](https://docs.dexxify.com/api-reference/ledger/get-transaction-by-id.md): Retrieve details of a specific ledger transaction
- [Get balance](https://docs.dexxify.com/api-reference/ledger/get-balance.md): Get current balance across all wallets and currencies
- [Get settlement report](https://docs.dexxify.com/api-reference/ledger/get-settlement-report.md): Generate settlement report for a specific date
- [List API keys](https://docs.dexxify.com/api-reference/dashboard/list-api-keys.md)
- [Create API key](https://docs.dexxify.com/api-reference/dashboard/create-api-key.md)
- [Revoke API key](https://docs.dexxify.com/api-reference/dashboard/revoke-api-key.md)
- [Update API key label or IP whitelist](https://docs.dexxify.com/api-reference/dashboard/update-api-key-label-or-ip-whitelist.md)
- [Dashboard overview](https://docs.dexxify.com/api-reference/dashboard/dashboard-overview.md): Balances, total received, payment session breakdown, invoice stats, customer counts, deposit accounts, and pending payouts.
- [Revenue chart](https://docs.dexxify.com/api-reference/dashboard/revenue-chart.md): Daily credit totals (NGN, USDT, USDC) from completed deposits over the last N days.
- [Asset distribution](https://docs.dexxify.com/api-reference/dashboard/asset-distribution.md): Payment sessions grouped by crypto asset — counts and volumes.
- [Recent activity](https://docs.dexxify.com/api-reference/dashboard/recent-activity.md): Latest ledger entries with direction, amount, and currency.
- [Get supported banks](https://docs.dexxify.com/api-reference/misc--banks-&-assets/get-supported-banks.md)
- [Add bank account](https://docs.dexxify.com/api-reference/misc--banks-&-assets/add-bank-account.md)
- [Get saved banks](https://docs.dexxify.com/api-reference/misc--banks-&-assets/get-saved-banks.md)
- [Get saved bank by account number](https://docs.dexxify.com/api-reference/misc--banks-&-assets/get-saved-bank-by-account-number.md)
- [Delete bank account](https://docs.dexxify.com/api-reference/misc--banks-&-assets/delete-bank-account.md)
- [Verify bank account](https://docs.dexxify.com/api-reference/misc--banks-&-assets/verify-bank-account.md)
- [Get supported blockchain and assets](https://docs.dexxify.com/api-reference/misc--banks-&-assets/get-supported-blockchain-and-assets.md)
- [Get crypto conversion rate](https://docs.dexxify.com/api-reference/misc--banks-&-assets/get-crypto-conversion-rate.md)
- [Estimate payment amount in crypto](https://docs.dexxify.com/api-reference/misc--banks-&-assets/estimate-payment-amount-in-crypto.md)
- [Health check](https://docs.dexxify.com/api-reference/health/health-check.md)
- [List payment sessions](https://docs.dexxify.com/api-reference/payment-sessions/list-payment-sessions.md)
- [Create a payment session](https://docs.dexxify.com/api-reference/payment-sessions/create-a-payment-session.md): Initialise a payment session for onramp, offramp, or payout. Returns a reference the customer can use to complete payment.
- [Get a payment session by ID](https://docs.dexxify.com/api-reference/payment-sessions/get-a-payment-session-by-id.md)
- [Get a payment session by reference](https://docs.dexxify.com/api-reference/payment-sessions/get-a-payment-session-by-reference.md)
- [Generate deposit address for a session](https://docs.dexxify.com/api-reference/payment-sessions/generate-deposit-address-for-a-session.md): Requests a crypto deposit address from CoincircuitMCP and stores it on the session.
- [Estimate crypto amount for a fiat payment](https://docs.dexxify.com/api-reference/payment-sessions/estimate-crypto-amount-for-a-fiat-payment.md): Returns the crypto amount equivalent for a given fiat amount.
- [Cancel a pending payment session](https://docs.dexxify.com/api-reference/payment-sessions/cancel-a-pending-payment-session.md)
- [List invoices](https://docs.dexxify.com/api-reference/invoices/list-invoices.md)
- [Create and send an invoice](https://docs.dexxify.com/api-reference/invoices/create-and-send-an-invoice.md): Creates an invoice via CoincircuitMCP and saves it to the database. Returns the invoice including a payment URL to share with your customer.
- [Get invoice by ID](https://docs.dexxify.com/api-reference/invoices/get-invoice-by-id.md): Returns local invoice data enriched with live CC status.
- [Get invoice by number (public)](https://docs.dexxify.com/api-reference/invoices/get-invoice-by-number-public.md): Public endpoint — no auth required. Used by the customer-facing pay page to display invoice details.
- [Create payment session for invoice (public)](https://docs.dexxify.com/api-reference/invoices/create-payment-session-for-invoice-public.md): Public endpoint — customer selects which crypto asset and network to pay with. Returns a payment session with a deposit address. The invoice is marked PAID automatically when payment.completed webhook fires.
- [Mark an invoice as paid](https://docs.dexxify.com/api-reference/invoices/mark-an-invoice-as-paid.md)
- [Cancel an invoice](https://docs.dexxify.com/api-reference/invoices/cancel-an-invoice.md)
- [Void a paid invoice](https://docs.dexxify.com/api-reference/invoices/void-a-paid-invoice.md)
- [List payment pages](https://docs.dexxify.com/api-reference/payment-pages/list-payment-pages.md)
- [Create a payment page](https://docs.dexxify.com/api-reference/payment-pages/create-a-payment-page.md)
- [Get a payment page by ID](https://docs.dexxify.com/api-reference/payment-pages/get-a-payment-page-by-id.md)
- [Update a payment page](https://docs.dexxify.com/api-reference/payment-pages/update-a-payment-page.md)
- [Delete a payment page](https://docs.dexxify.com/api-reference/payment-pages/delete-a-payment-page.md)
- [List all payment sessions through a page](https://docs.dexxify.com/api-reference/payment-pages/list-all-payment-sessions-through-a-page.md)
- [Get public payment page by slug](https://docs.dexxify.com/api-reference/public-payment-pages/get-public-payment-page-by-slug.md): Returns the page details a customer needs to complete payment. No auth required.
- [Submit payment on a page](https://docs.dexxify.com/api-reference/public-payment-pages/submit-payment-on-a-page.md): Customer selects crypto asset and submits. Creates a payment session and returns it.
- [Estimate swap amount](https://docs.dexxify.com/api-reference/swaps/estimate-swap-amount.md): Get a live rate estimate without locking the rate.
- [Create swap quotation](https://docs.dexxify.com/api-reference/swaps/create-swap-quotation.md): Lock the current rate for 15 seconds. Execute before it expires.
- [Get swap quotation by ID](https://docs.dexxify.com/api-reference/swaps/get-swap-quotation-by-id.md)
- [Execute swap quotation](https://docs.dexxify.com/api-reference/swaps/execute-swap-quotation.md): Execute a locked quotation. Must be done within 15 seconds of creation.
- [List swap history](https://docs.dexxify.com/api-reference/swaps/list-swap-history.md)
- [Get swap details by ID](https://docs.dexxify.com/api-reference/swaps/get-swap-details-by-id.md)
- [Estimate refund](https://docs.dexxify.com/api-reference/refunds/estimate-refund.md): Get refund estimation including fees and amounts before initiating.
- [List refunds](https://docs.dexxify.com/api-reference/refunds/list-refunds.md): Returns all refunds. Filters by status, session/invoice reference, date range, or search.
- [Get refund by ID](https://docs.dexxify.com/api-reference/refunds/get-refund-by-id.md)
- [Refund a payment session](https://docs.dexxify.com/api-reference/refunds/refund-a-payment-session.md): Initiates a refund for a completed payment session back to the customer wallet.
- [Platform fee balance](https://docs.dexxify.com/api-reference/admin/platform-fee-balance.md): Total revenue, amount already withdrawn, and available balance.
- [Withdraw platform fees](https://docs.dexxify.com/api-reference/admin/withdraw-platform-fees.md): Initiate a payout of accumulated fees to your bank or wallet. Only the available balance can be withdrawn.
- [Platform ledger history](https://docs.dexxify.com/api-reference/admin/platform-ledger-history.md): Paginated list of all fee credits and withdrawals.
- [List all businesses the current user belongs to](https://docs.dexxify.com/api-reference/businesses/list-all-businesses-the-current-user-belongs-to.md)
- [Create a new business](https://docs.dexxify.com/api-reference/businesses/create-a-new-business.md): Creates a new business workspace for the current user. Use POST /auth/select-business to switch into it.
- [Get active business profile](https://docs.dexxify.com/api-reference/businesses/get-active-business-profile.md)
- [Update business profile](https://docs.dexxify.com/api-reference/businesses/update-business-profile.md)
- [Update settlement configuration](https://docs.dexxify.com/api-reference/businesses/update-settlement-configuration.md)
- [Update notification preferences](https://docs.dexxify.com/api-reference/businesses/update-notification-preferences.md)
- [Invite a team member to your workspace](https://docs.dexxify.com/api-reference/teams/invite-a-team-member-to-your-workspace.md)
- [List active team members](https://docs.dexxify.com/api-reference/teams/list-active-team-members.md)
- [List pending invitations](https://docs.dexxify.com/api-reference/teams/list-pending-invitations.md)
- [Remove a team member from your workspace](https://docs.dexxify.com/api-reference/teams/remove-a-team-member-from-your-workspace.md)
- [Update a team member (role, permissions, status)](https://docs.dexxify.com/api-reference/teams/update-a-team-member-role-permissions-status.md)
- [Accept a team invitation and set up your account](https://docs.dexxify.com/api-reference/teams/accept-a-team-invitation-and-set-up-your-account.md)
- [Get current developer profile](https://docs.dexxify.com/api-reference/developersmerchants/get-current-developer-profile.md)
- [Update personal profile (name, phone, theme)](https://docs.dexxify.com/api-reference/developersmerchants/update-personal-profile-name-phone-theme.md)
- [Change password](https://docs.dexxify.com/api-reference/developersmerchants/change-password.md)

## OpenAPI Specs

- [openapi](/openapi.json)