# Onboard Business Documentation

## Docs

- [Cross-border payment rails](https://docs.onboard.xyz/index.md): Build cross-border payments into your product with the Onboard API: stablecoin wallets, local-currency payouts, and account issuance for fintechs and platforms.
- [Overview](https://docs.onboard.xyz/guides/getting-started/overview.md)
- [Products](https://docs.onboard.xyz/guides/getting-started/products.md)
- [Getting Set Up with Onboard Business](https://docs.onboard.xyz/guides/getting-started/set-up.md)
- [Dashboard](https://docs.onboard.xyz/guides/getting-started/dashboard.md)
- [Getting API Credentials](https://docs.onboard.xyz/guides/api-concepts/api-credentials.md)
- [Configuring and Verifying Webhooks](https://docs.onboard.xyz/guides/api-concepts/webhooks-setup.md)
- [Introduction](https://docs.onboard.xyz/guides/product-features/virtual-account/introduction.md)
- [Primary Account](https://docs.onboard.xyz/guides/product-features/virtual-account/primary-account.md)
- [Sub-accounts](https://docs.onboard.xyz/guides/product-features/virtual-account/sub-accounts.md)
- [Virtual Account Number](https://docs.onboard.xyz/guides/product-features/virtual-account/account-number.md)
- [Webhooks for Virtual Accounts](https://docs.onboard.xyz/guides/product-features/virtual-account/webhooks.md)
- [Getting Supported Tokens and Networks](https://docs.onboard.xyz/guides/product-features/stablecoin/supported-tokens.md)
- [Deposits](https://docs.onboard.xyz/guides/product-features/stablecoin/deposits.md)
- [Crypto Beneficiary Management](https://docs.onboard.xyz/guides/product-features/stablecoin/beneficiaries.md)
- [Withdrawals](https://docs.onboard.xyz/guides/product-features/stablecoin/withdrawals.md)
- [Webhooks for Stablecoin Transactions](https://docs.onboard.xyz/guides/product-features/stablecoin/webhooks.md)
- [Introduction](https://docs.onboard.xyz/guides/product-features/cash-deposits/introduction.md)
- [Cash Deposit Flow](https://docs.onboard.xyz/guides/product-features/cash-deposits/flow.md)
- [Webhooks for Cash Deposits](https://docs.onboard.xyz/guides/product-features/cash-deposits/webhooks.md)
- [Introduction](https://docs.onboard.xyz/guides/product-features/cash-payouts/introduction.md)
- [Beneficiaries](https://docs.onboard.xyz/guides/product-features/cash-payouts/beneficiaries.md)
- [Cash Payout Flows](https://docs.onboard.xyz/guides/product-features/cash-payouts/flow.md)
- [Webhooks for Cash Payouts](https://docs.onboard.xyz/guides/product-features/cash-payouts/webhooks.md)
- [Introduction](https://docs.onboard.xyz/guides/product-features/offramp-accounts/introduction.md)
- [Process for Offramp Accounts](https://docs.onboard.xyz/guides/product-features/offramp-accounts/process.md)
- [Webhooks for Offramp Accounts](https://docs.onboard.xyz/guides/product-features/offramp-accounts/webhooks.md)
- [Overview](https://docs.onboard.xyz/guides/product-features/transaction-activities/overview.md)
- [Breakdown of Activity Types and Data](https://docs.onboard.xyz/guides/product-features/transaction-activities/activity-types.md)
- [Supported Currencies](https://docs.onboard.xyz/guides/product-features/supported-currencies.md)
- [Supported Stablecoins and Networks](https://docs.onboard.xyz/guides/product-features/supported-stablecoins.md)
- [Stablecoin Account](https://docs.onboard.xyz/guides/use-cases/stablecoin-account.md)
- [Cross-border Payment](https://docs.onboard.xyz/guides/use-cases/cross-border-payment.md)
- [Collections from Local Currency](https://docs.onboard.xyz/guides/use-cases/collections-local-currency.md)
- [Stablecoin Onramp](https://docs.onboard.xyz/guides/use-cases/stablecoin-onramp.md)
- [Stablecoin Offramp](https://docs.onboard.xyz/guides/use-cases/stablecoin-offramp.md)
- [Crypto Payouts](https://docs.onboard.xyz/guides/use-cases/crypto-payouts.md)
- [Base URLs](https://docs.onboard.xyz/api-reference/base-urls.md): Sandbox and production endpoints for the Onboard Business API.
- [Authentication](https://docs.onboard.xyz/api-reference/authentication.md)
- [Webhook Verification](https://docs.onboard.xyz/api-reference/webhook-verification.md)
- [Get API Info](https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info.md)
- [Get Currency Assets](https://docs.onboard.xyz/api-reference/endpoints/info/get-currency-assets.md): This operation allows the client to get the Nestcoin supported Assets
- [Get Network Tokens](https://docs.onboard.xyz/api-reference/endpoints/info/get-network-tokens.md): Get list of stablecoin tokens supported for account by asset code. The asset code is the currency code of the main account e.g USD
- [List Accounts](https://docs.onboard.xyz/api-reference/endpoints/virtual-account/get-accounts.md): This operation allows the client to fetch all customer's accounts
- [Get Account by ID](https://docs.onboard.xyz/api-reference/endpoints/virtual-account/get-account-by-id.md): This operation allows the client to fetch account details by account id. A client can fetch only their own account details.
- [List Sub-accounts](https://docs.onboard.xyz/api-reference/endpoints/virtual-account/get-subaccounts.md): This endpoint returns all sub-accounts
- [Create Sub-account](https://docs.onboard.xyz/api-reference/endpoints/virtual-account/create-subaccount.md): This endpoint helps to create sub-accounts for a customer. The endpoint requires the main account ID to create a sub-account under it.
- [Get Sub-account by Reference](https://docs.onboard.xyz/api-reference/endpoints/virtual-account/get-subaccount-by-ref.md): This endpoint returns sub-account details by sub-account ID.
- [Update Sub-account](https://docs.onboard.xyz/api-reference/endpoints/virtual-account/update-subaccount.md): This endpoint updates sub-account details by sub-account ID.
- [Delete Sub-account](https://docs.onboard.xyz/api-reference/endpoints/virtual-account/delete-subaccount.md): This endpoint deletes sub-account by sub-account ID. The sub-account must have zero balance before it can be deleted. The endpoint will return an error if the sub-account has a non-zero balance. The funds in the sub-account must be transferred to another account before deletion. Once an account is d…
- [Get Account Number Details](https://docs.onboard.xyz/api-reference/endpoints/virtual-account-number/get-account-details.md): Returns the bank account number (and bank details) generated for this account in the given currency, if one exists.
- [Generate Account Number](https://docs.onboard.xyz/api-reference/endpoints/virtual-account-number/create-account-details.md): Generates a bank account number for this account in the given currency through the account-number provider. Returns the existing details if one was already generated.
- [Get Sub-account Number Details](https://docs.onboard.xyz/api-reference/endpoints/virtual-account-number/get-subaccount-details.md): Returns the bank account number (and bank details) generated for this sub-account in the given currency, if one exists.
- [Generate Sub-account Number](https://docs.onboard.xyz/api-reference/endpoints/virtual-account-number/create-subaccount-details.md): Generates a bank account number for this sub-account in the given currency through the account-number provider. The account name must be supplied by the client.
- [Get Offramp Account Funding Address](https://docs.onboard.xyz/api-reference/endpoints/offramp-accounts/get-funding-address.md): Get address for offramp account, response should include the list of TokenAssetNetwork supported for the address.
- [Get Sub-account Funding Address](https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-subaccount-funding-address.md): This operation allows the client to get the address for the sub-account if it exists
- [Generate Sub-account Funding Address](https://docs.onboard.xyz/api-reference/endpoints/stablecoin/create-subaccount-funding-address.md): This operation allows the client to create an address for the supported token and network for a sub-account.
- [Initiate Crypto Transfer](https://docs.onboard.xyz/api-reference/endpoints/stablecoin/create-crypto-transfer.md): This operation allow the client to perform crypto transfer to an external wallet.
- [Get Crypto Transfer](https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer.md): This operation allows the client to fetch a specific crypto transfer by its reference ID.
- [List Crypto Beneficiaries](https://docs.onboard.xyz/api-reference/endpoints/crypto-beneficiaries/list.md): This operation allows the client to fetch all beneficiary by accounts
- [Create Crypto Beneficiary](https://docs.onboard.xyz/api-reference/endpoints/crypto-beneficiaries/create.md): This Operation allows crypto users to save beneficiary
- [Get Crypto Beneficiary](https://docs.onboard.xyz/api-reference/endpoints/crypto-beneficiaries/get-by-id.md): This operation allows the client to fetch a crypto beneficiary by its Id
- [Delete Crypto Beneficiary](https://docs.onboard.xyz/api-reference/endpoints/crypto-beneficiaries/delete.md): This operation allows the client to delete a crypto beneficiary by its Id
- [List Fiat Beneficiaries](https://docs.onboard.xyz/api-reference/endpoints/fiat-beneficiaries/list.md): This operation allows the client to fetch all beneficiary by accounts and their transaction type
- [Create Fiat Beneficiary](https://docs.onboard.xyz/api-reference/endpoints/fiat-beneficiaries/create.md): This Operation allows user to save beneficiary
- [Get Fiat Beneficiary](https://docs.onboard.xyz/api-reference/endpoints/fiat-beneficiaries/get-by-id.md): This operation allows the client to fetch a beneficiary by its Id
- [Delete Fiat Beneficiary](https://docs.onboard.xyz/api-reference/endpoints/fiat-beneficiaries/delete.md): This operation allows the client to delete a beneficiary by its Id
- [Get Cash Deposit Currencies](https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/get-currencies.md): Get supported pay-in currencies for cash deposit. Only whitelisted pay-in currencies are returned.
- [Get Cash Deposit Rates](https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/get-rates.md): Get reference rate for cash deposits, from the pay-in currency to the account currency.
- [Create Cash Deposit Quote](https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-quote.md): Create quote for cash deposit
- [Create Cash Deposit](https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit.md): Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.
- [Get Cash Deposit](https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/get-by-reference.md): Get specific cash deposit by reference
- [List Cash Deposits](https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/list.md): Retrieve a list of cash deposits, can accept accountId, status
- [Get Cash Payout Currencies](https://docs.onboard.xyz/api-reference/endpoints/cash-payouts/get-currencies.md): Get supported payout currencies for cash payment.
- [Get Cash Payout Rates](https://docs.onboard.xyz/api-reference/endpoints/cash-payouts/get-rates.md): Get reference rate for cash payments
- [Create Cash Payout Quote](https://docs.onboard.xyz/api-reference/endpoints/cash-payouts/create-quote.md): Create quote for cash payment
- [List Cash Payouts](https://docs.onboard.xyz/api-reference/endpoints/cash-payouts/list.md): Retrieve a list of cash payments, can accept accountId, status
- [Create Cash Payout](https://docs.onboard.xyz/api-reference/endpoints/cash-payouts/create-payout.md): Create cash payment, using the created quote
- [Get Cash Payout](https://docs.onboard.xyz/api-reference/endpoints/cash-payouts/get-by-reference.md): Get specific cash payment by reference
- [List Offramp Accounts](https://docs.onboard.xyz/api-reference/endpoints/offramp-accounts/list.md): Get a list of offramp accounts, with pagination and payout currency
- [Create Offramp Account](https://docs.onboard.xyz/api-reference/endpoints/offramp-accounts/create.md): Create offramp account with beneficiary id.
- [Get Offramp Account](https://docs.onboard.xyz/api-reference/endpoints/offramp-accounts/get-by-id.md): Get offramp account by offrampAccountId
- [Delete Offramp Account](https://docs.onboard.xyz/api-reference/endpoints/offramp-accounts/delete.md): Delete offramp account and automatically disable address assigned.
- [Get Offramp Account Transactions](https://docs.onboard.xyz/api-reference/endpoints/offramp-accounts/get-transactions.md): Get a paginated list of transactions proccessed by offramp accounts
- [List Account Activities](https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/account-activities.md): This operation allows the client to fetch a paginated, aggregated feed of all transaction activity for an account (cash deposits/payments, account-number deposits, crypto deposits/withdrawals, internal transfers, offramp deposits), each with type-specific details in activityData.
- [Get Account Activity](https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/account-activity-by-id.md): This operation allows the client to fetch a specific transaction activity by its ID.
- [List Sub-account Activities](https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activities.md): This operation allows the client to fetch a paginated, aggregated feed of all transaction activities for a sub-account (cash deposits/payments, account-number deposits, crypto deposits/withdrawals, internal transfers, offramp deposits), each with type-specific details in activityData.
- [Get Sub-account Activity](https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id.md): This operation allows the client to fetch a specific transaction activity by its ID.
- [List All Transaction Activities](https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/list-all.md): This operation allows the client to fetch a paginated, aggregated feed of all transaction activity for the authenticated business, optionally scoped to a single account, with the same type-specific activityData as the account-scoped activities endpoint.
- [WebHook Events](https://docs.onboard.xyz/api-reference/webhook-events.md)

## OpenAPI Specs

- [openapi](https://docs.onboard.xyz/api-reference/openapi.yml)