# Bullring Finance API Doc

## Docs

- [Get Balances](https://docs.bullring.finance/api-reference/balances/get-balances.md): Retrieve account balances.
- [Convert Currency](https://docs.bullring.finance/api-reference/conversions/convert-currency.md): Convert funds from one currency to another within a subaccount.
- [Get All Conversions](https://docs.bullring.finance/api-reference/conversions/get-all-conversions.md): Retrieve a paginated list of all conversions for a subaccount.
- [Get Conversion](https://docs.bullring.finance/api-reference/conversions/get-conversion.md): Retrieve details of a specific conversion.
- [Get Conversion Quote](https://docs.bullring.finance/api-reference/conversions/get-conversion-quote.md): Get a quote for a currency conversion.
- [Get Deposit Channels](https://docs.bullring.finance/api-reference/deposits/get-deposit-channels.md): Retrieve a list of available deposit channels.
- [Lightning Deposit](https://docs.bullring.finance/api-reference/deposits/lightning-deposit.md): Create a lightning invoice for a deposit. All deposit requests require approved KYC.
- [List All Deposits](https://docs.bullring.finance/api-reference/deposits/list-all-deposits.md): Retrieve a list of all deposits for a specific subaccount. All deposit requests require approved KYC.
- [Onchain Deposit](https://docs.bullring.finance/api-reference/deposits/onchain-deposit.md): Get a deposit address for a specified blockchain network. All deposit requests require approved KYC.
- [Request Fiat Deposit](https://docs.bullring.finance/api-reference/deposits/request-fiat-deposit.md): Initiate a fiat deposit request for a specific subaccount. The request body varies depending on the currency. All deposit requests require approved KYC.
- [Simulate Fiat/Stablecoin Deposit](https://docs.bullring.finance/api-reference/deposits/simulate-fiatstablecoin-deposit.md): Simulate a deposit in all [supported fiat currencies and stablecoins](/en/supported-currencies) for testing purposes in the sandbox environment. All deposit requests require approved KYC.
- [Get Deposit Fee](https://docs.bullring.finance/api-reference/fees/get-deposit-fee.md): Calculate the fee for a deposit.
- [Get Withdrawal Fee](https://docs.bullring.finance/api-reference/fees/get-withdrawal-fee.md): Calculate the fee for a withdrawal. All withdrawal requests require approved KYC.
- [Get All Offramps](https://docs.bullring.finance/api-reference/offramp/get-all-offramps.md): Retrieve a list of crypto withdrawals via offramp for a subaccount.
- [Get Offramp Quote](https://docs.bullring.finance/api-reference/offramp/get-offramp-quote.md): Get a quote to offramp crypto to fiat. This does not affect your Bullring balance.
- [Get One Offramp](https://docs.bullring.finance/api-reference/offramp/get-one-offramp.md): Retrieve the status of a crypto withdrawal via offramp.
- [Initiate Offramp](https://docs.bullring.finance/api-reference/offramp/initiate-offramp.md): Convert crypto to fiat via offramp. This does not affect your Bullring balance.
- [Get All Onramps](https://docs.bullring.finance/api-reference/onramp/get-all-onramps.md): Retrieve a list of onramp transactions for a subaccount.
- [Get One Onramp](https://docs.bullring.finance/api-reference/onramp/get-one-onramp.md): Retrieve the status of an onramp transaction.
- [Get Onramp Quote](https://docs.bullring.finance/api-reference/onramp/get-onramp-quote.md): Get a quote to onramp fiat to crypto. This does not affect your Bullring balance.
- [Initiate Onramp](https://docs.bullring.finance/api-reference/onramp/initiate-onramp.md): Initiate a fiat-to-crypto onramp transaction. This does not affect your Bullring balance.
- [Conversion Rate](https://docs.bullring.finance/api-reference/rates/conversion-rate.md): Get the conversion rate between two currencies. All withdrawal requests require approved KYC.
- [Add Fiat / Onchain Recipient](https://docs.bullring.finance/api-reference/recipients/add-fiat-onchain-recipient.md): Add a new fiat or cryptocurrency recipient for withdrawals. The request body varies depending on the currency. All withdrawal requests require approved KYC.
- [Get All Recipients](https://docs.bullring.finance/api-reference/recipients/get-all-recipients.md): Retrieve a list of all recipients for the subaccount.
- [Get Banks by Currency](https://docs.bullring.finance/api-reference/recipients/get-banks-by-currency.md): Retrieves a list of supported banks for a given currency.
- [Get One Recipient](https://docs.bullring.finance/api-reference/recipients/get-one-recipient.md): Retrieve the details of a single recipient by their ID. All withdrawal requests require approved KYC.
- [Validate BRL Recipient](https://docs.bullring.finance/api-reference/recipients/validate-brl-recipient.md): Validate the details of a BRL recipient. All withdrawal requests require approved KYC.
- [Validate NGN Recipient](https://docs.bullring.finance/api-reference/recipients/validate-ngn-recipient.md): Validate the details of an NGN recipient. All withdrawal requests require approved KYC.
- [Create Subaccount](https://docs.bullring.finance/api-reference/subaccounts/create-subaccount.md): Create a new user subaccount.
- [Get All Subaccounts](https://docs.bullring.finance/api-reference/subaccounts/get-all-subaccounts.md): Retrieve a paginated list of all user subaccounts for a particular account.
- [Get Subaccount](https://docs.bullring.finance/api-reference/subaccounts/get-subaccount.md): Retrieve the details of a specific subaccount using its ID.
- [Add/Update Business Information](https://docs.bullring.finance/api-reference/verification/addupdate-business-information.md): Add or update the KYC (Know Your Business) information for a business subaccount. This endpoint allows you to submit comprehensive business details including legal information, addresses, beneficial ownership, and supporting documents required for business verification.
- [Add/Update Individual Information](https://docs.bullring.finance/api-reference/verification/addupdate-individual-information.md): Add or update the KYC information for a  customer.
- [Get Business Information](https://docs.bullring.finance/api-reference/verification/get-business-information.md): Retrieve the  business KYC information.
- [Get Individual Information](https://docs.bullring.finance/api-reference/verification/get-individual-information.md): Retrieve the  customer KYC information.
- [Get Occupations](https://docs.bullring.finance/api-reference/verification/get-occupations.md): Retrieve a list of accepted occupations for KYC verification.
- [Get Verification Form](https://docs.bullring.finance/api-reference/verification/get-verification-form.md): Get the Know Your Customer/Business verification form URL.
- [Submit Business Information](https://docs.bullring.finance/api-reference/verification/submit-business-information.md): Submit the  business information for verification.
- [Submit Individual Information](https://docs.bullring.finance/api-reference/verification/submit-individual-information.md): Submit the  customer information for verification.
- [Get One Withdrawal](https://docs.bullring.finance/api-reference/withdrawals/get-one-withdrawal.md): Retrieve the details of a single withdrawal by its ID. All withdrawal requests require approved KYC.
- [Withdraw Fiat](https://docs.bullring.finance/api-reference/withdrawals/withdraw-fiat.md): Initiate a fiat withdrawal from a user's subaccount. The request body varies depending on the currency. All withdrawal requests require approved KYC.
- [Withdraw Stablecoin](https://docs.bullring.finance/api-reference/withdrawals/withdraw-stablecoin.md): Withdraw funds as a stablecoin to a specified address. All withdrawal requests require approved KYC.
- [Accounts & Subaccounts](https://docs.bullring.finance/en/accounts.md): Understanding the relationship between Accounts and Subaccounts
- [Authentication](https://docs.bullring.finance/en/authentication.md)
- [Deposit Events](https://docs.bullring.finance/en/deposit-events.md): Real-time notifications for when funds are received
- [Environments](https://docs.bullring.finance/en/environments.md)
- [Introduction](https://docs.bullring.finance/en/introduction.md): Welcome to Bullring Finance
- [Multi-currency Balances](https://docs.bullring.finance/en/multi-currency-balances.md): Understanding how subaccounts manage multiple currency balances.
- [Off-Ramp Events](https://docs.bullring.finance/en/off-ramp-events.md): Real-time notifications related to offramp status changes.
- [On-Ramp Events](https://docs.bullring.finance/en/on-ramp-events.md): Real-time notifications related to onramp status changes.
- [Subaccount Events](https://docs.bullring.finance/en/subaccount-events.md): Real-time notifications related to subaccount status changes.
- [Supported Currencies & Rails](https://docs.bullring.finance/en/supported-currencies.md): List of supported fiat and digital currencies
- [Beneficiaries, Payouts & Offramp](https://docs.bullring.finance/en/use-cases/beneficiaries.md): Manage recipients, send fiat payouts, and off-ramp to stablecoins.
- [Business Identification Numbers by Country](https://docs.bullring.finance/en/use-cases/business-id-numbers.md): List of accepted identification number types for businesses by country and region.
- [Card Collection](https://docs.bullring.finance/en/use-cases/card-collection.md): Collect payments via card and withdraw to stablecoins.
- [Collections and Payouts](https://docs.bullring.finance/en/use-cases/collections-and-payouts.md): Accept payments and send payouts globally.
- [Instant Crypto Off-Ramp](https://docs.bullring.finance/en/use-cases/crypto-offramp.md): Convert crypto to cash instantly.
- [Deposits & On-Ramping](https://docs.bullring.finance/en/use-cases/fiat-on-ramp.md): Fund subaccounts using fiat, stablecoins, and cryptocurrencies.
- [Individual Identification Numbers by Country](https://docs.bullring.finance/en/use-cases/individual-id-numbers.md): List of accepted identification number types for individuals by country and region.
- [Institutional Transactions](https://docs.bullring.finance/en/use-cases/institutional-transactions.md): Access OTC rates, power exchanges, and dedicated banking infrastructure for institutional clients.
- [Customer Verification Document Guide](https://docs.bullring.finance/en/use-cases/kyc-verification-document-guide.md): Document samples and Cloudinary links that trigger approved, retryable failed, and final failed KYC states for individual and business verification.
- [Mass Payouts for Teams](https://docs.bullring.finance/en/use-cases/mass-payouts.md): Programmatic payouts to multiple currencies.
- [Multi-currency Operations](https://docs.bullring.finance/en/use-cases/multi-currency-operations.md): Common patterns for managing multiple currency balances and conversions.
- [Customer Onboarding](https://docs.bullring.finance/en/use-cases/onboarding.md): Learn how to create and verify subaccounts, including status transitions, currency unlocking, and webhook events.
- [Rail Specific Details](https://docs.bullring.finance/en/use-cases/rail-specific-details.md): Behaviors unique to each fiat rail supported by Bridge Orchestration.
- [Pre-Transaction Estimates](https://docs.bullring.finance/en/use-cases/rates-estimates.md): Calculate rates and fees before transacting.
- [Cross-Border Remittance](https://docs.bullring.finance/en/use-cases/remittance.md): Receive local currency (NGN), hold USD, and pay out globally (EUR).
- [Introduction](https://docs.bullring.finance/en/webhook-intro.md): Understanding bullring webhooks.
- [Withdrawal Events](https://docs.bullring.finance/en/withdrawal-events.md): Real-time notifications for outgoing payment status updates

## OpenAPI Specs

- [openapi](https://docs.bullring.finance/api-reference/openapi.json)

## Optional

- [Community](https://join.slack.com/t/bullringfinan-dof3933/shared_invite/zt-34057x3jm-mPsTyEXYFIxGAuSJYV0zsg)
- [Blog](https://blog.bullring.finance)