# Bridge - [index](https://apidocs.bridge.xyz/index.md) - [Welcome](https://apidocs.bridge.xyz/get-started/introduction/overview.md) - [Platform overview](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview.md) - [Get set up with Bridge](https://apidocs.bridge.xyz/get-started/introduction/quick-start/get-set-up-with-bridge.md) - [Onboard your first customer](https://apidocs.bridge.xyz/get-started/introduction/quick-start/create-your-first-customer.md) - [Create your first payment](https://apidocs.bridge.xyz/get-started/introduction/quick-start/create-a-one-time-payment.md) - [Configure webhooks](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-webhooks.md) - [Set up a sandbox environment](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-sandbox.md) - [Supported blockchains and fiat rails](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/payment-routes.md): Supported currencies, rails, and which currency pairs can be converted - [Dollar access](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/dollar-access.md) - [Remittances](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/remittances.md) - [Payroll](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll.md) - [Cross-border payments](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/cross-border-payments.md) - [Treasury management](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/treasury-management.md) - [Onramp with virtual accounts](https://apidocs.bridge.xyz/get-started/guides/move-money/virtualaccounts.md) - [USD integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/usd-integration-guide.md): On and offramp with USD using Wire, ACH, Same Day ACH, and FedNow - [EUR integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/eur-integration-guide.md): On and offramp with EUR using SEPA Instant and SEPA Credit payments - [BRL integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/brl_pix_integration_guide.md) - [GBP integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/gbp_fps_integration_guide.md): On and offramp with GBP using Faster Payments - [COP integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/cop_integration_guide.md): On and offramp with COP using Bre-b and Bank Transfer PSE/ACH - [MXN integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/mxn-spei-integration-guide.md): On and offramp with MXN using SPEI (Sistema de Pagos Electrónicos Interbancarios) - [Make recurring payments](https://apidocs.bridge.xyz/get-started/guides/move-money/recurring.md) - [Offramp with liquidation addresses](https://apidocs.bridge.xyz/get-started/guides/move-money/offramp_liquidation.md) - [FX guide: convert from fiat to fiat](https://apidocs.bridge.xyz/get-started/guides/move-money/fiat_to_fiat.md) - [USDT Self Serve Trading Endpoints](https://apidocs.bridge.xyz/get-started/guides/move-money/usdt-self-serve-trading-endpoints.md) - [Fixed outputs integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/fixed_outputs_integration_guide.md) - [Custodial wallets](https://apidocs.bridge.xyz/get-started/guides/wallets/overview.md) - [Send fiat deposits to your wallet](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp.md) - [Send wallet funds to a crypto address](https://apidocs.bridge.xyz/get-started/guides/wallets/crypto-to-crypto.md) - [Send wallet funds to a fiat external account](https://apidocs.bridge.xyz/get-started/guides/wallets/offramp.md) - [Cards](https://apidocs.bridge.xyz/get-started/guides/cards/overview.md) - [Spend wallet balances using a card](https://apidocs.bridge.xyz/get-started/guides/cards/spend.md) - [Supported Blockchains](https://apidocs.bridge.xyz/get-started/guides/move-money/supported-blockchains.md): Reference guide for all blockchains supported by Bridge - [Tempo integration guide](https://apidocs.bridge.xyz/get-started/guides/move-money/tempo-integration-guide.md) - [Crypto Travel Rule Guide](https://apidocs.bridge.xyz/get-started/guides/move-money/crypto-travel-rule.md) - [FAQ](https://apidocs.bridge.xyz/get-started/guides/move-money/crypto-travel-rule-faq.md): Frequently asked questions about Bridge's Crypto Travel Rule requirements - [Overview](https://apidocs.bridge.xyz/platform/orchestration/overview.md) - [Virtual accounts](https://apidocs.bridge.xyz/platform/orchestration/virtual_accounts/virtual-account.md) - [Virtual account events](https://apidocs.bridge.xyz/platform/orchestration/virtual_accounts/virtual-account-events.md) - [Additional functionality](https://apidocs.bridge.xyz/platform/orchestration/virtual_accounts/additional-functionality.md) - [Transfers](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer.md) - [Static template transfers](https://apidocs.bridge.xyz/platform/orchestration/transfers/static-templates.md) - [Transfer states](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer-states.md) - [Transfer features](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer-features.md) - [Source and destination updates](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer-updates.md) - [Transfer errors & recovery](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer-errors-and-recovery.md) - [Liquidation address](https://apidocs.bridge.xyz/platform/orchestration/liquidation_address/liquidation_address.md) - [Drains](https://apidocs.bridge.xyz/platform/orchestration/liquidation_address/drains.md) - [External accounts](https://apidocs.bridge.xyz/platform/orchestration/external-accounts/external-accounts-api.md) - [Link a bank account with plaid link](https://apidocs.bridge.xyz/platform/orchestration/external-accounts/plaid.md) - [External account validations](https://apidocs.bridge.xyz/platform/orchestration/external-accounts/validations.md) - [Verification of Payee (VoP)](https://apidocs.bridge.xyz/platform/orchestration/external-accounts/verification-of-payee.md) - [Named payouts](https://apidocs.bridge.xyz/platform/orchestration/more/fiat-payout-configuration.md) - [Static memos](https://apidocs.bridge.xyz/platform/orchestration/more/staticmemos.md) - [Prefunded accounts](https://apidocs.bridge.xyz/platform/orchestration/prefunded-accounts-deprecated.md) - [Returns](https://apidocs.bridge.xyz/platform/orchestration/more/returns.md) - [Handling funds requests (recalls)](https://apidocs.bridge.xyz/platform/orchestration/more/funds-requests.md) - [Overview](https://apidocs.bridge.xyz/platform/wallets/overview.md): Custodial Wallets to hold, send, and receive crypto. - [Prefunded wallets](https://apidocs.bridge.xyz/platform/wallets/prefunded_wallets.md) - [Move money to and from wallets](https://apidocs.bridge.xyz/platform/wallets/move-money.md): Create custodial Bridge wallets, fund them with stablecoins or fiat, and initiate transfers with optional SCA auth factor metadata. - [Sandbox integration](https://apidocs.bridge.xyz/platform/wallets/sandbox.md) - [Overview](https://apidocs.bridge.xyz/platform/issuance/overview.md) - [Issuance Options](https://apidocs.bridge.xyz/platform/issuance/issuance-options.md) - [Orchestration](https://apidocs.bridge.xyz/platform/issuance/orchestration.md) - [Minting and Burning](https://apidocs.bridge.xyz/platform/issuance/minting-and-burning.md) - [Reserve Management](https://apidocs.bridge.xyz/platform/issuance/reserve-management.md) - [Reporting and Transparency](https://apidocs.bridge.xyz/platform/issuance/reporting-and-transparency.md) - [Earning Rewards](https://apidocs.bridge.xyz/platform/issuance/rewards.md) - [Designing Your Stablecoin](https://apidocs.bridge.xyz/platform/issuance/designing-your-stablecoin.md) - [USDB](https://apidocs.bridge.xyz/platform/issuance/usdb.md) - [Growing Your Stablecoin](https://apidocs.bridge.xyz/platform/issuance/growing-your-stablecoin.md) - [Bridge stablecoins FAQ](https://apidocs.bridge.xyz/platform/issuance/faq.md): FAQ for end users - [Overview](https://apidocs.bridge.xyz/platform/cards/overview/overview.md): Issue stablecoin-backed cards to your customers globally - [Consumer issuing](https://apidocs.bridge.xyz/platform/cards/overview/stripe-issuing.md): Issue stablecoin-backed cards to individual customers via Bridge and Stripe - [Customer eligibility and KYC](https://apidocs.bridge.xyz/platform/cards/overview/kyc.md): Manage customer eligibility for card issuance and understand how Cardholder objects are created - [Commercial issuing](https://apidocs.bridge.xyz/platform/cards/overview/commercial-issuing.md): Issue stablecoin-backed cards to business customers via Bridge and Stripe Connect - [Funding strategies](https://apidocs.bridge.xyz/platform/cards/overview/funding-strategies.md): Choose between noncustodial and Bridge-custodied wallets to fund card spend - [Noncustodial wallets](https://apidocs.bridge.xyz/platform/cards/overview/noncustodial.md): Issue cards that spend just-in-time from a customer's own stablecoin wallet - [Webhooks](https://apidocs.bridge.xyz/platform/cards/overview/webhooks.md): Understand how Stripe Issuing webhooks map to onchain transactions in the Bridge integration - [Additional card features](https://apidocs.bridge.xyz/platform/cards/features.md): Physical cards, mobile wallets, spending controls, disputes, fraud management, and more - [Statements](https://apidocs.bridge.xyz/platform/cards/additional/statements.md) - [Sandbox](https://apidocs.bridge.xyz/platform/cards/sandbox/sandbox.md): Test your card integration using the Stripe Sandbox and Bridge sandbox environment - [Create and test your first card](https://apidocs.bridge.xyz/platform/cards/overview/guide.md) - [Terminology](https://apidocs.bridge.xyz/platform/cards/overview/terminology.md) - [Advanced money movement flows](https://apidocs.bridge.xyz/platform/cards/overview/advanced.md) - [Testing webhooks in sandbox](https://apidocs.bridge.xyz/platform/cards/sandbox/testing.md) - [Freezing a card account](https://apidocs.bridge.xyz/platform/cards/additional/freezing.md) - [Managing PINs](https://apidocs.bridge.xyz/platform/cards/additional/pins.md) - [Customizing card art](https://apidocs.bridge.xyz/platform/cards/additional/customizing.md) - [Marketing, UX and compliance](https://apidocs.bridge.xyz/platform/cards/additional/marketing.md) - [In-app mobile wallet provisioning](https://apidocs.bridge.xyz/platform/cards/additional/mobile-wallet-provisioning.md) - [Safely reveal card details to customers](https://apidocs.bridge.xyz/platform/cards/additional/safely-reveal-card-details.md) - [Real-time Authorization](https://apidocs.bridge.xyz/platform/cards/additional/real-time-auth.md): Make real-time authorization decisions for card transactions - [Fees](https://apidocs.bridge.xyz/platform/cards/additional/fees.md): Configure fees on card transactions to generate additional revenue - [Overview](https://apidocs.bridge.xyz/platform/customers/overview.md) - [Customers API](https://apidocs.bridge.xyz/platform/customers/customers/api.md) - [KYC links for new customers](https://apidocs.bridge.xyz/platform/customers/customers/kyclinks.md) - [Additional requirements for existing customers](https://apidocs.bridge.xyz/platform/customers/customers/add_req.md) - [Endorsements](https://apidocs.bridge.xyz/platform/customers/customers/endorsements.md) - [Terms of service](https://apidocs.bridge.xyz/platform/customers/customers/tos.md) - [Rejection reasons](https://apidocs.bridge.xyz/platform/customers/customers/rejection_reasons.md) - [Missing requirements and issues](https://apidocs.bridge.xyz/platform/customers/customers/missing-requirements-and-issues.md) - [BRL Ramp Migration Guide](https://apidocs.bridge.xyz/platform/customers/customers/brl-ramp-migration-guide.md): Migrate existing BRL customers to comply with new Brazilian Central Bank regulations - [Postal code validation](https://apidocs.bridge.xyz/platform/customers/customers/postal-code-validation.md) - [Individuals](https://apidocs.bridge.xyz/platform/customers/compliance/individuals.md) - [Businesses](https://apidocs.bridge.xyz/platform/customers/compliance/businesses/overview.md): To onboard a business, Bridge is required to collect and verify information about the business and its ownership. - [Business entity types](https://apidocs.bridge.xyz/platform/customers/compliance/businesses/entity.md) - [Business ownership documents](https://apidocs.bridge.xyz/platform/customers/compliance/businesses/ownership.md) - [Business formation documents](https://apidocs.bridge.xyz/platform/customers/compliance/businesses/formation.md) - [Business identification numbers by region](https://apidocs.bridge.xyz/platform/customers/compliance/businesses/identification.md): The following lists identification numbers that Bridge will accept for businesses by region. - [High risk business activities](https://apidocs.bridge.xyz/platform/customers/compliance/businesses/highrisk.md) - [DAOs](https://apidocs.bridge.xyz/platform/customers/compliance/dao.md) - [Supported documents](https://apidocs.bridge.xyz/platform/customers/compliance/docs.md) - [Proof of address requirements](https://apidocs.bridge.xyz/platform/customers/compliance/poa.md) - [Supported Countries List](https://apidocs.bridge.xyz/platform/customers/compliance/supported-countries-list.md): This supported country list covers businesses and individuals residing in these countries. - [Developer fees](https://apidocs.bridge.xyz/platform/orchestration/fees-and-mins/devfees.md) - [Transaction minimums](https://apidocs.bridge.xyz/platform/orchestration/fees-and-mins/mins.md) - [Processing windows & cutoff times](https://apidocs.bridge.xyz/platform/orchestration/more/cutoffs.md) - [Holidays](https://apidocs.bridge.xyz/platform/orchestration/more/holidays.md): 📅 Holiday Table: 2026–2027 - [Payment tracking identifiers](https://apidocs.bridge.xyz/platform/orchestration/more/payment-tracking.md) - [Rail specific details](https://apidocs.bridge.xyz/platform/orchestration/more/rail-specific.md) - [Precision and rounding](https://apidocs.bridge.xyz/platform/additional-information/precision.md) - [Receipts](https://apidocs.bridge.xyz/platform/additional-information/receipts.md) - [Webhooks](https://apidocs.bridge.xyz/platform/additional-information/webhooks/overview.md) - [Webhook event signature verification](https://apidocs.bridge.xyz/platform/additional-information/webhooks/signature.md) - [Event structure](https://apidocs.bridge.xyz/platform/additional-information/webhooks/structure.md) - [FAQ guidance for your users](https://apidocs.bridge.xyz/platform/additional-information/faq.md) - [Pricing](https://apidocs.bridge.xyz/platform/additional-information/pricing.md) - [Authentication](https://apidocs.bridge.xyz/api-reference/introduction/introduction.md) - [Idempotency](https://apidocs.bridge.xyz/api-reference/introduction/idempotence.md) - [Deprecation](https://apidocs.bridge.xyz/api-reference/introduction/deprecation.md) - [Postman collection](https://apidocs.bridge.xyz/api-reference/introduction/postman.md) - [Bridge API Pagination Guide](https://apidocs.bridge.xyz/api-reference/pagination.md): This page describes how to paginate any Bridge “list” endpoint using cursor-based pagination. It applies across resources (transactions, deposits, payouts, etc.), not just a single API. - [Get all Bridge Wallets](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets.md): List of Bridge Wallets - [Get total balances of all Bridge Wallets](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets.md): Get the total balances of all Bridge Wallets - [Get a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet.md): Retrieve a Bridge Wallet by its ID - [Get transaction history for a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet.md): Get the list of transactions involving this Bridge Wallet - [Get all Bridge Wallets for a customer](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer.md): List of Bridge Wallets for the specified Customer ID - [Create a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet.md) - [Get a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1.md): Retrieve a Bridge Wallet for the specified Bridge Wallet ID - [Get all customers](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers.md): Get the full list of all customers created on Bridge - [Create a customer](https://apidocs.bridge.xyz/api-reference/customers/create-a-customer.md) - [Get a single customer object](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object.md): Retrieve a customer object from the passed in customer ID - [Update a single customer object](https://apidocs.bridge.xyz/api-reference/customers/update-a-single-customer-object.md): Updates to be made to the specified customer. - [Delete a single customer object](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object.md): Delete a customer object from the passed in customer ID - [Get associated persons for a business customer](https://apidocs.bridge.xyz/api-reference/customers/get-associated-persons-for-a-business-customer.md): Get all associated persons for a business customer. - [Create a new associated person for a business customer](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer.md) - [Get a single associated person](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person.md): Retrieve an associated person by ID - [Update a single associated person](https://apidocs.bridge.xyz/api-reference/customers/update-a-single-associated-person.md) - [Delete a single associated person](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person.md): Delete an associated person by ID - [Retrieve a hosted URL for ToS acceptance for an existing customer](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer.md): The page at the returned URL will guide the user through the Bridge Terms of Service (ToS) acceptance flow. This can be used by existing customers to accept a new version of the ToS. - [Retrieve a hosted KYC Link for an existing customer](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer.md): The page at the returned URL will guide the user through a Bridge KYC flow. This can be used by existing customers to provide additional KYC information required for certain features or services that Bridge offers. - [Get all transfers](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers.md): Get all active and completed transfers for a customer. - [Get all static templates for a customer](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer.md): Get all static templates for a customer. Static templates are transfers that are used as templates for other transfers and can be created using the static_templates feature flag. - [Request a hosted URL for ToS acceptance for new customer creation](https://apidocs.bridge.xyz/api-reference/customers/request-a-hosted-url-for-tos-acceptance-for-new-customer-creation.md): The URL endpoint returned will guide the user through a Bridge TOS flow. Signing this acceptance flow is a requirement for creating customers. - [Get all External Accounts](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts.md): Get all External Accounts for a passed in customer. - [Create a new External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/create-a-new-external-account.md): _Note_: If adding US external accounts, we recommend reading through the US Beneficiary Address Validation doc ([link](https://apidocs.bridge.xyz/docs/us-beneficiary-address-validation)) to avoid issues related to incorrect addresses. - [Retrieve an External Account object](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object.md): Retrieve an External Account object (banks, debit cards etc) from the passed in customer ID and External Account ID - [Update an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account.md) - [Delete a single External Account object](https://apidocs.bridge.xyz/api-reference/external-accounts/delete-a-single-external-account-object.md): Delete an External Account object from the passed in External Account ID - [Deactivate an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-an-external-account.md): Deactivate an active External Account. The External Account is preserved and can be reactivated later via the reactivate endpoint. - [Verify an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/verify-an-external-account.md): Trigger a verification check for an external account. Verifies that the `account_owner_name` matches the actual account holder at the receiving bank. - [Reactivate an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account.md): Reactivate a previously deactivated External Account - [Get all External Accounts](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1.md): Get all External Accounts. - [Get the fiat payout configuration for a customer](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/get-the-fiat-payout-configuration-for-a-customer.md): Retrieve the fiat payout configuration for the given customer ID. This configuration determines which payout method (bridge, developer, payment_provider, or customer) is used for each currency and payment rail combination. - [Update the fiat payout configuration for a customer](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer.md): Update the fiat payout configuration for the given customer ID. This configuration determines which payout method (bridge, developer, payment_provider, or customer) is used for each currency and payment rail combination. - [Generate a Plaid Link token for a customer](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer.md) - [Exchange Plaid public token for an access token](https://apidocs.bridge.xyz/api-reference/plaid/exchange-plaid-public-token-for-an-access-token.md) - [Get all transfers](https://apidocs.bridge.xyz/api-reference/transfers/get-all-transfers.md) - [Create a transfer](https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer.md): Create a transfer. - [List transfers with pending USDT trades](https://apidocs.bridge.xyz/api-reference/transfers/list-transfers-with-pending-usdt-trades.md): Returns transfers that have a stuck USDT-to-USD trade awaiting execution. Results are sorted by creation time (newest first) and paginated. - [Get a transfer](https://apidocs.bridge.xyz/api-reference/transfers/get-a-transfer.md): Retrieve a transfer object from the passed in transfer ID - [Update a transfer](https://apidocs.bridge.xyz/api-reference/transfers/update-a-transfer.md): Update a transfer that was previously created. Must be in the awaiting_funds state. - [Delete a transfer](https://apidocs.bridge.xyz/api-reference/transfers/delete-a-transfer.md): Delete a transfer that was previously created. Must be in the awaiting_funds state. - [Execute a pending USDT trade on a transfer](https://apidocs.bridge.xyz/api-reference/transfers/execute-a-pending-usdt-trade-on-a-transfer.md): Force-executes a stuck USDT-to-USD trade at the current market rate. The transfer must have a pending trade (i.e. appear in `GET /transfers/pending`). - [Get all static templates](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates.md) - [Get a list of all Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account.md): Retrieve a all Prefunded Accounts - [Get details for a specific Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account.md): Retrieve a Prefunded Account - [Get funding history of a Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account.md): Retrieve the funding events and returns for a Prefunded Account - [Get all Liquidation Addresses for a customer](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer.md): Get Liquidation Addresses - [Create a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address.md) - [Get all Liquidation Addresses](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses.md): Get Liquidation Addresses - [Get a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address.md): Retrieve a Liquidation Address for the specified Liquidation Address ID - [Update a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address.md): Update a Liquidation Address for the specified liquidation address ID. Fields (`external_account_id`, `custom_developer_fee_percent`, `destination`) can be updated independently and are not all required. - [Get drain history of a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address.md): Get drain history of a Liquidation Address - [Execute a pending USDT trade on a drain](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/execute-a-pending-usdt-trade-on-a-drain.md): Force-executes a stuck USDT-to-USD trade at the current market rate. The drain must have a pending trade (i.e. appear in `GET /liquidation_addresses/drains/pending`). - [Get the balance of a Liquidation Address (deprecated)](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated.md): Get the balance of a Liquidation Address. Note that most Liquidation Addresses no longer hold a balance. To check recent activity on a Liquidation Address, use the `/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains` endpoint. - [Liquidation Address Activity Across All Customers](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers.md): History of activity across all customers and Liquidation Addresses - [List drains with pending USDT trades](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/list-drains-with-pending-usdt-trades.md): Returns drains that have a stuck USDT-to-USD trade awaiting execution. Results are sorted by creation time (newest first) and paginated. - [List Virtual Accounts by Customer](https://apidocs.bridge.xyz/api-reference/virtual-accounts/list-virtual-accounts-by-customer.md): List all Virtual Account objects for a customer - [Create a Virtual Account](https://apidocs.bridge.xyz/api-reference/virtual-accounts/create-a-virtual-account.md): Create a Virtual Account or Virtual IBAN for the specified customer - [Get a Virtual Account](https://apidocs.bridge.xyz/api-reference/virtual-accounts/get-a-virtual-account.md): Retrieve the Virtual Account object from the passed ID - [Update a Virtual Account](https://apidocs.bridge.xyz/api-reference/virtual-accounts/update-a-virtual-account.md): Update instructions for an existing Virtual Account - [Deactivate a Virtual Account](https://apidocs.bridge.xyz/api-reference/virtual-accounts/deactivate-a-virtual-account.md): Deactivate a Virtual Account to prevent it from acceping new incoming transactions - [Reactivate a Virtual Account](https://apidocs.bridge.xyz/api-reference/virtual-accounts/reactivate-a-virtual-account.md): Reactivate a previously deactivated Virtual Account - [Virtual Account Activity](https://apidocs.bridge.xyz/api-reference/virtual-accounts/virtual-account-activity.md): History of activity for a Virtual Account - [List Virtual Accounts](https://apidocs.bridge.xyz/api-reference/virtual-accounts/list-virtual-accounts.md): List all Virtual Account objects - [Virtual Account Activity Across All Customers](https://apidocs.bridge.xyz/api-reference/virtual-accounts/virtual-account-activity-across-all-customers.md): History of activity across all customers and Virtual Accounts - [List Static Memos](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos.md): List all Static Memo objects - [List Static Memos for Customer](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer.md): List all Static Memo objects for a customer - [Create a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo.md): Create a Static Memo for the specified customer - [Get a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo.md): Retrieve the Static Memo object from the passed ID - [Update a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo.md): Update instructions for an existing Static Memo - [Static Memo Activity](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity.md): History of activity for a Static Memo - [Static Memo Activity Across All Customers](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity-across-all-customers.md): History of activity across all customers and Virtual Accounts - [Create Card PIN Update URL](https://apidocs.bridge.xyz/api-reference/cards/create-card-pin-update-url.md): Generates a URL that can be used to render a secure frame to update the PIN for a card account. The URL is single-use and time-limited. - [Generate an Ephemeral Key to Reveal Card Details](https://apidocs.bridge.xyz/api-reference/cards/generate-an-ephemeral-key-to-reveal-card-details.md): Generates a one-time ephemeral key that can be used to reveal card details. Please see the integration guide on [safely revealing card details](https://apidocs.bridge.xyz/docs/safely-reveal-card-details-to-customers) for more information. - [Get a summary of your card program](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program.md): Get a summary of your card program, optionally for a specific period. - [Get a listing of your card program's card designs](https://apidocs.bridge.xyz/api-reference/cards/get-a-listing-of-your-card-programs-card-designs.md): Get a listing of the designs that you can use to issue a card with. - [Retrieve a card account](https://apidocs.bridge.xyz/api-reference/cards/retrieve-a-card-account.md): Retrieve the card account with the specified ID - [Update a card account](https://apidocs.bridge.xyz/api-reference/cards/update-a-card-account.md): Update a card account. Supports changing the settlement currency or closing a card account by setting the status to "inactive". Closing permanently cancels all associated cards and is irreversible. - [Get all card accounts](https://apidocs.bridge.xyz/api-reference/cards/get-all-card-accounts.md): Retrieve all card accounts for a customer. Currently, only one account is supported. An empty array will be returned if no card has been provisioned - [Provision a card account](https://apidocs.bridge.xyz/api-reference/cards/provision-a-card-account.md): Provision a card account. NOTE: the legacy Bridge Cards API is deprecated, and stablecoin card issuing capabilities are now natively integrated into Stripe Issuing. Please see [this guide](https://apidocs.bridge.xyz/platform/cards/overview/stripe-issuing) for more details on how to enable your accou… - [Place a freeze on the card account](https://apidocs.bridge.xyz/api-reference/cards/place-a-freeze-on-the-card-account.md): Place a freeze on the card account - [Unfreeze the card account](https://apidocs.bridge.xyz/api-reference/cards/unfreeze-the-card-account.md): Remove the freeze on the card account placed by the specified initiator - [Create a mobile wallet push provisioning request](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request.md): Create a request to push-provision a virtual card to a mobile wallet. This endpoint is part of a multiple-step integration that must be completed with each mobile wallet partner - [Retrieve pending card authorizations](https://apidocs.bridge.xyz/api-reference/cards/retrieve-pending-card-authorizations.md): Retrieve pending card authorizations. Note: this endpoint is not paginated - [Retrieve card transactions](https://apidocs.bridge.xyz/api-reference/cards/retrieve-card-transactions.md): Retrieve completed card transactions and card-related crypto transaction activities - [Retrieve a card transaction](https://apidocs.bridge.xyz/api-reference/cards/retrieve-a-card-transaction.md): Retrieve a card transaction with the specified ID - [Retrieve authorization controls](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls.md): Retrieve the applicable spend limits for the given card account - [Provision an additional top-up deposit address for the card account](https://apidocs.bridge.xyz/api-reference/cards/provision-an-additional-top-up-deposit-address-for-the-card-account.md): Provision an additional deposit address for the card account, to allow topping up the card from multiple chains. This is only applicable to Bridge-custodied top-up card accounts. These additional deposit addresses will also be shown in the `additional_funding_instructions` field when fetching the ca… - [Retrieve the withdrawal history of funds](https://apidocs.bridge.xyz/api-reference/cards/retrieve-the-withdrawal-history-of-funds.md): Retrieve the withdrawal history of funds, applicable to top-up accounts only - [Create a funds withdrawal request](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request.md): Request a funds withdrawal from the card account, applicable to top-up accounts only. For Bridge wallets, create a [transfer](/api-reference/transfers/create-a-transfer) from the Bridge wallet. - [Retrieve a card withdrawal](https://apidocs.bridge.xyz/api-reference/cards/retrieve-a-card-withdrawal.md): Retrieve a card withdrawal with the specified ID, applicable to top-up accounts only - [Generate a card account statement](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-account-statement.md): Generate a card account statement for the specified period - [Generate a card statement using Stripe IDs](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids.md): Generate a card account statement for the specified period, using Stripe cardholder and card IDs instead of Bridge internal IDs - [Create a Batch Settlement Schedule](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule.md): Creates a Batch Settlement Schedule that can be used as the destination of a liquidation address. - [Get the configured fees](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fees.md): Get fees that have been configured for supported products. - [Update the configured fees](https://apidocs.bridge.xyz/api-reference/developers/update-the-configured-fees.md): Update fees for supported products. - [Get the configured fee External Account](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account.md): Get the configured fee External Account. - [Configure a fee External Account](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account.md): Configure a fee External Account. - [Create a scoped API key](https://apidocs.bridge.xyz/api-reference/api-keys/create-a-scoped-api-key.md): Create a new API key restricted to a subset of scopes. The returned `value` is the only opportunity to retrieve the plaintext secret — store it securely. This endpoint does not accept an `Idempotency-Key` header; each call creates a new key. - [Describe the calling API key](https://apidocs.bridge.xyz/api-reference/api-keys/describe-the-calling-api-key.md): Return metadata about the API key authenticating this request, including its scopes. The plaintext secret is never returned. - [Get all KYC links.](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links.md): Retrieve the full list of kyc links. - [Generate the Links needs to complete KYC for an individual or business](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business.md) - [Check the status of a KYC link](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link.md): Retrieve the status of a KYC request from the passed in KYC link id - [Get all RFIs](https://apidocs.bridge.xyz/api-reference/rfis/get-all-rfis.md): Retrieve a list of requests for information (RFIs) raised against your developer or customer accounts - [Get an RFI](https://apidocs.bridge.xyz/api-reference/rfis/get-an-rfi.md): Retrieve a single request for information (RFI) by id - [Get all funds requests](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests.md): Retrieve a list of all funds requests submitted by partnered banks and financial institutions - [Get all webhook endpoints](https://apidocs.bridge.xyz/api-reference/webhooks/get-all-webhook-endpoints.md): Get the full list of active and disabled webhook endpoints configured on Bridge - [Create a webhook endpoint](https://apidocs.bridge.xyz/api-reference/webhooks/create-a-webhook-endpoint.md): Create a new webhook endpoint to receive events from Bridge. Webhook endpoints begin in a disabled state and can be enabled with a PUT request. A maximum of 5 webhooks can be active or disabled at one time. Webhook endpoints can be created in Sandbox, but no webhook events will be sent. - [Update a webhook](https://apidocs.bridge.xyz/api-reference/webhooks/update-a-webhook.md): Update the specified webhook object - [Delete a webhook](https://apidocs.bridge.xyz/api-reference/webhooks/delete-a-webhook.md): Delete the specified webhook object. This webhook will no longer be accessible via API. - [List upcoming events](https://apidocs.bridge.xyz/api-reference/webhooks/list-upcoming-events.md): List the next 10 events that will be delivered to the specified webhook. - [View logs](https://apidocs.bridge.xyz/api-reference/webhooks/view-logs.md): Display the most recent logs for deliveries to the specified webhook. - [Send event](https://apidocs.bridge.xyz/api-reference/webhooks/send-event.md): Send an event to the specified webhook endpoint. This will not effect other events in the delivery queue. This operation is possible for both active and disabled webhook endpoints. - [List webhook events](https://apidocs.bridge.xyz/api-reference/webhooks/list-webhook-events.md): List all webhook events for your account. Events are ordered by their event_sequence in ascending order. Results are limited to the events created in last 90 days. - [Get a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person.md): Retrieve an associated person by ID - [Update a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person.md) - [Delete a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person.md): Delete an associated person by ID - [Submit travel rule data.](https://apidocs.bridge.xyz/api-reference/travel-rule/submit-travel-rule-data.md): Use this endpoint to submit originator, beneficiary, and transfer purpose data for travel rule compliance. - [Get current exchange rate between two currencies.](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies.md): Returns the current exchange rate from the "from" currency to the "to" currency. The exchange rate is updated roughly every 30s. Note that as of this writing, Bridge does not offer a "quote" by which a user can lock in a rate for a given amount of time. This is provided only as a courtesy to estimat… - [Get occupation codes](https://apidocs.bridge.xyz/api-reference/lists/get-occupation-codes.md): Provide this list of occupation codes to your users as possible answers to the Source of Funds section in the KYC flow. The returned list will resemble the list of occupation codes found [here](https://apidocs.bridge.xyz/page/sof-eu-most-recent-occupation-list). - [Get countries](https://apidocs.bridge.xyz/api-reference/lists/get-countries.md): Returns a list of countries and subdivisions recognized by Bridge. Inclusion in this list does not guarantee Bridge product support for any country or subdivision. - [Get all crypto return policies](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies.md): Retrieve all crypto return policies for the authenticated developer - [Create a new crypto return policy](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy.md) - [Update an existing crypto return policy](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy.md) - [Delete a single crypto return policy object](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object.md): Delete a crypto return policy object from the passed in crypto return policy ID - [Get a summary of all rewards for a given stablecoin](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin.md): Get a summary of all rewards for a given stablecoin - [Get daily reward history for a stablecoin](https://apidocs.bridge.xyz/api-reference/rewards/get-daily-reward-history-for-a-stablecoin.md): Returns paginated daily reward records with per-provider breakdowns, AUM, fees, and distribution status. Data is calculated with a t-2 business day lag; the most recent available record corresponds to two business days prior to the current date. - [Get a summary of a customer's rewards](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards.md): Get a summary of a customer's rewards - [Get a history of a customer's rewards](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards.md): Get a history of a customer's rewards. Data is calculated with a t-2 business day lag; the most recent available record corresponds to two business days prior to the current date. - [Simulate KYC approval (sandbox only)](https://apidocs.bridge.xyz/api-reference/sandbox/simulate-kyc-approval-sandbox-only.md): Simulates a KYC/KYB approval for a customer in the sandbox environment. This endpoint is not available in production. - [Changelog](https://apidocs.bridge.xyz/changelog/changelog.md) ## OpenAPI Specs - [latest](https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json)