# Bifrost Crypto API

> Crypto payments API v1: payins with deposit addresses, payouts of up to 50 per request, balances, statements, prices and fixed deposit addresses on multiple networks. Base URL https://bridge.bifrostcrypto.com/v1, API key in the X-Bifrost-Invoke header, JSON bodies, amounts as decimal strings.

## Documentation

- [Full documentation in Markdown](https://bifrostcrypto.com/ai.md): every page in one file, with a summary for agents at the top and integration recipes at the end
- [Postman collection](https://bifrostcrypto.com/postman-collection.json): every /v1 endpoint with example bodies and responses, authentication and optional request signing set up
- [OpenAPI 3.1](https://bifrostcrypto.com/openapi.json): machine-readable specification generated from the same source

## Pages

- [Bifrost Crypto API](https://bifrostcrypto.com/ai/en/introduction.md): Complete reference for the Bifrost Crypto API V1. Integrate multi-chain crypto payments into your platform in minutes.
- [Authentication & Access Control](https://bifrostcrypto.com/ai/en/authentication.md): API key, scopes, IP whitelist, request signing and rate limits of the Bifrost Crypto API.
- [Accept a payment](https://bifrostcrypto.com/ai/en/guide-payin.md): Step-by-step guide to receive a crypto payment with the Bifrost Crypto API.
- [Send a payout](https://bifrostcrypto.com/ai/en/guide-payout.md): Step-by-step guide to send crypto payouts with the Bifrost Crypto API.
- [Webhook verification](https://bifrostcrypto.com/ai/en/webhooks.md): How Bifrost Crypto webhooks are delivered, retried and signed, and how to verify them.
- [Payout webhooks](https://bifrostcrypto.com/ai/en/webhooks-payments.md): Webhook notices for payouts created through the Bifrost Crypto API.
- [Deposit webhooks](https://bifrostcrypto.com/ai/en/webhooks-receipts.md): Webhook notices for payins: detected, confirmed and reversed deposits.
- [Error Codes](https://bifrostcrypto.com/ai/en/error-codes.md): Every error code returned by the Bifrost Crypto API and what to do about it.
- [Changelog](https://bifrostcrypto.com/ai/en/changelog.md): Changes to the Bifrost Crypto API contract, newest first.
- [Create Payout Single · POST /v1/payout](https://bifrostcrypto.com/ai/en/create-payout-single.md): Creates one payout (withdrawal) to a destination wallet.
- [Create Payout Multiple · POST /v1/payout](https://bifrostcrypto.com/ai/en/create-payout-multiple.md): Creates up to 50 payouts in one request.
- [List Payouts · GET /v1/list-payout](https://bifrostcrypto.com/ai/en/list-payouts.md): Lists the payouts created through the API (payouts made in the panel are not included), newest first (created_at descending), with filters and pagination.
- [Check Specific Payout · GET /v1/check-payout/:internal_reference](https://bifrostcrypto.com/ai/en/check-payout.md): Returns one payout created through the API, by the internal_reference returned when it was created.
- [Create Payin · POST /v1/payin](https://bifrostcrypto.com/ai/en/create-payin-single.md): Creates a single deposit and answers 200 OK with a wallet address for the customer to send funds to.
- [List Payins · GET /v1/list-payin](https://bifrostcrypto.com/ai/en/list-payins.md): Lists deposits created through the API (not those created in the panel), newest first (created_at descending), with filters and pagination.
- [Check Specific Payin · GET /v1/check-payin/:internal_reference](https://bifrostcrypto.com/ai/en/check-payin.md): Checks the status of a specific deposit by internal_reference and answers 200 OK.
- [Get Balances · GET /v1/balances](https://bifrostcrypto.com/ai/en/get-balances.md): Returns gross balances plus amounts held by deposits that are not final yet, with 200 OK.
- [List Statements · GET /v1/statements](https://bifrostcrypto.com/ai/en/list-statements.md): Lists the balance movements caused by API operations (payins, payouts, their fees, payout refunds and deposit reversals), newest first.
- [Statements Summary · GET /v1/statements/summary](https://bifrostcrypto.com/ai/en/statements-summary.md): Returns counts and aggregated amounts of the same movements List Statements returns, grouped by balance (currency).
- [Complete Summary · GET /v1/summary](https://bifrostcrypto.com/ai/en/complete-summary.md): Returns complete summary including accepted tokens and their configurations, accepted fiats, user information (fees, settings), and user-specific network rates.
- [Accepted Tokens · GET /v1/summary/tokens](https://bifrostcrypto.com/ai/en/accepted-tokens.md): Returns only the list of accepted tokens with their configurations.
- [Accepted Fiats · GET /v1/summary/fiats](https://bifrostcrypto.com/ai/en/accepted-fiats.md): Returns only the list of accepted fiat currencies.
- [Get Price · GET /v1/get-price](https://bifrostcrypto.com/ai/en/get-price.md): Gets the conversion price between two currencies (crypto or fiat).
- [List Available Currencies · GET /v1/get-currencies](https://bifrostcrypto.com/ai/en/get-currencies.md): Lists all available currencies (crypto and fiat) for price queries.
- [Supported Networks · GET /v1/fixed-wallets/supported](https://bifrostcrypto.com/ai/en/fixed-wallets-supported.md): Returns the networks and tokens enabled for fixed addresses.
- [Get Config · GET /v1/fixed-wallets/config](https://bifrostcrypto.com/ai/en/fixed-wallets-config-get.md): Returns the user's fixed addresses config (limits, enabled status and webhook_url).
- [Update Config · PUT /v1/fixed-wallets/config](https://bifrostcrypto.com/ai/en/fixed-wallets-config-update.md): Registers, updates or removes the webhook_url for fixed addresses.
- [List Fixed Wallets · GET /v1/fixed-wallets](https://bifrostcrypto.com/ai/en/list-fixed-wallets.md): Lists the fixed addresses assigned to your account via the external API, with optional filters, newest first.
- [Create Fixed Wallet · POST /v1/fixed-wallets](https://bifrostcrypto.com/ai/en/create-fixed-wallet.md): Assigns a fixed (permanent) address to your account for the given chain family (type).

## Optional

- [Português](https://bifrostcrypto.com/ai/pt-BR.md): the full documentation with guides and explanations in Português; the endpoint reference stays in English
- [Español](https://bifrostcrypto.com/ai/es.md): the full documentation with guides and explanations in Español; the endpoint reference stays in English
- [Français](https://bifrostcrypto.com/ai/fr.md): the full documentation with guides and explanations in Français; the endpoint reference stays in English