# Breet Docs

## Docs

- [Fetch Account Details](https://docs.breet.io/api-reference/account/fetch-account-details.md): Retrieve integration details such as balances, wallets, platform fees, and preferences.
- [Update Markup Percentage](https://docs.breet.io/api-reference/account/update-markup-percentage.md): Set a markup percentage that will be applied to your auto settled crypto transactions payout
- [Fetch Deposit Assets](https://docs.breet.io/api-reference/assets/fetch-deposit-assets.md): Retrieves the full list of supported deposit/sell assets, available networks, and configuration settings.
- [Fetch Withdrawal Assets](https://docs.breet.io/api-reference/assets/fetch-withdrawal-assets.md): Retrieves the full list of supported withdrawal assets, available networks, and withdrawal configuration settings.
- [Add Bank](https://docs.breet.io/api-reference/banks/add-bank.md): This adds a validated NGN or GHS bank to your integration
- [Delete bank](https://docs.breet.io/api-reference/banks/delete-bank.md): Remove a saved bank account from your integration by ID. The bank will also be detached from all wallets associated with it.
- [Fetch Bank By ID](https://docs.breet.io/api-reference/banks/fetch-bank-by-id.md): Fetch a bank on your integration by ID
- [Fetch Bank List](https://docs.breet.io/api-reference/banks/fetch-bank-list.md): Retrieve list of available banks
- [Fetch Saved Banks](https://docs.breet.io/api-reference/banks/fetch-saved-banks.md): Fetch banks on your integration
- [Verify Bank Account](https://docs.breet.io/api-reference/banks/verify-bank-account.md): Verify bank account
- [Convert Fiat to USD](https://docs.breet.io/api-reference/conversion/convert-fiat-to-usd.md): Convert local fiat (NGN or GHS) balance to USD. Optionally provide a withdrawal address ID to automatically withdraw the converted USD to that address.
- [Convert USD to Fiat](https://docs.breet.io/api-reference/conversion/convert-usd-to-fiat.md): Convert USD balance to local fiat (NGN or GHS). Optionally specify a saved bank to credit.
- [Fetch Wallet Addresses](https://docs.breet.io/api-reference/crypto-wallet/fetch-wallet-addresses.md): Retrieve all wallet addressess.
- [Fetch Wallet By ID](https://docs.breet.io/api-reference/crypto-wallet/fetch-wallet-by-id.md): Retrieve a wallet using its unique ID.
- [Generate Wallet Address](https://docs.breet.io/api-reference/crypto-wallet/generate-wallet-address.md): Generates a permanent deposit wallet address for a specified asset. Each address is unique and reusable, so you only need to call this once per user per asset. Store the returned address and display it for future deposits. Optionally pass bank details and `autoSettlement` so incoming crypto can be p…
- [Set Auto Settlement Status](https://docs.breet.io/api-reference/crypto-wallet/set-auto-settlement-status.md): Enable/Disable auto settlement for a wallet address
- [Update Bank For Existing Wallet Address](https://docs.breet.io/api-reference/crypto-wallet/update-bank-for-existing-wallet-address.md): Update the bank account linked to an existing wallet address. Optionally set `autoSettlement` so incoming crypto to this address is paid out to that bank.
- [API overview](https://docs.breet.io/api-reference/introduction.md): Authenticate with the Breet API using header-based credentials. Learn about environments, base URL, response format, and security best practices.
- [Crypto Prices](https://docs.breet.io/api-reference/rates-and-prices/crypto-prices.md): Returns the current global market price for a crypto-to-fiat pair. These are global market prices, not Breet-specific rates. To get Breet's actual conversion rate for NGN or GHS, use the Rate Calculator endpoint instead.
- [Rate Calculator](https://docs.breet.io/api-reference/rates-and-prices/rate-calculator.md): Calculate crypto amount and get NGN/GHS rate. This endpoint returns Breet's actual conversion rate for NGN or GHS. Use this endpoint to determine the exact amount you'll receive when converting crypto to NGN or GHS.
- [Mock a trade (non-production only)](https://docs.breet.io/api-reference/testing/mock-a-trade-non-production-only.md): Simulates an incoming deposit so you can test your integration without sending real crypto. **Only available when `X-Breet-Env` is `development`.** The wallet is identified by `walletAddress`; it must match the given asset. The trade is processed as if it came from the blockchain and will trigger th…
- [Fetch Transaction By ID](https://docs.breet.io/api-reference/transactions/fetch-transaction-by-id.md): Retrieve a crypto transaction using its unique id.
- [Fetch Transactions](https://docs.breet.io/api-reference/transactions/fetch-transactions.md): Retrieve all crypto transactions.
- [Add withdrawal address](https://docs.breet.io/api-reference/wallet-addresses/add-withdrawal-address.md): Add a withdrawal (payout) wallet address for stable coins. If the same address, network, and token are sent with a different label, the existing address is updated instead of creating a duplicate. Maximum 3 addresses per user.
- [Fetch withdrawal addresses](https://docs.breet.io/api-reference/wallet-addresses/fetch-withdrawal-addresses.md): Fetch all saved withdrawal (payout) wallet addresses for the authenticated user or integration.
- [Remove withdrawal address](https://docs.breet.io/api-reference/wallet-addresses/remove-withdrawal-address.md): Remove a saved withdrawal (payout) wallet address by ID. If the same address, network, and token is re-added later with a different label, it will be stored as a new entry (add endpoint updates the existing one only when it already exists).
- [Get a single webhook event](https://docs.breet.io/api-reference/webhooks/get-a-single-webhook-event.md): Returns a stored webhook event by its `_id`. Webhooks are persisted for a fixed retention period of 7days.
- [List outgoing webhook events](https://docs.breet.io/api-reference/webhooks/list-outgoing-webhook-events.md): Returns paginated records of outgoing webhooks sent to your webhook URL. Webhooks are persisted for a fixed retention period of 7days.
- [Resend all webhooks for a reference](https://docs.breet.io/api-reference/webhooks/resend-all-webhooks-for-a-reference.md): Triggers an immediate redelivery attempt for **every** stored webhook event that matches the given `reference` (the trade or withdrawal reference). Webhooks are persisted for a fixed retention period of 7days.
- [Fetch Withdrawal By ID](https://docs.breet.io/api-reference/withdrawals/fetch-withdrawal-by-id.md): Retrieve a withdrawal by its ID or external ID
- [Fetch Withdrawals](https://docs.breet.io/api-reference/withdrawals/fetch-withdrawals.md): Retrieve all withdrawals
- [Withdraw (Stable Coins)](https://docs.breet.io/api-reference/withdrawals/withdraw-stable-coins.md): Initiate withdrawal to an external stable coin wallet address
- [Withdrawal (NGN | GHS)](https://docs.breet.io/api-reference/withdrawals/withdrawal-ngn-|-ghs.md): Initiate fiat (NGN | GHS) payout to bank
- [Auto-settlement](https://docs.breet.io/auto-settlement.md): Automatically convert incoming crypto deposits to local currency and pay out to a linked bank account using the Breet API.
- [Deposits](https://docs.breet.io/deposits.md): A detailed explanation concerning what happens end-to-end when crypto lands on a Breet-generated wallet address.
- [Error handling](https://docs.breet.io/errors.md): Understand Breet API error responses, HTTP status codes, and how to handle common error scenarios in your integration.
- [FAQs](https://docs.breet.io/faqs.md): Answers to frequently asked questions about the Breet API, pricing, supported countries, integration, and more.
- [API Introduction](https://docs.breet.io/index.md): Integrate crypto payments into your product with the Breet API. Accept deposits, convert assets, and settle to bank accounts in local currency.
- [Pagination](https://docs.breet.io/pagination.md): Learn how to paginate through large result sets in the Breet API using page and size query parameters. Includes supported endpoints and response examples.
- [Quickstart](https://docs.breet.io/quickstart.md): Get your Breet API credentials, set up authentication headers, and make your first API request in minutes.
- [Rate limiting](https://docs.breet.io/rate-limiting.md): Understand Breet API rate limits, retry headers, and best practices for handling 429 responses.
- [Supported assets](https://docs.breet.io/supported-assets.md): Cryptocurrencies and stablecoins supported for deposits and withdrawals on the Breet API, including networks, tokens, and minimum amounts.
- [Testing](https://docs.breet.io/testing.md): Test deposits and flows in development using the mock trade endpoint.
- [Betting & gaming](https://docs.breet.io/use-cases/betting-gaming.md): Enable crypto deposits and bank payouts for betting and gaming platforms. Accept stablecoins and settle winnings to local accounts with Breet.
- [E-commerce](https://docs.breet.io/use-cases/ecommerce.md): Add crypto checkout to your online store and auto-settle payments to your local bank account with the Breet API.
- [Fintech](https://docs.breet.io/use-cases/fintech.md): Accept crypto and stablecoin deposits in your fintech app and auto-settle to local bank accounts with the Breet API.
- [Crypto off-ramping](https://docs.breet.io/use-cases/offramp.md): Convert crypto and stablecoins to local currency and pay out to bank accounts in Nigeria and Ghana using the Breet API.
- [Crypto on-ramping](https://docs.breet.io/use-cases/onramp.md): Buy stablecoins (USDT or USDC) with your Breet USD balance and send them to any external wallet address.
- [OTC & P2P trading](https://docs.breet.io/use-cases/otc-p2p.md): Use Breet as settlement infrastructure for OTC desks and P2P crypto trading platforms. Auto-settle trades to local bank accounts.
- [Payroll](https://docs.breet.io/use-cases/payroll.md): Pay remote employees and contractors across Africa with stablecoin-to-bank payouts using the Breet API. Fast, low-cost, no bank wires.
- [SaaS & digital goods](https://docs.breet.io/use-cases/saas-digital-goods.md): Accept crypto payments for SaaS subscriptions and digital products. Auto-settle to your bank account with the Breet API.
- [Webhooks](https://docs.breet.io/webhooks.md): Set up Breet API webhooks to receive real-time notifications for crypto deposits, withdrawals, and trade events. Includes payload examples and security best practices.
- [Withdrawals](https://docs.breet.io/withdrawals.md): A detailed explanation concerning what happens end-to-end when you withdraw stablecoins or fiat from Breet to an external wallet address or bank account.

## OpenAPI Specs

- [openapi](https://docs.breet.io/api-reference/openapi.json)
- [index](https://docs.breet.io/index.json)
- [open-api](https://docs.breet.io/api-reference/open-api.json)