# KillB Documentation

## Docs

- [Create Account](https://docs.killb.com/api-reference/account/create-account.md)
- [Delete Account](https://docs.killb.com/api-reference/account/delete-account.md)
- [Download Bulk Beneficiary Template](https://docs.killb.com/api-reference/account/download-bulk-beneficiary-template.md): Downloads an Excel template for bulk beneficiary creation with dynamic dropdowns
- [Export Accounts to XLSX](https://docs.killb.com/api-reference/account/export-accounts-to-xlsx.md): Downloads accounts as XLSX file with filters. Only ACTIVE accounts are included. Maximum 10,000 records.
- [Get Account by id](https://docs.killb.com/api-reference/account/get-account-by-id.md)
- [Get Accounts](https://docs.killb.com/api-reference/account/get-accounts.md)
- [Get Accounts by UserId](https://docs.killb.com/api-reference/account/get-accounts-by-userid.md)
- [Get Bulk Upload Job Status](https://docs.killb.com/api-reference/account/get-bulk-upload-job-status.md): Returns the status and results of a bulk beneficiary upload job
- [Update Account](https://docs.killb.com/api-reference/account/update-account.md)
- [Upload Bulk Beneficiaries](https://docs.killb.com/api-reference/account/upload-bulk-beneficiaries.md): Uploads an Excel file with beneficiary data and returns a job ID for tracking
- [Generate an access token](https://docs.killb.com/api-reference/auth/generate-an-access-token.md)
- [Logout](https://docs.killb.com/api-reference/auth/logout.md): This action revoke the current session
- [Refresh access token](https://docs.killb.com/api-reference/auth/refresh-access-token.md)
- [Get Bank list by countryCode](https://docs.killb.com/api-reference/bank/get-bank-list-by-countrycode.md)
- [Configure a currency pair and payment method](https://docs.killb.com/api-reference/customer/configure-a-currency-pair-and-payment-method.md)
- [Create a pre-fund wallet](https://docs.killb.com/api-reference/customer/create-a-pre-fund-wallet.md)
- [Get all available pairs and options](https://docs.killb.com/api-reference/customer/get-all-available-pairs-and-options.md)
- [Get customer balances](https://docs.killb.com/api-reference/customer/get-customer-balances.md)
- [Get customer liquidities](https://docs.killb.com/api-reference/customer/get-customer-liquidities.md)
- [Get customer profile](https://docs.killb.com/api-reference/customer/get-customer-profile.md)
- [API Environments](https://docs.killb.com/api-reference/environments.md): Sandbox and production environments
- [Fake cash-in (SANDBOX)](https://docs.killb.com/api-reference/faker/fake-cash-in-sandbox.md): This endpoint is responsible for faking a cash-in.
- [Fake cash-out confirmation (SANDBOX)](https://docs.killb.com/api-reference/faker/fake-cash-out-confirmation-sandbox.md): This endpoint is responsible for faking a cash-out confirmation.
- [API Introduction](https://docs.killb.com/api-reference/introduction.md): Getting started with KillB API
- [Open API JSON](https://docs.killb.com/api-reference/open-api/open-api-json.md): API JSON schema with all endpoints
- [Create Payouts](https://docs.killb.com/api-reference/payouts/create-payouts.md): This endpoint is responsible for creating a payout.
- [Get Payout by ID](https://docs.killb.com/api-reference/payouts/get-payout-by-id.md): Returns a single payout by ID for the authenticated customer.
- [List Payouts](https://docs.killb.com/api-reference/payouts/list-payouts.md): Returns a paginated list of payouts for the authenticated customer.
- [Create Quotation](https://docs.killb.com/api-reference/quotations/create-quotation.md): Create a new quotation
- [Get Quotation](https://docs.killb.com/api-reference/quotations/get-quotation.md): Get a quotation by id
- [Simulate a Quotation](https://docs.killb.com/api-reference/quotations/simulate-a-quotation.md): Generate just a simulation of a quote
- [Update Quotation](https://docs.killb.com/api-reference/quotations/update-quotation.md): Update a new quotation
- [Create Ramps](https://docs.killb.com/api-reference/ramps/create-ramps.md): This endpoint is responsible for executing the Ramp (On or/and Off). For more details about this endpoint, see here [Ramps](https://killbapi.stoplight.io/docs/killb-v2/71722efcded7f)
- [Get Ramp by id](https://docs.killb.com/api-reference/ramps/get-ramp-by-id.md): This endpoint is responsible for getting the Ramp by id. For more details about this endpoint, see here [Ramps](https://killbapi.stoplight.io/docs/killb-v2/71722efcded7f)
- [Get Ramp Receipt in JSON](https://docs.killb.com/api-reference/ramps/get-ramp-receipt-in-json.md): This endpoint is return an JSON receipt for the Ramp.
- [Get ramp status history](https://docs.killb.com/api-reference/ramps/get-ramp-status-history.md): This endpoint is responsible for getting the Ramp status history. For more details about this endpoint, see here [Ramps](https://killbapi.stoplight.io/docs/killb-v2/71722efcded7f)
- [Query Ramps](https://docs.killb.com/api-reference/ramps/query-ramps.md): This endpoint is responsible for getting the Ramp list. For more details about this endpoint, see here [Ramps](https://killbapi.stoplight.io/docs/killb-v2/71722efcded7f)
- [Update Ramp](https://docs.killb.com/api-reference/ramps/update-ramp.md): This endpoint is responsible for executing the Ramp (On or/and Off). For more details about this endpoint, see here [Ramps](https://killbapi.stoplight.io/docs/killb-v2/71722efcded7f)
- [Upload ramp document](https://docs.killb.com/api-reference/ramps/upload-ramp-document.md): Attach a PDF document to an existing ramp transfer.
- [Create savings account](https://docs.killb.com/api-reference/savings/create-savings-account.md)
- [Create withdrawal](https://docs.killb.com/api-reference/savings/create-withdrawal.md)
- [Get balance](https://docs.killb.com/api-reference/savings/get-balance.md)
- [Get banking deposit instructions](https://docs.killb.com/api-reference/savings/get-banking-deposit-instructions.md)
- [Get crypto deposit instructions](https://docs.killb.com/api-reference/savings/get-crypto-deposit-instructions.md)
- [Get savings account](https://docs.killb.com/api-reference/savings/get-savings-account.md)
- [Get transactions](https://docs.killb.com/api-reference/savings/get-transactions.md)
- [Add company user document](https://docs.killb.com/api-reference/user/add-company-user-document.md)
- [Add person user document](https://docs.killb.com/api-reference/user/add-person-user-document.md)
- [Create a user](https://docs.killb.com/api-reference/user/create-a-user.md)
- [Delete user](https://docs.killb.com/api-reference/user/delete-user.md)
- [Get users](https://docs.killb.com/api-reference/user/get-users.md)
- [Get users by ID](https://docs.killb.com/api-reference/user/get-users-by-id.md)
- [Update user](https://docs.killb.com/api-reference/user/update-user.md)
- [Create virtual account](https://docs.killb.com/api-reference/virtual-accounts/create-virtual-account.md)
- [Create withdrawal from virtual account](https://docs.killb.com/api-reference/virtual-accounts/create-withdrawal-from-virtual-account.md)
- [Get all virtual accounts](https://docs.killb.com/api-reference/virtual-accounts/get-all-virtual-accounts.md)
- [Get all withdrawals from all virtual accounts](https://docs.killb.com/api-reference/virtual-accounts/get-all-withdrawals-from-all-virtual-accounts.md)
- [Get withdrawals from virtual account](https://docs.killb.com/api-reference/virtual-accounts/get-withdrawals-from-virtual-account.md)
- [Create a webhook config.](https://docs.killb.com/api-reference/webhook/create-a-webhook-config.md): Create a webhook config. For more information, examples and how works see here: [Webhook Documentation](/docs/Webhooks.md)
- [Delete webhook config](https://docs.killb.com/api-reference/webhook/delete-webhook-config.md): Endpoint responsible for REMOVE the webhook config. For more information, examples and how works see here: [Webhook Documentation](/docs/Webhooks.md)
- [Get webhook config](https://docs.killb.com/api-reference/webhook/get-webhook-config.md): Endpoint responsible for return a webhook config configured. For more information, examples and how works see here: [Webhook Documentation](/docs/Webhooks.md)
- [Update webhook config](https://docs.killb.com/api-reference/webhook/update-webhook-config.md): Endpoint responsible for UPDATE webhook config. For more information, examples and how works see here: [Webhook Documentation](/docs/Webhooks.md)
- [Authentication](https://docs.killb.com/authentication.md): Learn how to authenticate with the KillB API
- [Accounts](https://docs.killb.com/concepts/accounts.md): Understanding bank accounts, crypto wallets, and pre-funded accounts
- [Payouts](https://docs.killb.com/concepts/payouts.md): Push funds from your pre-funded balance directly to beneficiaries
- [Pre-Funded Accounts](https://docs.killb.com/concepts/pre-funded-accounts.md): Instant transaction execution with pre-deposited liquidity
- [Quotations](https://docs.killb.com/concepts/quotations.md): Understanding pricing, quotes, and exchange rates
- [Ramps](https://docs.killb.com/concepts/ramps.md): Understanding on-ramps and off-ramps for crypto conversion
- [Users](https://docs.killb.com/concepts/users.md)
- [Webhooks](https://docs.killb.com/concepts/webhooks.md): Real-time event notifications from KillB
- [Demo Apps & Examples](https://docs.killb.com/demo-apps.md): Sample implementations and integration examples
- [Bank Accounts](https://docs.killb.com/guides/accounts/bank-accounts.md): Set up bank accounts for fiat currency transfers
- [Crypto Wallets](https://docs.killb.com/guides/accounts/crypto-wallets.md): Set up cryptocurrency wallet accounts
- [Accounts Overview](https://docs.killb.com/guides/accounts/overview.md): Understanding and managing payment accounts
- [Create a Payout](https://docs.killb.com/guides/payouts/create-payout.md): Disburse funds from your pre-funded balance to a beneficiary
- [Payouts Overview](https://docs.killb.com/guides/payouts/overview.md): Disburse funds from your pre-funded balance directly to beneficiaries
- [Payout Status Tracking](https://docs.killb.com/guides/payouts/payout-status.md): Monitor and handle payout disbursement status
- [Pre-Funded Accounts](https://docs.killb.com/guides/pre-fund/pre-fund-accounts.md): Enable instant transaction execution with pre-funded balances
- [Off-Ramp Implementation](https://docs.killb.com/guides/ramps/off-ramp.md): Convert cryptocurrency to fiat currency
- [On-Ramp Implementation](https://docs.killb.com/guides/ramps/on-ramp.md): Convert fiat currency to cryptocurrency
- [Ramps Overview](https://docs.killb.com/guides/ramps/overview.md): Understanding on-ramps and off-ramps
- [Ramp Status Tracking](https://docs.killb.com/guides/ramps/ramp-status.md): Monitor and handle ramp transaction status
- [Create Savings Account](https://docs.killb.com/guides/savings/create-account.md): Set up custodial USD savings accounts
- [Savings Deposits](https://docs.killb.com/guides/savings/deposits.md): Fund your savings account via ACH, Wire, or crypto
- [Savings Accounts Overview](https://docs.killb.com/guides/savings/overview.md): USD-denominated custodial savings accounts
- [Savings Withdrawals](https://docs.killb.com/guides/savings/withdrawals.md): Withdraw from savings to bank or crypto wallet
- [Creating Users](https://docs.killb.com/guides/users/create-user.md): Step-by-step guide to creating and managing users
- [Managing Users](https://docs.killb.com/guides/users/manage-users.md): Query, update, and delete user profiles
- [Uploading Documents](https://docs.killb.com/guides/users/upload-documents.md): Submit KYC/KYB documents for user verification
- [Webhook Events](https://docs.killb.com/guides/webhooks/events.md): Complete reference of all webhook events
- [Webhooks Overview](https://docs.killb.com/guides/webhooks/overview.md): Real-time event notifications from KillB
- [Webhook Security](https://docs.killb.com/guides/webhooks/security.md): Secure your webhook endpoints
- [Webhook Setup](https://docs.killb.com/guides/webhooks/setup.md): Implement and configure webhook endpoints
- [KillB Developer Platform](https://docs.killb.com/index.md): Build powerful crypto payment infrastructure with KillB's on/off-ramp API
- [Buy Crypto (On-Ramp)](https://docs.killb.com/portal/buy-crypto.md): Step-by-step guide to buying cryptocurrency through the OTC Portal
- [Getting Started](https://docs.killb.com/portal/getting-started.md): Set up your KillB OTC Portal account and start trading
- [KYC Verification](https://docs.killb.com/portal/kyc-verification.md): Complete identity verification to unlock full platform features
- [Manage Accounts](https://docs.killb.com/portal/manage-accounts.md): Add and manage bank accounts and crypto wallets
- [OTC Portal Overview](https://docs.killb.com/portal/overview.md): User guide for the KillB OTC Portal web application
- [Sell Crypto (Off-Ramp)](https://docs.killb.com/portal/sell-crypto.md): Step-by-step guide to selling cryptocurrency through the OTC Portal
- [Transaction History](https://docs.killb.com/portal/transactions.md): View and track all your crypto transactions
- [Quickstart Guide](https://docs.killb.com/quickstart.md): Get started with KillB API in under 10 minutes
- [Best Practices](https://docs.killb.com/resources/best-practices.md): Production-ready integration guidelines
- [Error Handling](https://docs.killb.com/resources/error-handling.md): Best practices for handling API errors
- [Glossary](https://docs.killb.com/resources/glossary.md): Key terms and definitions
- [Rate Limits](https://docs.killb.com/resources/rate-limits.md): API rate limiting and quotas
- [Sandbox Environment](https://docs.killb.com/sandbox.md): Test your integration safely without real funds
- [SDK Examples](https://docs.killb.com/sdks/examples.md): Complete examples using KillB SDK
- [Go SDK](https://docs.killb.com/sdks/go.md): Official Go SDK for KillB (Coming Soon)
- [SDKs](https://docs.killb.com/sdks/introduction.md): Official SDKs for building with KillB
- [JavaScript SDK](https://docs.killb.com/sdks/javascript.md): Official JavaScript/TypeScript SDK for KillB
- [PHP SDK](https://docs.killb.com/sdks/php.md): Official PHP SDK for KillB (Coming Soon)
- [Python SDK](https://docs.killb.com/sdks/python.md): Official Python SDK for KillB (Coming Soon)
- [Supported Networks & Methods](https://docs.killb.com/supported-networks.md): Available currencies, payment methods, and blockchain networks

## OpenAPI Specs

- [open-api-json](https://killb.app/api/v2/open-api-json)

## Optional

- [Website](https://www.killb.com)
- [Portal](https://otc.killb.com)
- [Support](https://www.killb.com/contact)