# Table of Contents - [Welcome - Bridge](#welcome-bridge) - [Get a single associated person - Bridge](#get-a-single-associated-person-bridge) - [Delete a single associated person - Bridge](#delete-a-single-associated-person-bridge) - [Create a Batch Settlement Schedule - Bridge](#create-a-batch-settlement-schedule-bridge) - [Update a single associated person - Bridge](#update-a-single-associated-person-bridge) - [Create a Bridge Wallet - Bridge](#create-a-bridge-wallet-bridge) - [Get a Bridge Wallet - Bridge](#get-a-bridge-wallet-bridge) - [Get a Bridge Wallet - Bridge](#get-a-bridge-wallet-bridge) - [Get all Bridge Wallets for a customer - Bridge](#get-all-bridge-wallets-for-a-customer-bridge) - [Get total balances of all Bridge Wallets - Bridge](#get-total-balances-of-all-bridge-wallets-bridge) - [Get all Bridge Wallets - Bridge](#get-all-bridge-wallets-bridge) - [Get transaction history for a Bridge Wallet - Bridge](#get-transaction-history-for-a-bridge-wallet-bridge) - [Postman collection - Bridge](#postman-collection-bridge) - [Update an existing crypto return policy - Bridge](#update-an-existing-crypto-return-policy-bridge) - [Authentication - Bridge](#authentication-bridge) - [Create a new crypto return policy - Bridge](#create-a-new-crypto-return-policy-bridge) - [Idempotency - Bridge](#idempotency-bridge) - [Delete a single crypto return policy object - Bridge](#delete-a-single-crypto-return-policy-object-bridge) - [Get all crypto return policies - Bridge](#get-all-crypto-return-policies-bridge) - [Get current exchange rate between two currencies. - Bridge](#get-current-exchange-rate-between-two-currencies-bridge) - [Update the configured fees - Bridge](#update-the-configured-fees-bridge) - [Get the configured fees - Bridge](#get-the-configured-fees-bridge) - [Get the fiat payout configuration for a customer - Bridge](#get-the-fiat-payout-configuration-for-a-customer-bridge) - [Get all funds requests - Bridge](#get-all-funds-requests-bridge) - [Bridge API Pagination Guide - Bridge](#bridge-api-pagination-guide-bridge) - [Get the configured fee External Account - Bridge](#get-the-configured-fee-external-account-bridge) - [Get all KYC links. - Bridge](#get-all-kyc-links-bridge) - [Get countries - Bridge](#get-countries-bridge) - [Update the fiat payout configuration for a customer - Bridge](#update-the-fiat-payout-configuration-for-a-customer-bridge) - [Exchange Plaid public token for an access token - Bridge](#exchange-plaid-public-token-for-an-access-token-bridge) - [Check the status of a KYC link - Bridge](#check-the-status-of-a-kyc-link-bridge) - [Generate the Links needs to complete KYC for an individual or business - Bridge](#generate-the-links-needs-to-complete-kyc-for-an-individual-or-business-bridge) - [Index - Bridge](#index-bridge) - [Configure a fee External Account - Bridge](#configure-a-fee-external-account-bridge) - [Generate a Plaid Link token for a customer - Bridge](#generate-a-plaid-link-token-for-a-customer-bridge) - [Get details for a specific Prefunded Account - Bridge](#get-details-for-a-specific-prefunded-account-bridge) - [Get a list of all Prefunded Account - Bridge](#get-a-list-of-all-prefunded-account-bridge) - [Get a summary of a customer's rewards - Bridge](#get-a-summary-of-a-customer-s-rewards-bridge) - [Generate a card account statement - Bridge](#generate-a-card-account-statement-bridge) - [Get a history of a customer's rewards - Bridge](#get-a-history-of-a-customer-s-rewards-bridge) - [Create Card PIN Update URL - Bridge](#create-card-pin-update-url-bridge) - [Cards - Bridge](#cards-bridge) - [Geographies - Bridge](#geographies-bridge) - [Get all External Accounts - Bridge](#get-all-external-accounts-bridge) - [Reactivate an External Account - Bridge](#reactivate-an-external-account-bridge) - [Get a summary of all rewards for a given stablecoin - Bridge](#get-a-summary-of-all-rewards-for-a-given-stablecoin-bridge) - [Get all External Accounts - Bridge](#get-all-external-accounts-bridge) - [Get the balance of a Liquidation Address (deprecated) - Bridge](#get-the-balance-of-a-liquidation-address-deprecated-bridge) - [Get all Liquidation Addresses - Bridge](#get-all-liquidation-addresses-bridge) - [Deactivate a single External Account object - Bridge](#deactivate-a-single-external-account-object-bridge) - [Retrieve an External Account object - Bridge](#retrieve-an-external-account-object-bridge) - [Get occupation codes - Bridge](#get-occupation-codes-bridge) - [Create a mobile wallet push provisioning request - Bridge](#create-a-mobile-wallet-push-provisioning-request-bridge) - [Get drain history of a Liquidation Address - Bridge](#get-drain-history-of-a-liquidation-address-bridge) - [Get funding history of a Prefunded Account - Bridge](#get-funding-history-of-a-prefunded-account-bridge) - [Liquidation Address Activity Across All Customers - Bridge](#liquidation-address-activity-across-all-customers-bridge) - [Get a Liquidation Address - Bridge](#get-a-liquidation-address-bridge) - [Get all Liquidation Addresses for a customer - Bridge](#get-all-liquidation-addresses-for-a-customer-bridge) - [Get set up with Bridge - Bridge](#get-set-up-with-bridge-bridge) - [Update an External Account - Bridge](#update-an-external-account-bridge) - [Custodial wallets - Bridge](#custodial-wallets-bridge) - [Create a funds withdrawal request - Bridge](#create-a-funds-withdrawal-request-bridge) - [Create a Liquidation Address - Bridge](#create-a-liquidation-address-bridge) - [Supported blockchains and fiat rails - Bridge](#supported-blockchains-and-fiat-rails-bridge) - [Update a Liquidation Address - Bridge](#update-a-liquidation-address-bridge) - [Send fiat deposits to your wallet - Bridge](#send-fiat-deposits-to-your-wallet-bridge) - [Get associated persons for a business customer - Bridge](#get-associated-persons-for-a-business-customer-bridge) - [Delete a single associated person - Bridge](#delete-a-single-associated-person-bridge) - [Platform overview - Bridge](#platform-overview-bridge) - [Get a single associated person - Bridge](#get-a-single-associated-person-bridge) - [Get all static templates for a customer - Bridge](#get-all-static-templates-for-a-customer-bridge) - [Get all customers - Bridge](#get-all-customers-bridge) - [Retrieve a hosted URL for ToS acceptance for an existing customer - Bridge](#retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer-bridge) - [Get a Static Memo - Bridge](#get-a-static-memo-bridge) - [Delete a transfer - Bridge](#delete-a-transfer-bridge) - [Set up a sandbox environment - Bridge](#set-up-a-sandbox-environment-bridge) - [Get a single customer object - Bridge](#get-a-single-customer-object-bridge) - [Retrieve a hosted KYC Link for an existing customer - Bridge](#retrieve-a-hosted-kyc-link-for-an-existing-customer-bridge) - [Delete a single customer object - Bridge](#delete-a-single-customer-object-bridge) - [Send wallet funds to a crypto address - Bridge](#send-wallet-funds-to-a-crypto-address-bridge) - [Request a hosted URL for ToS acceptance for new customer creation - Bridge](#request-a-hosted-url-for-tos-acceptance-for-new-customer-creation-bridge) - [List Static Memos for Customer - Bridge](#list-static-memos-for-customer-bridge) - [Spend wallet balances using a card - Bridge](#spend-wallet-balances-using-a-card-bridge) - [Create a new associated person for a business customer - Bridge](#create-a-new-associated-person-for-a-business-customer-bridge) - [Create a Static Memo - Bridge](#create-a-static-memo-bridge) - [Static Memo Activity - Bridge](#static-memo-activity-bridge) - [Get a listing of your card program's card designs - Bridge](#get-a-listing-of-your-card-program-s-card-designs-bridge) - [List Static Memos - Bridge](#list-static-memos-bridge) - [Get all static templates - Bridge](#get-all-static-templates-bridge) - [Update a Static Memo - Bridge](#update-a-static-memo-bridge) - [Generate a card statement using Stripe IDs - Bridge](#generate-a-card-statement-using-stripe-ids-bridge) - [Get a summary of your card program - Bridge](#get-a-summary-of-your-card-program-bridge) - [Retrieve authorization controls - Bridge](#retrieve-authorization-controls-bridge) - [Get all transfers - Bridge](#get-all-transfers-bridge) - [Payroll - Bridge](#payroll-bridge) --- # Welcome - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/introduction/overview#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... Ctrl KAsk AI Search... Navigation Get started Welcome [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) [​](https://apidocs.bridge.xyz/get-started/introduction/overview#introduction) Introduction ---------------------------------------------------------------------------------------------- Welcome to **Bridge**, the seamless way to integrate stablecoin payments into your product. Bridge lets you move money with internet speed and global reach — across fiat rails and stablecoins. Whether you’re building global payment flows, launching a card product, or managing wallets, Bridge offers a composable set of APIs to power seamless money movement. This guide is designed to help you navigate our APIs, avoid common integration pitfalls, and get to market faster. [​](https://apidocs.bridge.xyz/get-started/introduction/overview#what-you-can-build-with-bridge) What you can build with Bridge ---------------------------------------------------------------------------------------------------------------------------------- * **Send & receive payments** Move funds globally using fiat rails, stablecoins, or supported digital assets. * **Virtual accounts** Instantly issue USD, EUR, and MXN deposit accounts for your users with local bank details. * **Custody funds** Provision custodial wallets to hold stablecoin balances securely. * **Issue stablecoins** Launch your own branded stablecoin or use USDB to earn rewards on held balances. * **Issue cards** Enable users to spend from their stablecoin balances with Visa-powered virtual cards. * * * [​](https://apidocs.bridge.xyz/get-started/introduction/overview#get-started) Get started -------------------------------------------------------------------------------------------- Here’s a quick guide to help you find what you need: [Get started\ -----------\ \ Get up and running with our API in minutes.](https://apidocs.bridge.xyz/get-started/introduction/quick-start/get-set-up-with-bridge) [Guides\ ------\ \ Explore starter core use cases for moving money using orchestration, wallets, cards, and more.](https://apidocs.bridge.xyz/get-started/guides) [Developer Platform\ ------------------\ \ More detailed documentation on the developer platform.](https://apidocs.bridge.xyz/platform) [API Reference\ -------------\ \ Detailed endpoint documentation with request/response schemas.](https://apidocs.bridge.xyz/api-reference) [Changelog\ ---------\ \ Read more about recent feature improvements and launches.](https://apidocs.bridge.xyz/changelog) [​](https://apidocs.bridge.xyz/get-started/introduction/overview#key-platform-components) Key platform components -------------------------------------------------------------------------------------------------------------------- The Bridge developer platform includes flexible and simple APIs to power your use cases. [Customers\ ---------\ \ Easily onboard users with KYC/KYB flows and manage identity lifecycle.](https://apidocs.bridge.xyz/platform/customers) [Orchestration\ -------------\ \ APIs to send, receive, and convert between fiat and stablecoins. Power on ramps, off ramps, and crypto to crypto payments using transfers.](https://apidocs.bridge.xyz/platform/orchestration) [Wallets\ -------\ \ Custody funds for your customers or your company, initiate transfers, and check balances with secure custodial wallets.](https://apidocs.bridge.xyz/platform/wallets) [Issuance\ --------\ \ Launch your own branded stablecoin and earn on-chain rewards on balances held in Bridge-issued stablecoins.](https://apidocs.bridge.xyz/platform/issuance) [Cards\ -----\ \ Issue branded Visa cards that work online, in-store, and through mobile wallets. Customers can spend directly from stablecoin balances.](https://apidocs.bridge.xyz/platform/cards) [​](https://apidocs.bridge.xyz/get-started/introduction/overview#getting-help) Getting Help ---------------------------------------------------------------------------------------------- We’re excited to have you build with us! If you have questions, run into issues, or just want to say hi, you can contact us at [support@bridge.xyz](mailto:support@bridge.xyz) or visit our [Support Page](https://support.bridge.xyz/) Was this page helpful? YesNo [Platform overview](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview) Ctrl+I Assistant Responses are generated using AI and may contain mistakes. --- # Get a single associated person - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Associated Persons Get a single associated person [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a single associated person cURL curl --request GET \ --url https://api.bridge.xyz/v0/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } GET / associated\_persons / {associatedPersonID} Try it Get a single associated person cURL curl --request GET \ --url https://api.bridge.xyz/v0/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#parameter-associated-person-id) associatedPersonID string required Unique identifier for an associated person A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successful associated person response [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-id) id string required Unique identifier for the associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-created-at) created\_at integer required Created timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-updated-at) updated\_at integer required Last updated timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-email) email string The email address of the associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-first-name) first\_name string The first name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-last-name) last\_name string The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-has-ownership) has\_ownership boolean True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-has-control) has\_control boolean True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-is-signer) is\_signer boolean True if this person is able to authorize transactions on behalf of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-attested-ownership-structure-at) attested\_ownership\_structure\_at string When this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person#response-relationship-established-at) relationship\_established\_at string When the associated person relationship was established in format yyyy-mm-dd. Was this page helpful? YesNo [List webhook events](https://apidocs.bridge.xyz/api-reference/webhooks/list-webhook-events) [Update a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Delete a single associated person - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Associated Persons Delete a single associated person [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Delete a single associated person cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } DELETE / associated\_persons / {associatedPersonID} Try it Delete a single associated person cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#parameter-associated-person-id) associatedPersonID string required Unique identifier for an associated person A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successfully deleted associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-id) id string required Unique identifier for the associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-created-at) created\_at integer required Created timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-updated-at) updated\_at integer required Last updated timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-email) email string The email address of the associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-first-name) first\_name string The first name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-last-name) last\_name string The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-has-ownership) has\_ownership boolean True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-has-control) has\_control boolean True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-is-signer) is\_signer boolean True if this person is able to authorize transactions on behalf of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-attested-ownership-structure-at) attested\_ownership\_structure\_at string When this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person#response-relationship-established-at) relationship\_established\_at string When the associated person relationship was established in format yyyy-mm-dd. Was this page helpful? YesNo [Update a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person) [Get current exchange rate between two currencies.](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a Batch Settlement Schedule - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Batch Settlements Create a Batch Settlement Schedule [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a Batch Settlement Schedule cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/batch_settlement_schedules \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "destination": { "currency": "brl", "payment_rail": "ach", "external_account_id": "", "bridge_wallet_id": "", "wire_message": "", "sepa_reference": "", "swift_reference": "", "spei_reference": "", "reference": "", "swift_charges": "our", "ach_reference": "", "blockchain_memo": "", "deposit_id": "" } } ' 200 Example { "id": "" } POST / customers / {customerID} / batch\_settlement\_schedules Try it Create a Batch Settlement Schedule cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/batch_settlement_schedules \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "destination": { "currency": "brl", "payment_rail": "ach", "external_account_id": "", "bridge_wallet_id": "", "wire_message": "", "sepa_reference": "", "swift_reference": "", "spei_reference": "", "reference": "", "swift_charges": "our", "ach_reference": "", "blockchain_memo": "", "deposit_id": "" } } ' 200 Example { "id": "" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json [​](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule#body-destination) destination object required The destination that Bridge will use to settle funds. Show child attributes #### Response 200 application/json Batch Settlement Schedule object created [​](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule#response-id) id string required ID of the batch settlement schedule Required string length: `1 - 42` Pattern: `[a-z0-9]*` Was this page helpful? YesNo [Generate a card statement using Stripe IDs](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids) [Get the configured fees](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fees) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Update a single associated person - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Associated Persons Update a single associated person [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Update a single associated person cURL curl --request PUT \ --url https://api.bridge.xyz/v0/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "first_name": "", "last_name": "", "email": "", "residential_address": { "street_line_1": "", "city": "", "country": "", "street_line_2": "", "subdivision": "", "postal_code": "" }, "birth_date": "", "has_ownership": true, "has_control": true, "is_signer": true, "identifying_information": [\ {\ "type": "drivers_license",\ "issuing_country": "",\ "number": "",\ "description": "",\ "expiration": "",\ "image_front": "",\ "image_back": ""\ }\ ], "middle_name": "", "transliterated_first_name": "", "transliterated_middle_name": "", "transliterated_last_name": "", "phone": "", "is_director": true, "title": "", "ownership_percentage": 123, "attested_ownership_structure_at": "", "relationship_established_at": "", "verified_govid_at": "", "verified_selfie_at": "", "completed_customer_safety_check_at": "", "documents": [\ {\ "purposes": [\ "proof_of_account_purpose"\ ],\ "file": "",\ "description": ""\ }\ ] } ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } PUT / associated\_persons / {associatedPersonID} Try it Update a single associated person cURL curl --request PUT \ --url https://api.bridge.xyz/v0/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "first_name": "", "last_name": "", "email": "", "residential_address": { "street_line_1": "", "city": "", "country": "", "street_line_2": "", "subdivision": "", "postal_code": "" }, "birth_date": "", "has_ownership": true, "has_control": true, "is_signer": true, "identifying_information": [\ {\ "type": "drivers_license",\ "issuing_country": "",\ "number": "",\ "description": "",\ "expiration": "",\ "image_front": "",\ "image_back": ""\ }\ ], "middle_name": "", "transliterated_first_name": "", "transliterated_middle_name": "", "transliterated_last_name": "", "phone": "", "is_director": true, "title": "", "ownership_percentage": 123, "attested_ownership_structure_at": "", "relationship_established_at": "", "verified_govid_at": "", "verified_selfie_at": "", "completed_customer_safety_check_at": "", "documents": [\ {\ "purposes": [\ "proof_of_account_purpose"\ ],\ "file": "",\ "description": ""\ }\ ] } ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#parameter-associated-person-id) associatedPersonID string required Unique identifier for an associated person A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json Associated person data to update [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-first-name) first\_name string required The first name of the associated person Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-last-name) last\_name string required The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-email) email string required The persons primary email address Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-residential-address) residential\_address object required The residential address of the associated person. This must be a physical address and cannot be a PO Box. Show child attributes [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-birth-date) birth\_date string required Date of birth in format yyyy-mm-dd. Must be at least 18 years old. Required string length: `10` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-has-ownership) has\_ownership boolean required True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-has-control) has\_control boolean required True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. At least one control person must be specified. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-is-signer) is\_signer boolean required True if this person is able to authorize transactions on behalf of the business. At least one signer must be specified. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-identifying-information) identifying\_information Identification Information · object\[\] required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-middle-name) middle\_name string The middle name of the associated person Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-transliterated-first-name) transliterated\_first\_name string Required when the `first_name` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-transliterated-middle-name) transliterated\_middle\_name string Required when the `middle_name` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-transliterated-last-name) transliterated\_last\_name string Required when the `last_name` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-phone) phone string The persons phone in format "+12223334444" Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-transliterated-residential-address) transliterated\_residential\_address object Required when any part of the `residential_address` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Show child attributes [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-is-director) is\_director boolean True if this person is an appointed director of the company. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. Required if has\_control is true. Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-ownership-percentage) ownership\_percentage integer Ultimate ownership percentage of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-attested-ownership-structure-at) attested\_ownership\_structure\_at string The date or timestamp when this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-relationship-established-at) relationship\_established\_at string The date or timestamp when the associated person relationship was established in format yyyy-mm-dd. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-verified-govid-at) verified\_govid\_at string The date or timestamp for when individual's government ID was successfully verified. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-verified-selfie-at) verified\_selfie\_at string The date or timestamp for when individual's selfie was successfully verified. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-completed-customer-safety-check-at) completed\_customer\_safety\_check\_at string The date or timestamp for when individual successfully passed customer safety check. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#body-documents) documents Documents · object\[\] Please click "ADD OBJECT" for more information. Show child attributes #### Response 200 application/json Updated associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-id) id string required Unique identifier for the associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-created-at) created\_at integer required Created timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-updated-at) updated\_at integer required Last updated timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-email) email string The email address of the associated person [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-first-name) first\_name string The first name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-last-name) last\_name string The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-has-ownership) has\_ownership boolean True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-has-control) has\_control boolean True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-is-signer) is\_signer boolean True if this person is able to authorize transactions on behalf of the business. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-attested-ownership-structure-at) attested\_ownership\_structure\_at string When this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/associated-persons/update-a-single-associated-person#response-relationship-established-at) relationship\_established\_at string When the associated person relationship was established in format yyyy-mm-dd. Was this page helpful? YesNo [Get a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/get-a-single-associated-person) [Delete a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a Bridge Wallet - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge Wallets Create a Bridge Wallet [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a Bridge Wallet cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/wallets \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "chain": "base" } ' 201 SuccessfulLiquidationAddressCreateResponse { "id": "bw_123", "chain": "solana", "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } POST / customers / {customerID} / wallets Try it Create a Bridge Wallet cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/wallets \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "chain": "base" } ' 201 SuccessfulLiquidationAddressCreateResponse { "id": "bw_123", "chain": "solana", "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json Bridge Wallet to be created [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#body-chain) chain enum required Available options: `base`, `ethereum`, `solana`, `tempo`, `tron` #### Response 201 application/json Bridge Wallet created [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#response-chain) chain enum required Available options: `base`, `ethereum`, `solana`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#response-address) address string The blockchain address of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#response-created-at) created\_at string Time of creation of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet#response-updated-at) updated\_at string Time of most recent update of the Bridge Wallet Was this page helpful? YesNo [Get all Bridge Wallets for a customer](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer) [Get a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a Bridge Wallet - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge Wallets Get a Bridge Wallet [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a Bridge Wallet cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets/{bridgeWalletID} \ --header 'Api-Key: ' 200 SuccessfulBridgeWalletGetResponse { "id": "bw_123", "chain": "solana", "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z", "balances": [\ {\ "balance": "100.25",\ "currency": "usdb",\ "chain": "solana",\ "contract_address": "ENL66PGy8d8j5KNqLtCcg4uidDUac5ibt45wbjH9REzB"\ }\ ] } GET / wallets / {bridgeWalletID} Try it Get a Bridge Wallet cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets/{bridgeWalletID} \ --header 'Api-Key: ' 200 SuccessfulBridgeWalletGetResponse { "id": "bw_123", "chain": "solana", "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z", "balances": [\ {\ "balance": "100.25",\ "currency": "usdb",\ "chain": "solana",\ "contract_address": "ENL66PGy8d8j5KNqLtCcg4uidDUac5ibt45wbjH9REzB"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#parameter-bridge-wallet-id) bridgeWalletID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json A Bridge Wallet object response [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#response-chain) chain enum required The chain of the Bridge Wallet Available options: `base`, `ethereum`, `solana`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#response-address) address string The blockchain address of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#response-created-at) created\_at string Time of creation of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#response-updated-at) updated\_at string Time of most recent update of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet#response-balances) balances object\[\] Show child attributes Was this page helpful? YesNo [Get total balances of all Bridge Wallets](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets) [Get transaction history for a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a Bridge Wallet - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge Wallets Get a Bridge Wallet [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a Bridge Wallet cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/wallets/{bridgeWalletID} \ --header 'Api-Key: ' 200 SuccessfulLiquidationAddressGetResponse { "id": "bw_123", "chain": "solana", "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z", "balances": [\ {\ "balance": "100.25",\ "currency": "usdb",\ "chain": "solana",\ "contract_address": "ENL66PGy8d8j5KNqLtCcg4uidDUac5ibt45wbjH9REzB"\ }\ ] } GET / customers / {customerID} / wallets / {bridgeWalletID} Try it Get a Bridge Wallet cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/wallets/{bridgeWalletID} \ --header 'Api-Key: ' 200 SuccessfulLiquidationAddressGetResponse { "id": "bw_123", "chain": "solana", "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z", "balances": [\ {\ "balance": "100.25",\ "currency": "usdb",\ "chain": "solana",\ "contract_address": "ENL66PGy8d8j5KNqLtCcg4uidDUac5ibt45wbjH9REzB"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#parameter-bridge-wallet-id) bridgeWalletID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json A Bridge Wallet object response [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#response-chain) chain enum required The chain of the Bridge Wallet Available options: `base`, `ethereum`, `solana`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#response-address) address string The blockchain address of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#response-created-at) created\_at string Time of creation of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#response-updated-at) updated\_at string Time of most recent update of the Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1#response-balances) balances object\[\] Show child attributes Was this page helpful? YesNo [Create a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet) [Get all customers](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all Bridge Wallets for a customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge Wallets Get all Bridge Wallets for a customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all Bridge Wallets for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/wallets \ --header 'Api-Key: ' 200 SuccessfulBridgeWalletListResponse { "count": 1, "data": [\ {\ "id": "bw_123",\ "chain": "solana",\ "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs",\ "created_at": "2023-11-22T21:31:30.515Z",\ "updated_at": "2023-11-22T21:31:30.515Z"\ }\ ] } GET / customers / {customerID} / wallets Try it Get all Bridge Wallets for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/wallets \ --header 'Api-Key: ' 200 SuccessfulBridgeWalletListResponse { "count": 1, "data": [\ {\ "id": "bw_123",\ "chain": "solana",\ "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs",\ "created_at": "2023-11-22T21:31:30.515Z",\ "updated_at": "2023-11-22T21:31:30.515Z"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#parameter-starting-after) starting\_after string This is a bridge wallet id. If this is specified, the next page that starts with a bridge wallet right AFTER the specified bridge wallet id on the bridge wallet timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that bridge wallets older than the specified bridge wallet id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#parameter-ending-before) ending\_before string This is a bridge wallet id. If this is specified, the previous page that ends with a bridge wallet right BEFORE the specified bridge wallet id on the bridge wallet timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that bridge wallets newer than the specified bridge wallet id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json List of Bridge Wallets [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Get transaction history for a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet) [Create a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/create-a-bridge-wallet) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get total balances of all Bridge Wallets - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge Wallets Get total balances of all Bridge Wallets [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get total balances of all Bridge Wallets cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets/total_balances \ --header 'Api-Key: ' 200 TotalBalancesFound [\ {\ "balance": "100.25",\ "currency": "usdb",\ "chain": "solana",\ "contract_address": "ENL66PGy8d8j5KNqLtCcg4uidDUac5ibt45wbjH9REzB"\ }\ ] GET / wallets / total\_balances Try it Get total balances of all Bridge Wallets cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets/total_balances \ --header 'Api-Key: ' 200 TotalBalancesFound [\ {\ "balance": "100.25",\ "currency": "usdb",\ "chain": "solana",\ "contract_address": "ENL66PGy8d8j5KNqLtCcg4uidDUac5ibt45wbjH9REzB"\ }\ ] #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets#authorization-api-key) Api-Key string header required #### Response 200 application/json Total balances of all Bridge Wallets [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets#response-items-balance) balance string required The total balance of wallets in the given currency ex. "10.95" [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets#response-items-currency) currency enum required The currency of the total balance Available options: `usdb`, `usdc`, `usdt`, `dai`, `usd`, `pyusd` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets#response-items-chain) chain enum required The chain of the total balance Available options: `base`, `ethereum`, `solana`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets#response-items-contract-address) contract\_address string The contract address of the currency, or null if it is a native currency Was this page helpful? YesNo [Get all Bridge Wallets](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets) [Get a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all Bridge Wallets - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge Wallets Get all Bridge Wallets [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all Bridge Wallets cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets \ --header 'Api-Key: ' 200 SuccessfulBridgeWalletListResponse { "count": 1, "data": [\ {\ "id": "bw_123",\ "chain": "solana",\ "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs",\ "created_at": "2023-11-22T21:31:30.515Z",\ "updated_at": "2023-11-22T21:31:30.515Z"\ }\ ] } GET / wallets Try it Get all Bridge Wallets cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets \ --header 'Api-Key: ' 200 SuccessfulBridgeWalletListResponse { "count": 1, "data": [\ {\ "id": "bw_123",\ "chain": "solana",\ "address": "9kV3ZMehKVyxfHKCcaDLye3P9HHw2MP4jtQa2gKBUmCs",\ "created_at": "2023-11-22T21:31:30.515Z",\ "updated_at": "2023-11-22T21:31:30.515Z"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets#parameter-starting-after) starting\_after string This is a bridge wallet id. If this is specified, the next page that starts with a bridge wallet right AFTER the specified bridge wallet id on the bridge wallet timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that bridge wallets older than the specified bridge wallet id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets#parameter-ending-before) ending\_before string This is a bridge wallet id. If this is specified, the previous page that ends with a bridge wallet right BEFORE the specified bridge wallet id on the bridge wallet timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that bridge wallets newer than the specified bridge wallet id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json List of Bridge Wallets [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Bridge API Pagination Guide](https://apidocs.bridge.xyz/api-reference/pagination) [Get total balances of all Bridge Wallets](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get transaction history for a Bridge Wallet - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge Wallets Get transaction history for a Bridge Wallet [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get transaction history for a Bridge Wallet cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets/{bridgeWalletID}/history \ --header 'Api-Key: ' 200 Example { "count": 123, "data": [\ {\ "amount": "",\ "developer_fee": "",\ "created_at": "2023-11-07T05:31:56Z",\ "updated_at": "2023-11-07T05:31:56Z",\ "customer_id": "",\ "source": {\ "payment_rail": "ach",\ "currency": "usdb"\ },\ "destination": {\ "payment_rail": "ach",\ "currency": "usdb"\ }\ }\ ] } GET / wallets / {bridgeWalletID} / history Try it Get transaction history for a Bridge Wallet cURL curl --request GET \ --url https://api.bridge.xyz/v0/wallets/{bridgeWalletID}/history \ --header 'Api-Key: ' 200 Example { "count": 123, "data": [\ {\ "amount": "",\ "developer_fee": "",\ "created_at": "2023-11-07T05:31:56Z",\ "updated_at": "2023-11-07T05:31:56Z",\ "customer_id": "",\ "source": {\ "payment_rail": "ach",\ "currency": "usdb"\ },\ "destination": {\ "payment_rail": "ach",\ "currency": "usdb"\ }\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#parameter-bridge-wallet-id) bridgeWalletID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#parameter-updated-after-ms) updated\_after\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#parameter-updated-before-ms) updated\_before\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned #### Response 200 application/json List of transactions for this Bridge Wallet [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Get a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet) [Get all Bridge Wallets for a customer](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Postman collection - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/introduction/postman#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Postman collection [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) ### [​](https://apidocs.bridge.xyz/api-reference/introduction/postman#try-the-api-with-postman) Try the API with Postman Click [here](https://god.gw.postman.com/run-collection/38333379-c2e057c8-d066-4c73-bb66-275c028a00f6?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D38333379-c2e057c8-d066-4c73-bb66-275c028a00f6%26entityType%3Dcollection%26workspaceId%3D3ea438c8-19f4-48e9-8a0c-9b2091303747) to fork our Postman collection and start testing the Bridge API in your own workspace: ### [​](https://apidocs.bridge.xyz/api-reference/introduction/postman#what%E2%80%99s-included) What’s included: * All core endpoints (transfers, deposits, refunds, etc.) * Environment variables for managing your API keys * Pre-configured request examples for common flows * Built-in support for test environments ### [​](https://apidocs.bridge.xyz/api-reference/introduction/postman#how-to-use-it) How to use it: * Click the link above. * Fork the collection into your Postman workspace. * Set up your API key and environment variables. * Start making requests! Was this page helpful? YesNo [Idempotency](https://apidocs.bridge.xyz/api-reference/introduction/idempotence) [Bridge API Pagination Guide](https://apidocs.bridge.xyz/api-reference/pagination) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Update an existing crypto return policy - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Crypto Return Policies Update an existing crypto return policy [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Update an existing crypto return policy cURL curl --request PUT \ --url https://api.bridge.xyz/v0/crypto_return_policies/{policyID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } ' 200 Example { "id": "", "developer\_id": "", "refund\_destination\_address": "", "refund\_destination\_blockchain\_memo": "", "refund\_destination\_chain": "", "refund\_destination\_currency": "", "strategy": "" } PUT / crypto\_return\_policies / {policyID} Try it Update an existing crypto return policy cURL curl --request PUT \ --url https://api.bridge.xyz/v0/crypto_return_policies/{policyID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } ' 200 Example { "id": "", "developer\_id": "", "refund\_destination\_address": "", "refund\_destination\_blockchain\_memo": "", "refund\_destination\_chain": "", "refund\_destination\_currency": "", "strategy": "" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#parameter-policy-id) policyID string required #### Body application/json Crypto return policy object to be updated [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#body-refund-destination-address) refund\_destination\_address string The address to which the refund will be sent. Required if the strategy is `static_address`, but must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#body-refund-destination-blockchain-memo) refund\_destination\_blockchain\_memo string The memo to include with the refund transaction. Must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#body-refund-destination-chain) refund\_destination\_chain string The blockchain on which the refund will be sent. Required if the strategy is `static_address`, but must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#body-refund-destination-currency) refund\_destination\_currency string The currency to which the refund will be sent. Required if the strategy is `static_address`, but must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#body-strategy) strategy string The strategy to use for the refund. Can be `refund_to_sender` or `static_address`. We only support multiple policies for `static_address`; different strategies cannot have multiple policies. If multiple `static_address` policies exist, the policy that matches both the currency and chain will be used first. If no such policy is found, the policy that matches only the currency will be used instead. #### Response 200 application/json Crypto return policy updated [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#response-id) id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#response-developer-id) developer\_id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#response-refund-destination-address) refund\_destination\_address string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#response-refund-destination-blockchain-memo) refund\_destination\_blockchain\_memo string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#response-refund-destination-chain) refund\_destination\_chain string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#response-refund-destination-currency) refund\_destination\_currency string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy#response-strategy) strategy string Was this page helpful? YesNo [Create a new crypto return policy](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy) [Delete a single crypto return policy object](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Authentication - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/introduction/introduction#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Authentication [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Bridge uses API keys to authenticate your requests. You can generate them from the [dashboard](http://dashboard.bridge.xyz/app/keys) . **⚠️ API keys are shown only once** at the time of creation. Be sure to copy and store them securely — they cannot be retrieved later. ### [​](https://apidocs.bridge.xyz/api-reference/introduction/introduction#-how-authentication-works) 🔑 How Authentication Works * Pass your API key in the Api-Key header using HTTP Basic Auth. * No username or password is required — just the API key. * All requests must be made over HTTPS; requests over plain HTTP are rejected. * Invalid or missing keys will return a 401 Unauthorized. > ❗️ Keep your API keys secure. They grant full access to your account and should never be shared publicly or within internal tools like Slack or dashboards. ### [​](https://apidocs.bridge.xyz/api-reference/introduction/introduction#sandbox-environment) Sandbox Environment * In the sandbox, API keys are scoped to individual developer accounts. * Keys generated in sandbox are not visible to teammates, even if production keys are shared across the org. ### [​](https://apidocs.bridge.xyz/api-reference/introduction/introduction#example-request) Example Request curl --location --request GET 'https://api.bridge.xyz/v0/customers' \ --header 'Content-Type: application/json' \ --header 'Api-Key: ' Was this page helpful? YesNo [Idempotency](https://apidocs.bridge.xyz/api-reference/introduction/idempotence) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a new crypto return policy - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Crypto Return Policies Create a new crypto return policy [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a new crypto return policy cURL curl --request POST \ --url https://api.bridge.xyz/v0/crypto_return_policies \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } ' 201 Example { "id": "", "developer_id": "", "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } POST / crypto\_return\_policies Try it Create a new crypto return policy cURL curl --request POST \ --url https://api.bridge.xyz/v0/crypto_return_policies \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } ' 201 Example { "id": "", "developer_id": "", "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#parameter-idempotency-key) Idempotency-Key string required #### Body application/json Crypto return policy object to be created [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#body-refund-destination-address) refund\_destination\_address string The address to which the refund will be sent. Required if the strategy is `static_address`, but must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#body-refund-destination-blockchain-memo) refund\_destination\_blockchain\_memo string The memo to include with the refund transaction. Must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#body-refund-destination-chain) refund\_destination\_chain string The blockchain on which the refund will be sent. Required if the strategy is `static_address`, but must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#body-refund-destination-currency) refund\_destination\_currency string The currency to which the refund will be sent. Required if the strategy is `static_address`, but must be unset if the strategy is `refund_to_sender`. [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#body-strategy) strategy string The strategy to use for the refund. Can be `refund_to_sender` or `static_address`. We only support multiple policies for `static_address`; different strategies cannot have multiple policies. If multiple `static_address` policies exist, the policy that matches both the currency and chain will be used first. If no such policy is found, the policy that matches only the currency will be used instead. #### Response 201 application/json Crypto return policy created [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#response-id) id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#response-developer-id) developer\_id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#response-refund-destination-address) refund\_destination\_address string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#response-refund-destination-blockchain-memo) refund\_destination\_blockchain\_memo string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#response-refund-destination-chain) refund\_destination\_chain string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#response-refund-destination-currency) refund\_destination\_currency string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy#response-strategy) strategy string Was this page helpful? YesNo [Get all crypto return policies](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies) [Update an existing crypto return policy](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Idempotency - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/introduction/idempotence#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Idempotency [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) ### [​](https://apidocs.bridge.xyz/api-reference/introduction/idempotence#idempotency) Idempotency All `POST` APIs in Bridge require [idempotency](https://developer.mozilla.org/en-US/docs/Glossary/Idempotent) to guarantee safe retries and prevent duplicate operations. You must include an `Idempotency-Key` header with a unique value for each request. This ensures that if a request is retried (due to network errors, client timeouts, or unexpected failures), Bridge can detect the duplication and return the same response, without performing the operation again. > Do not include an Idempotency-Key with GET, PUT, PATCH, or DELETE requests. These methods are naturally idempotent and do not require this header. ### [​](https://apidocs.bridge.xyz/api-reference/introduction/idempotence#how-it-works) How It Works * Include a unique Idempotency-Key (typically a UUID) in the request header of every POST. * Bridge guarantees idempotent behavior for 24 hours after the initial request. During this window, any subsequent request with the same Idempotency-Key will return the original response — with no side effects or duplicated operations. * For example, if a request to create a Customer or a Transfer fails or times out, you can safely retry it using the same key to ensure that only one object is ever created. * After the 24-hour window expires, reusing the same Idempotency-Key will result in a 422 Unprocessable Entity error. ### [​](https://apidocs.bridge.xyz/api-reference/introduction/idempotence#best-practices) Best Practices * Use a UUID for each new request. * Store the UUID in your database to track request state. * Reuse the same UUID when retrying a failed request. ### [​](https://apidocs.bridge.xyz/api-reference/introduction/idempotence#example) Example curl --location --request POST 'https://api.bridge.xyz/v1/customers' \ --header 'Content-Type: application/json' \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --data-raw '{ "first_name": "John", "last_name": "Doe", "email": "johndoe@johndoe.com", "address": { "street_line_1": "123 Washington St", "street_line_2": "Apt 2F", "city": "New York", "state": "NY", "postal_code": "10001", "country": "USA" }, "birth_date": "1989-09-09", "tax_identification_number": "111-11-1111" }' Was this page helpful? YesNo [Authentication](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Postman collection](https://apidocs.bridge.xyz/api-reference/introduction/postman) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Delete a single crypto return policy object - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Crypto Return Policies Delete a single crypto return policy object [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Delete a single crypto return policy object cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/crypto_return_policies/{policyID} \ --header 'Api-Key: ' 200 Example { "id": "", "developer_id": "", "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } DELETE / crypto\_return\_policies / {policyID} Try it Delete a single crypto return policy object cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/crypto_return_policies/{policyID} \ --header 'Api-Key: ' 200 Example { "id": "", "developer_id": "", "refund_destination_address": "", "refund_destination_blockchain_memo": "", "refund_destination_chain": "", "refund_destination_currency": "", "strategy": "" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#parameter-policy-id) policyID string required #### Response 200 application/json Successfully deleted crypto return policy object response [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#response-id) id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#response-developer-id) developer\_id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#response-refund-destination-address) refund\_destination\_address string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#response-refund-destination-blockchain-memo) refund\_destination\_blockchain\_memo string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#response-refund-destination-chain) refund\_destination\_chain string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#response-refund-destination-currency) refund\_destination\_currency string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object#response-strategy) strategy string Was this page helpful? YesNo [Update an existing crypto return policy](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all crypto return policies - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Crypto Return Policies Get all crypto return policies [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all crypto return policies cURL curl --request GET \ --url https://api.bridge.xyz/v0/crypto_return_policies \ --header 'Api-Key: ' 200 Example [\ {\ "id": "",\ "developer_id": "",\ "refund_destination_address": "",\ "refund_destination_blockchain_memo": "",\ "refund_destination_chain": "",\ "refund_destination_currency": "",\ "strategy": ""\ }\ ] GET / crypto\_return\_policies Try it Get all crypto return policies cURL curl --request GET \ --url https://api.bridge.xyz/v0/crypto_return_policies \ --header 'Api-Key: ' 200 Example [\ {\ "id": "",\ "developer_id": "",\ "refund_destination_address": "",\ "refund_destination_blockchain_memo": "",\ "refund_destination_chain": "",\ "refund_destination_currency": "",\ "strategy": ""\ }\ ] #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#authorization-api-key) Api-Key string header required #### Response 200 application/json List of crypto return policies [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#response-items-id) id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#response-items-developer-id) developer\_id string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#response-items-refund-destination-address) refund\_destination\_address string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#response-items-refund-destination-blockchain-memo) refund\_destination\_blockchain\_memo string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#response-items-refund-destination-chain) refund\_destination\_chain string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#response-items-refund-destination-currency) refund\_destination\_currency string [​](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies#response-items-strategy) strategy string Was this page helpful? YesNo [Get countries](https://apidocs.bridge.xyz/api-reference/lists/get-countries) [Create a new crypto return policy](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/create-a-new-crypto-return-policy) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get current exchange rate between two currencies. - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Exchange Rates Get current exchange rate between two currencies. [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get current exchange rate between two currencies. cURL curl --request GET \ --url https://api.bridge.xyz/v0/exchange_rates \ --header 'Api-Key: ' 200 { "midmarket_rate": "0.93425", "buy_rate": "0.9389", "sell_rate": "0.9296" } GET / exchange\_rates Try it Get current exchange rate between two currencies. cURL curl --request GET \ --url https://api.bridge.xyz/v0/exchange_rates \ --header 'Api-Key: ' 200 { "midmarket_rate": "0.93425", "buy_rate": "0.9389", "sell_rate": "0.9296" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies#parameter-from) from enum required The currency code to convert from. Available options: `brl`, `btc`, `cop`, `eth`, `eur`, `gbp`, `mxn`, `sol`, `usd`, `usdt` [​](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies#parameter-to) to enum required The currency code to convert to. Available options: `brl`, `btc`, `cop`, `eth`, `eur`, `gbp`, `mxn`, `sol`, `usd`, `usdt` #### Response 200 - application/json The exchange rate information. [​](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies#response-midmarket-rate) midmarket\_rate string The midmarket exchange rate. Example: `"0.93425"` [​](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies#response-buy-rate) buy\_rate string The rate for buying the target currency, including Bridge's fee. Example: `"0.9389"` [​](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies#response-sell-rate) sell\_rate string The rate for selling the target currency, including Bridge's fee. Example: `"0.9296"` Was this page helpful? YesNo [Delete a single associated person](https://apidocs.bridge.xyz/api-reference/associated-persons/delete-a-single-associated-person) [Get occupation codes](https://apidocs.bridge.xyz/api-reference/lists/get-occupation-codes) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Update the configured fees - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/developers/update-the-configured-fees#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Developers Update the configured fees [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Update the configured fees cURL curl --request POST \ --url https://api.bridge.xyz/v0/developer/fees \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "default_liquidation_address_fee_percent": "0.5" } ' 200 SuccessfulResponse { "$ref": "#/components/examples/SuccessfulDeveloperFeesUpdateResponse" } POST / developer / fees Try it Update the configured fees cURL curl --request POST \ --url https://api.bridge.xyz/v0/developer/fees \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "default_liquidation_address_fee_percent": "0.5" } ' 200 SuccessfulResponse { "$ref": "#/components/examples/SuccessfulDeveloperFeesUpdateResponse" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/developers/update-the-configured-fees#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/developers/update-the-configured-fees#parameter-idempotency-key) Idempotency-Key string required #### Body application/json The default fee percent that will be applied to all your Liquidation Addresses. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. [​](https://apidocs.bridge.xyz/api-reference/developers/update-the-configured-fees#body-default-liquidation-address-fee-percent) default\_liquidation\_address\_fee\_percent string required The default fee percent that will be applied to all your Liquidation Addresses. The value is a base 100 percentage, i.e. 10.2% is "10.2" in the API. Example: `"0.5"` #### Response 200 application/json The configured fees have been updated for your developer account. Was this page helpful? YesNo [Get the configured fees](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fees) [Get the configured fee External Account](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get the configured fees - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fees#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Developers Get the configured fees [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get the configured fees cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/fees \ --header 'Api-Key: ' 200 SuccessfulResponse { "$ref": "#/components/examples/SuccessfulDeveloperFeesShowResponse/value" } GET / developer / fees Try it Get the configured fees cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/fees \ --header 'Api-Key: ' 200 SuccessfulResponse { "$ref": "#/components/examples/SuccessfulDeveloperFeesShowResponse/value" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fees#authorization-api-key) Api-Key string header required #### Response 200 application/json The configured fees for your developer account. [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fees#response-default-liquidation-address-fee-percent) default\_liquidation\_address\_fee\_percent string required The default fee percent that will be applied to all your Liquidation Addresses. The value is a base 100 percentage, i.e. 10.2% is "10.2" in the API. Example: `"0.5"` Was this page helpful? YesNo [Create a Batch Settlement Schedule](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule) [Update the configured fees](https://apidocs.bridge.xyz/api-reference/developers/update-the-configured-fees) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get the fiat payout configuration for a customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/get-the-fiat-payout-configuration-for-a-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Fiat Payout Configuration Get the fiat payout configuration for a customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get the fiat payout configuration for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \ --header 'Api-Key: ' 200 SuccessfulFiatPayoutConfigurationResponse { "fiat_payout_configuration": { "usd": { "wire": "developer", "ach": "bridge" }, "eur": { "sepa": "bridge" }, "brl": { "pix": "payment_provider" }, "mxn": { "spei": "payment_provider" } } } GET / customers / {customerID} / fiat\_payout\_configuration Try it Get the fiat payout configuration for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \ --header 'Api-Key: ' 200 SuccessfulFiatPayoutConfigurationResponse { "fiat_payout_configuration": { "usd": { "wire": "developer", "ach": "bridge" }, "eur": { "sepa": "bridge" }, "brl": { "pix": "payment_provider" }, "mxn": { "spei": "payment_provider" } } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/get-the-fiat-payout-configuration-for-a-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/get-the-fiat-payout-configuration-for-a-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successful fiat payout configuration response [​](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/get-the-fiat-payout-configuration-for-a-customer#response-fiat-payout-configuration) fiat\_payout\_configuration object required A nested hash structure representing the fiat payout configuration. The top-level keys are currency codes. Each currency maps to a hash where keys are payment rail codes and values are payout names. Show child attributes Example: { "usd": { "wire": "developer", "ach": "bridge" }, "eur": { "sepa": "bridge" }, "brl": { "pix": "payment_provider" }, "mxn": { "spei": "payment_provider" }} Was this page helpful? YesNo [Get all External Accounts](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all funds requests - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Funds Requests Get all funds requests [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all funds requests cURL curl --request GET \ --url https://api.bridge.xyz/v0/funds_requests \ --header 'Api-Key: ' 200 { "count": 3, "data": [\ {\ "id": "fr_123",\ "deposit_id": "dep_123",\ "customer_id": "cust_123",\ "amount": "120.0",\ "currency": "usd",\ "payment_rail": "wire",\ "fraud": true,\ "notice_date": "2020-02-01",\ "imad": "123456",\ "created_at": "2020-02-01T00:00:00.000Z",\ "deposit_created-at": "2020-01-01T00:00:00.000Z"\ },\ {\ "id": "fr_123",\ "deposit_id": "dep_123",\ "customer_id": "cust_123",\ "amount": "120.0",\ "currency": "usd",\ "payment_rail": "ach_push",\ "fraud": true,\ "notice_date": "2020-02-01",\ "trace_number": "123456",\ "created_at": "2020-02-01T00:00:00.000Z",\ "deposit_created-at": "2020-01-01T00:00:00.000Z"\ },\ {\ "id": "fr_123",\ "deposit_id": "dep_123",\ "customer_id": "cust_123",\ "amount": "120.0",\ "currency": "eur",\ "payment_rail": "sepa",\ "fraud": true,\ "notice_date": "2020-02-01",\ "bank_transaction_id": "123456",\ "created_at": "2020-02-01T00:00:00.000Z",\ "deposit_created-at": "2020-01-01T00:00:00.000Z"\ }\ ] } GET / funds\_requests Try it Get all funds requests cURL curl --request GET \ --url https://api.bridge.xyz/v0/funds_requests \ --header 'Api-Key: ' 200 { "count": 3, "data": [\ {\ "id": "fr_123",\ "deposit_id": "dep_123",\ "customer_id": "cust_123",\ "amount": "120.0",\ "currency": "usd",\ "payment_rail": "wire",\ "fraud": true,\ "notice_date": "2020-02-01",\ "imad": "123456",\ "created_at": "2020-02-01T00:00:00.000Z",\ "deposit_created-at": "2020-01-01T00:00:00.000Z"\ },\ {\ "id": "fr_123",\ "deposit_id": "dep_123",\ "customer_id": "cust_123",\ "amount": "120.0",\ "currency": "usd",\ "payment_rail": "ach_push",\ "fraud": true,\ "notice_date": "2020-02-01",\ "trace_number": "123456",\ "created_at": "2020-02-01T00:00:00.000Z",\ "deposit_created-at": "2020-01-01T00:00:00.000Z"\ },\ {\ "id": "fr_123",\ "deposit_id": "dep_123",\ "customer_id": "cust_123",\ "amount": "120.0",\ "currency": "eur",\ "payment_rail": "sepa",\ "fraud": true,\ "notice_date": "2020-02-01",\ "bank_transaction_id": "123456",\ "created_at": "2020-02-01T00:00:00.000Z",\ "deposit_created-at": "2020-01-01T00:00:00.000Z"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#parameter-starting-after) starting\_after string This is a funds request id. If this is specified, the next page that starts with a funds request right AFTER the specified id on the timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that funds request older than the specified funds request id will be returned (shouldn't be set if `ending_before` is set) [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#parameter-ending-before) ending\_before string This is a funds request id. If this is specified, the previous page that ends with a funds request right BEFORE the specified id on the timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that funds request newer than the specified funds request id will be returned (shouldn't be set if `starting_after` is set) [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#parameter-customer-id) customer\_id string If specified, results will be filtered to the given customer\_id only [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#parameter-fraud) fraud boolean If this is specified as either "true" or "false", then only fraudulent or non-fraudulent entries will be returned, respectively [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#parameter-notice-date-starting-on) notice\_date\_starting\_on string A date in the format YYYY-MM-DD. If specified, then only entries with a notice date on or after the provided date, inclusive, will be returned [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#parameter-notice-date-ending-on) notice\_date\_ending\_on string A date in the format YYYY-MM-DD. If specified, then only entries with a notice date on or before the provided date, inclusive, will be returned #### Response 200 - application/json List of funds requests [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#response-count) count integer required The number of items returned [​](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Check the status of a KYC link](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link) [Get all webhook endpoints](https://apidocs.bridge.xyz/api-reference/webhooks/get-all-webhook-endpoints) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Bridge API Pagination Guide - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/pagination#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Bridge API Pagination Guide [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) On this page * [Endpoint shape](https://apidocs.bridge.xyz/api-reference/pagination#endpoint-shape) * [Query parameters](https://apidocs.bridge.xyz/api-reference/pagination#query-parameters) * [Response shape](https://apidocs.bridge.xyz/api-reference/pagination#response-shape) * [cURL examples](https://apidocs.bridge.xyz/api-reference/pagination#curl-examples) * [1) Fetch the first page (newest first)](https://apidocs.bridge.xyz/api-reference/pagination#1-fetch-the-first-page-newest-first) * [2) Get the next page of older items](https://apidocs.bridge.xyz/api-reference/pagination#2-get-the-next-page-of-older-items) * [3) Fetch newer items since a known id](https://apidocs.bridge.xyz/api-reference/pagination#3-fetch-newer-items-since-a-known-id) * [Practical patterns](https://apidocs.bridge.xyz/api-reference/pagination#practical-patterns) * [Backfill all historical items (older direction)](https://apidocs.bridge.xyz/api-reference/pagination#backfill-all-historical-items-older-direction) * [Periodically check for new items (newer direction)](https://apidocs.bridge.xyz/api-reference/pagination#periodically-check-for-new-items-newer-direction) * [Boundary behavior](https://apidocs.bridge.xyz/api-reference/pagination#boundary-behavior) * [Tips and best practices](https://apidocs.bridge.xyz/api-reference/pagination#tips-and-best-practices) * [Minimal JavaScript examples](https://apidocs.bridge.xyz/api-reference/pagination#minimal-javascript-examples) * [Backfill older pages](https://apidocs.bridge.xyz/api-reference/pagination#backfill-older-pages) * [Poll for newer items since a known id](https://apidocs.bridge.xyz/api-reference/pagination#poll-for-newer-items-since-a-known-id) * [Summary](https://apidocs.bridge.xyz/api-reference/pagination#summary) Most list endpoints return results in reverse chronological order (newest to oldest) and support stable, cursor-based pagination with `starting_after` and `ending_before`. [​](https://apidocs.bridge.xyz/api-reference/pagination#endpoint-shape) **Endpoint shape** --------------------------------------------------------------------------------------------- * Base URL: [**https://api.bridge.xyz**](https://api.bridge.xyz/) * Typical list endpoint pattern: GET /v0/ * Default order: newest → oldest (unless an endpoint specifies otherwise) * Page size: controlled by `limit` (maximum 100) * Pagination: cursor-based using item `id` values Authentication: send your API key in the `Api-Key` header. Security note: do not hardcode live keys in source or docs; use environment variables. [​](https://apidocs.bridge.xyz/api-reference/pagination#query-parameters) **Query parameters** ------------------------------------------------------------------------------------------------- * `limit` * Description: number of items to return * Range: 1–100 * Tip: set explicitly (e.g., `limit=50`) for predictable pagination * `starting_after` * Description: fetches items that come after the given id in the default ordering, i.e., older items * How to use: pass the last item’s id from your current page to get the next page of older results * `ending_before` * Description: fetches items that come before the given id in the default ordering, i.e., newer items * How to use: pass the first item’s id from a known page to retrieve any items that are newer than it Use only one of `starting_after` or `ending_before` per request. [​](https://apidocs.bridge.xyz/api-reference/pagination#response-shape) **Response shape** --------------------------------------------------------------------------------------------- * data: array of resource objects (0 to `limit` items) * count: number of items in this page (if provided by the endpoint) * Stop condition: when `data` is empty, there are no more items in that direction Note: Field names inside `data` vary by resource. All paginable resources include an `id` used as the cursor. [​](https://apidocs.bridge.xyz/api-reference/pagination#curl-examples) **cURL examples** ------------------------------------------------------------------------------------------- Use an environment variable for your API key: * macOS/Linux: export BRIDGE\_API\_KEY=“sk\_live\_…” * Windows PowerShell: $env:BRIDGE\_API\_KEY = “sk\_live\_…” Replace with the list endpoint you’re using (e.g., transactions, payouts, etc.). ### [​](https://apidocs.bridge.xyz/api-reference/pagination#1-fetch-the-first-page-newest-first) **1) Fetch the first page (newest first)** This returns the newest 3 items: curl --location 'https://api.bridge.xyz/v0/{resource}?limit=3' \ --header 'Accept: application/json' \ --header "Api-Key: $BRIDGE_API_KEY" Take note of: * First item’s id: newest on this page * Last item’s id: oldest on this page ### [​](https://apidocs.bridge.xyz/api-reference/pagination#2-get-the-next-page-of-older-items) **2) Get the next page of older items** Use `starting_after` with the last id from the previous page: curl --location 'https://api.bridge.xyz/v0/{resource}?limit=3&starting_after={LAST_ID_FROM_PREVIOUS_PAGE}' \ --header 'Accept: application/json' \ --header "Api-Key: $BRIDGE_API_KEY" ### [​](https://apidocs.bridge.xyz/api-reference/pagination#3-fetch-newer-items-since-a-known-id) **3) Fetch newer items since a known id** If your last run’s first item id was , use `ending_before` to get any newer items: curl --location 'https://api.bridge.xyz/v0/{resource}?ending_before={FIRST_ID_YOU_SAW}' \ --header 'Accept: application/json' \ --header "Api-Key: $BRIDGE_API_KEY" If there are new items, they’ll be returned; otherwise you may see an empty page. [​](https://apidocs.bridge.xyz/api-reference/pagination#practical-patterns) **Practical patterns** ----------------------------------------------------------------------------------------------------- ### [​](https://apidocs.bridge.xyz/api-reference/pagination#backfill-all-historical-items-older-direction) **Backfill all historical items (older direction)** 1. Request with your chosen `limit` (e.g., 100). 2. Process the page. 3. Save the last id from the page (the oldest in this batch). 4. Repeat with `starting_after=` until `data` is empty. ### [​](https://apidocs.bridge.xyz/api-reference/pagination#periodically-check-for-new-items-newer-direction) **Periodically check for new items (newer direction)** 1. Save the first id from your last successful fetch (the newest you’ve seen). 2. Request with `ending_before=`. 3. If `data` is non-empty, process the new items and update your saved first id to the newest id returned. 4. If empty, nothing new is available. ### [​](https://apidocs.bridge.xyz/api-reference/pagination#boundary-behavior) **Boundary behavior** * Reached oldest items: using `starting_after` eventually returns `data: []`. * No newer items: using `ending_before` may return `data: []`. [​](https://apidocs.bridge.xyz/api-reference/pagination#tips-and-best-practices) **Tips and best practices** --------------------------------------------------------------------------------------------------------------- * Treat item ids as stable cursors; always use the first and last ids from each page for the next request. * Don’t combine `starting_after` and `ending_before` in the same call. * Stick to a consistent `limit` for predictable throughput; max is 100. * Expect partial pages near the ends (fewer than `limit` items). * If you need to process items oldest-to-newest, reverse the page locally after fetching. * When running concurrent pagination and ingestion, de-duplicate by `id` in your datastore. [​](https://apidocs.bridge.xyz/api-reference/pagination#minimal-javascript-examples) **Minimal JavaScript examples** ----------------------------------------------------------------------------------------------------------------------- Assume a helper fetchFn(path) that does authenticated fetches relative to [**https://api.bridge.xyz**](https://api.bridge.xyz/) . ### [​](https://apidocs.bridge.xyz/api-reference/pagination#backfill-older-pages) **Backfill older pages** // Fetch older pages until no more items are returned. const backfillAll = async (fetchFn) => { let startingAfter = null; const pageSize = 100; while (true) { const qs = new URLSearchParams({ limit: String(pageSize) }); if (startingAfter) qs.set("starting_after", startingAfter); const res = await fetchFn(`/v0/{resource}?${qs.toString()}`); const { data = [] } = await res.json(); if (data.length === 0) break; // Process items (newest → oldest on this page) // ... // Next cursor: last id (oldest on this page) startingAfter = data[data.length - 1].id; } }; ### [​](https://apidocs.bridge.xyz/api-reference/pagination#poll-for-newer-items-since-a-known-id) **Poll for newer items since a known id** // Fetch any items newer than `firstSeenId`. // Returns the updated newest id to store for next poll. const fetchNewerSince = async (fetchFn, firstSeenId) => { const qs = new URLSearchParams({ ending_before: firstSeenId }); const res = await fetchFn(`/v0/{resource}?${qs.toString()}`); const { data = [] } = await res.json(); if (data.length > 0) { // Items returned are newest → oldest within the page. // Update the cursor to the newest id we now know about. return data[0].id; } return firstSeenId; }; [​](https://apidocs.bridge.xyz/api-reference/pagination#summary) **Summary** ------------------------------------------------------------------------------- * Results are newest → oldest by default. * Use `starting_after=` to go older. * Use `ending_before=` to fetch items newer than a known id. * Control page size with `limit` (max 100). * Stop when `data` is empty in the direction you’re traversing. Was this page helpful? YesNo [Postman collection](https://apidocs.bridge.xyz/api-reference/introduction/postman) [Get all Bridge Wallets](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get the configured fee External Account - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Developers Get the configured fee External Account [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get the configured fee External Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/fee_external_account \ --header 'Api-Key: ' 200 SuccessfulFeeExternalAccountResponse { "id": "fea_123", "account_type": "us", "currency": "usd", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } GET / developer / fee\_external\_account Try it Get the configured fee External Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/fee_external_account \ --header 'Api-Key: ' 200 SuccessfulFeeExternalAccountResponse { "id": "fea_123", "account_type": "us", "currency": "usd", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#authorization-api-key) Api-Key string header required #### Response 200 application/json Get the configured fee External Account. US bank account using account and routing numbers for ACH or Wire transfers [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-customer-id) customer\_id string required The id of the Bridge customer that this External Account belongs to Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-account-owner-name) account\_owner\_name string required Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns: * ach: `^(?!\s*$)[\x20-\x7E]*$` * wire: ``^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$`` Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-created-at) created\_at string required Time of creation of the External Account [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-updated-at) updated\_at string required Time of last update of the External Account [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-active) active boolean required Whether or not this External Account is active [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-account-type) account\_type enum required Type of the bank account. Available options: `us` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-currency) currency enum required Currency associated with the bank account. Must be `usd` for US accounts. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-account) account us · object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-bank-name) bank\_name string Bank name of the account (e.g. "Chase") Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-account-owner-type) account\_owner\_type enum The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required. Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-first-name) first\_name string First name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-last-name) last\_name string Last name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-business-name) business\_name string Business name of the business account holder. Required when the `account_owner_type` is `business` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-deactivation-reason) deactivation\_reason enum Reason for deactivation when this External Account is inactive Available options: `plaid_item_error`, `deactivated_due_to_bounceback`, `deleted_by_developer`, `requested_by_developer`, `invalid_account_number`, `invalid_bank_validation`, `rejected_by_bank_provider` [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-deactivation-details) deactivation\_details string Additional details about the deactivation when this External Account is inactive [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-beneficiary-address-valid) beneficiary\_address\_valid boolean Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts [​](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account#response-last-4) last\_4 string deprecated Last 4 digits of the bank account number. This field is getting deprecated in favor of the `account.last_4` field Minimum string length: `1` Was this page helpful? YesNo [Update the configured fees](https://apidocs.bridge.xyz/api-reference/developers/update-the-configured-fees) [Configure a fee External Account](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all KYC links. - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation KYC Links Get all KYC links. [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all KYC links. cURL curl --request GET \ --url https://api.bridge.xyz/v0/kyc_links \ --header 'Api-Key: ' 200 KycLinksGetResponse { "count": 2, "data": [\ {\ "id": "kyc_link_123",\ "full_name": "John Doe",\ "email": "johndoe@johndoe.com",\ "type": "individual",\ "kyc_link": "www.kyclink.com/blah",\ "tos_link": "www.toslink.com/blah",\ "kyc_status": "approved",\ "rejection_reasons": [],\ "tos_status": "approved",\ "customer_id": "cust_123"\ },\ {\ "id": "kyc_link_456",\ "full_name": "Jane Doe",\ "email": "janedoe@janedoe.com",\ "type": "individual",\ "kyc_link": "www.kyclink.com/blah",\ "tos_link": "www.toslink.com/blah",\ "kyc_status": "rejected",\ "rejection_reasons": [\ {\ "developer_reason": "Missing required ID details.",\ "reason": "Cannot validate ID -- upload a clear photo of the full ID",\ "created_at": "2020-01-02T00:00:00.000Z"\ },\ {\ "developer_reason": "Blurry face portrait.",\ "reason": "Cannot validate ID -- upload a clear photo of the full ID",\ "created_at": "2020-01-02T00:00:00.000Z"\ }\ ],\ "tos_status": "approved",\ "customer_id": "cust_456"\ }\ ] } GET / kyc\_links Try it Get all KYC links. cURL curl --request GET \ --url https://api.bridge.xyz/v0/kyc_links \ --header 'Api-Key: ' 200 KycLinksGetResponse { "count": 2, "data": [\ {\ "id": "kyc_link_123",\ "full_name": "John Doe",\ "email": "johndoe@johndoe.com",\ "type": "individual",\ "kyc_link": "www.kyclink.com/blah",\ "tos_link": "www.toslink.com/blah",\ "kyc_status": "approved",\ "rejection_reasons": [],\ "tos_status": "approved",\ "customer_id": "cust_123"\ },\ {\ "id": "kyc_link_456",\ "full_name": "Jane Doe",\ "email": "janedoe@janedoe.com",\ "type": "individual",\ "kyc_link": "www.kyclink.com/blah",\ "tos_link": "www.toslink.com/blah",\ "kyc_status": "rejected",\ "rejection_reasons": [\ {\ "developer_reason": "Missing required ID details.",\ "reason": "Cannot validate ID -- upload a clear photo of the full ID",\ "created_at": "2020-01-02T00:00:00.000Z"\ },\ {\ "developer_reason": "Blurry face portrait.",\ "reason": "Cannot validate ID -- upload a clear photo of the full ID",\ "created_at": "2020-01-02T00:00:00.000Z"\ }\ ],\ "tos_status": "approved",\ "customer_id": "cust_456"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#parameter-customer-id) customer\_id string If included, filters to KYC links for the customer with the given id [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#parameter-email) email string If included, filters to KYC links for the customer with the given email [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#parameter-starting-after) starting\_after string This is a customer id. If this is specified, the next page that starts with a customer right AFTER the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers older than the specified customer id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#parameter-ending-before) ending\_before string This is a customer id. If this is specified, the previous page that ends with a customer right BEFORE the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers newer than the specified customer id will be returned (shouldn't be set if starting\_after is set) [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#parameter-limit) limit integer The number of items to return (default of 10, max of 100) #### Response 200 application/json Successful KYC links status response [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Configure a fee External Account](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get countries - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/lists/get-countries#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Lists Get countries [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get countries cURL curl --request GET \ --url https://api.bridge.xyz/v0/lists/countries \ --header 'Api-Key: ' 200 { "count": 123, "data": [\ {\ "name": "",\ "alpha3": "",\ "subdivisions": [\ {\ "name": "",\ "code": ""\ }\ ],\ "postal_code_format": ""\ }\ ] } GET / lists / countries Try it Get countries cURL curl --request GET \ --url https://api.bridge.xyz/v0/lists/countries \ --header 'Api-Key: ' 200 { "count": 123, "data": [\ {\ "name": "",\ "alpha3": "",\ "subdivisions": [\ {\ "name": "",\ "code": ""\ }\ ],\ "postal_code_format": ""\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/lists/get-countries#authorization-api-key) Api-Key string header required #### Response 200 - application/json List of supported countries [​](https://apidocs.bridge.xyz/api-reference/lists/get-countries#response-count) count integer required The total number of countries recognized by Bridge [​](https://apidocs.bridge.xyz/api-reference/lists/get-countries#response-data) data object\[\] required The list of countries recognized by Bridge Show child attributes Was this page helpful? YesNo [Get occupation codes](https://apidocs.bridge.xyz/api-reference/lists/get-occupation-codes) [Get all crypto return policies](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/get-all-crypto-return-policies) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Update the fiat payout configuration for a customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Fiat Payout Configuration Update the fiat payout configuration for a customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Update the fiat payout configuration for a customer cURL curl --request PATCH \ --url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "usd": { "wire": "customer" } } ' 200 SuccessfulPatchFiatPayoutConfigurationResponse { "fiat_payout_configuration": { "usd": { "wire": "customer", "ach": "bridge" }, "eur": { "sepa": "bridge" }, "brl": { "pix": "payment_provider" }, "mxn": { "spei": "payment_provider" } } } PATCH / customers / {customerID} / fiat\_payout\_configuration Try it Update the fiat payout configuration for a customer cURL curl --request PATCH \ --url https://api.bridge.xyz/v0/customers/{customerID}/fiat_payout_configuration \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "usd": { "wire": "customer" } } ' 200 SuccessfulPatchFiatPayoutConfigurationResponse { "fiat_payout_configuration": { "usd": { "wire": "customer", "ach": "bridge" }, "eur": { "sepa": "bridge" }, "brl": { "pix": "payment_provider" }, "mxn": { "spei": "payment_provider" } } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json Fiat payout configuration to update Input payload for updating a customer's fiat payout configuration [​](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer#body-fiat-payout-configuration) fiat\_payout\_configuration object required A nested hash structure representing the fiat payout configuration. The top-level keys are currency codes. Each currency maps to a hash where keys are payment rail codes and values are payout names. Show child attributes Example: { "usd": { "wire": "developer", "ach": "bridge" }, "eur": { "sepa": "bridge" }, "brl": { "pix": "payment_provider" }, "mxn": { "spei": "payment_provider" }} #### Response 200 application/json Successful fiat payout configuration update response [​](https://apidocs.bridge.xyz/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer#response-fiat-payout-configuration) fiat\_payout\_configuration object required A nested hash structure representing the fiat payout configuration. The top-level keys are currency codes. Each currency maps to a hash where keys are payment rail codes and values are payout names. Show child attributes Example: { "usd": { "wire": "developer", "ach": "bridge" }, "eur": { "sepa": "bridge" }, "brl": { "pix": "payment_provider" }, "mxn": { "spei": "payment_provider" }} Was this page helpful? YesNo [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) [Generate a Plaid Link token for a customer](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Exchange Plaid public token for an access token - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/plaid/exchange-plaid-public-token-for-an-access-token#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Plaid Exchange Plaid public token for an access token [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Exchange Plaid public token for an access token cURL curl --request POST \ --url https://api.bridge.xyz/v0/plaid_exchange_public_token/{link_token} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "public_token": "" } ' 201 PlaidExchangePublicTokenSuccessResponse { "message": "Successfully exchanged public token for access token" } POST / plaid\_exchange\_public\_token / {link\_token} Try it Exchange Plaid public token for an access token cURL curl --request POST \ --url https://api.bridge.xyz/v0/plaid_exchange_public_token/{link_token} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "public_token": "" } ' 201 PlaidExchangePublicTokenSuccessResponse { "message": "Successfully exchanged public token for access token" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/plaid/exchange-plaid-public-token-for-an-access-token#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/plaid/exchange-plaid-public-token-for-an-access-token#parameter-link-token) link\_token string required Plaid Link token #### Body application/json Plaid public token to be exchanged [​](https://apidocs.bridge.xyz/api-reference/plaid/exchange-plaid-public-token-for-an-access-token#body-public-token) public\_token string Public token generated via the Plaid Link SDK #### Response 201 application/json Plaid public token exchanged [​](https://apidocs.bridge.xyz/api-reference/plaid/exchange-plaid-public-token-for-an-access-token#response-message) message string Message indicating the status of the request Was this page helpful? YesNo [Generate a Plaid Link token for a customer](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer) [Get all transfers](https://apidocs.bridge.xyz/api-reference/transfers/get-all-transfers) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Check the status of a KYC link - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation KYC Links Check the status of a KYC link [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Check the status of a KYC link cURL curl --request GET \ --url https://api.bridge.xyz/v0/kyc_links/{kycLinkID} \ --header 'Api-Key: ' 200 ApprovedKYCLinkGetResponse { "id": "kyc_link_123", "full_name": "John Doe", "email": "johndoe@johndoe.com", "type": "individual", "kyc_link": "www.kyclink.com/blah", "tos_link": "www.toslink.com/blah", "kyc_status": "approved", "rejection_reasons": [], "tos_status": "approved", "customer_id": "cust_123" } GET / kyc\_links / {kycLinkID} Try it Check the status of a KYC link cURL curl --request GET \ --url https://api.bridge.xyz/v0/kyc_links/{kycLinkID} \ --header 'Api-Key: ' 200 ApprovedKYCLinkGetResponse { "id": "kyc_link_123", "full_name": "John Doe", "email": "johndoe@johndoe.com", "type": "individual", "kyc_link": "www.kyclink.com/blah", "tos_link": "www.toslink.com/blah", "kyc_status": "approved", "rejection_reasons": [], "tos_status": "approved", "customer_id": "cust_123" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#parameter-kyc-link-id) kycLinkID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successful KYC link status response [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-id) id string ID of the KYC link [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-type) type enum Type of the KYC link Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-customer-id) customer\_id string ID of the customer. [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-full-name) full\_name string Full name of the customer, for a business, this would be the business entity's legal name [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-email) email string Email of the customer [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-kyc-link) kyc\_link string Link to the KYC flow [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-kyc-status) kyc\_status enum Status of the KYC flow. Available options: `not_started`, `incomplete`, `awaiting_questionnaire`, `awaiting_ubo`, `under_review`, `approved`, `rejected`, `paused`, `offboarded` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-rejection-reasons) rejection\_reasons object\[\] Reasons why a customer KYC was rejected Show child attributes [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-tos-link) tos\_link string Link to the TOS flow [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-tos-status) tos\_status enum Status of the TOS flow Available options: `pending`, `approved` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link#response-created-at) created\_at string Time of creation of the KYC link Was this page helpful? YesNo [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) [Get all funds requests](https://apidocs.bridge.xyz/api-reference/funds-requests/get-all-funds-requests) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Generate the Links needs to complete KYC for an individual or business - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation KYC Links Generate the Links needs to complete KYC for an individual or business [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Generate the Links needs to complete KYC for an individual or business cURL curl --request POST \ --url https://api.bridge.xyz/v0/kyc_links \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "email": "", "type": "individual", "full_name": "", "endorsements": [\ "base"\ ], "redirect_uri": "", "transliterated_first_name": "", "transliterated_middle_name": "", "transliterated_last_name": "", "transliterated_business_legal_name": "" } ' 200 SuccessfulLiquidationAddressCreateResponse { "id": "kyc_link_123", "full_name": "John Doe", "email": "johndoe@johndoe.com", "type": "individual", "kyc_link": "www.kyclink.com/blah", "tos_link": "www.toslink.com/blah", "kyc_status": "not_started", "tos_status": "pending", "customer_id": "cust_123" } POST / kyc\_links Try it Generate the Links needs to complete KYC for an individual or business cURL curl --request POST \ --url https://api.bridge.xyz/v0/kyc_links \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "email": "", "type": "individual", "full_name": "", "endorsements": [\ "base"\ ], "redirect_uri": "", "transliterated_first_name": "", "transliterated_middle_name": "", "transliterated_last_name": "", "transliterated_business_legal_name": "" } ' 200 SuccessfulLiquidationAddressCreateResponse { "id": "kyc_link_123", "full_name": "John Doe", "email": "johndoe@johndoe.com", "type": "individual", "kyc_link": "www.kyclink.com/blah", "tos_link": "www.toslink.com/blah", "kyc_status": "not_started", "tos_status": "pending", "customer_id": "cust_123" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#parameter-idempotency-key) Idempotency-Key string required #### Body application/json Information about the customer to create KYC Links for [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-email) email string required Email of the customer Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-type) type enum required Type of the customer (individual vs. business) Available options: `individual`, `business` Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-full-name) full\_name string Full name of the customer, for a business, this would be the business entity's legal name Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-endorsements) endorsements enum\[\] List of endorsements to request for the generated KYC link. For example, `sepa` endorsement could be requested to allow an `individual` customer to submit `proof-of-address` documents in the KYC flow. The type of endorsement. Available options: `base`, `cards`, `cop`, `faster_payments`, `pix`, `sepa`, `spei` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-redirect-uri) redirect\_uri string The location where the customer should be redirected after completing the KYC flow. Must be in the form of http:// or https://. [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-transliterated-first-name) transliterated\_first\_name string Required when the `full_name` of an individual includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-transliterated-middle-name) transliterated\_middle\_name string Required when the `full_name` of an individual includes any non Latin-1 characters and the individual has a middle name. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-transliterated-last-name) transliterated\_last\_name string Required when the `full_name` of an individual includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#body-transliterated-business-legal-name) transliterated\_business\_legal\_name string Required if the `full_name` of a business includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 1024` #### Response 200 application/json KYC Links generated [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-id) id string ID of the KYC link [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-type) type enum Type of the KYC link Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-customer-id) customer\_id string ID of the customer. [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-full-name) full\_name string Full name of the customer, for a business, this would be the business entity's legal name [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-email) email string Email of the customer [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-kyc-link) kyc\_link string Link to the KYC flow [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-kyc-status) kyc\_status enum Status of the KYC flow. Available options: `not_started`, `incomplete`, `awaiting_questionnaire`, `awaiting_ubo`, `under_review`, `approved`, `rejected`, `paused`, `offboarded` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-rejection-reasons) rejection\_reasons object\[\] Reasons why a customer KYC was rejected Show child attributes [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-tos-link) tos\_link string Link to the TOS flow [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-tos-status) tos\_status enum Status of the TOS flow Available options: `pending`, `approved` [​](https://apidocs.bridge.xyz/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business#response-created-at) created\_at string Time of creation of the KYC link Was this page helpful? YesNo [Get all KYC links.](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links) [Check the status of a KYC link](https://apidocs.bridge.xyz/api-reference/kyc-links/check-the-status-of-a-kyc-link) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Index - Bridge [Skip to main content](https://apidocs.bridge.xyz/#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Build with Bridge. ================== Bridge provides modern payments infrastructure to move money with stablecoins and fiat rails, custody funds via wallets, issue your own stablecoin, and provision globally accepted cards — at the speed and scale of the internet. [Get started →](https://apidocs.bridge.xyz/get-started/introduction/overview) Quickstart guides ----------------- Create a virtual account ------------------------ Use a virtual account to accept deposits in USD, EUR, GBP, MXN, and more with a unique account & routing number. Make payments ------------- Easily create onramps, offramps, and crypto to crypto transfers using our orchestration APIs. Provision cards --------------- Provision a card backed by stablecoins and spend anywhere in the world. Create wallets -------------- Custody funds in a wallet. Use it to send, receive, or hold stablecoins. Issue stablecoins ----------------- Issue your own stablecoin and start earning yield. Resources --------- Contact support --------------- Reach out to our team for help with integration or technical issues. Request sales ------------- Click here to request a demo! Demo ---- Watch our interactive demo to see Bridge in action. ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Configure a fee External Account - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Developers Configure a fee External Account [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Configure a fee External Account cURL curl --request POST \ --url https://api.bridge.xyz/v0/developer/fee_external_account \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "currency": "usd", "bank_name": "Wells Fargo", "account_owner_name": "John Doe", "account_type": "us", "account": { "account_number": "1210002481111", "routing_number": "121000248", "checking_or_savings": "checking" }, "address": { "street_line_1": "123 Main St", "city": "San Francisco", "state": "CA", "postal_code": "94102", "country": "USA" } } ' 201 SuccessfulFeeExternalAccountResponse { "id": "fea_123", "account_type": "us", "currency": "usd", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } POST / developer / fee\_external\_account Try it Configure a fee External Account cURL curl --request POST \ --url https://api.bridge.xyz/v0/developer/fee_external_account \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "currency": "usd", "bank_name": "Wells Fargo", "account_owner_name": "John Doe", "account_type": "us", "account": { "account_number": "1210002481111", "routing_number": "121000248", "checking_or_savings": "checking" }, "address": { "street_line_1": "123 Main St", "city": "San Francisco", "state": "CA", "postal_code": "94102", "country": "USA" } } ' 201 SuccessfulFeeExternalAccountResponse { "id": "fea_123", "account_type": "us", "currency": "usd", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#parameter-idempotency-key) Idempotency-Key string required #### Body application/json New External Account object to be created Request body for creating a fee external account. Fee external accounts must use USD currency. [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-account-owner-name) account\_owner\_name string required Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns: * ach: `^(?!\s*$)[\x20-\x7E]*$` * wire: ``^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$`` Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-account-type) account\_type enum required Type of the bank account. Available options: `us` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-currency) currency enum required Currency associated with the bank account. Must be `usd` for US accounts. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-account) account us · object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-bank-name) bank\_name string Bank name of the account (e.g. "Chase") Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-account-owner-type) account\_owner\_type enum The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required. Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-first-name) first\_name string First name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-last-name) last\_name string Last name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-business-name) business\_name string Business name of the business account holder. Required when the `account_owner_type` is `business` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-address) address object Address of the beneficiary of this account. Please ensure the address is valid (Google Maps is good for this). US addresses used to receive wires must include a street number. Show child attributes [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-account-number) account\_number string deprecated Account number of your bank account. This field is getting deprecated in favor of the `account.account_number` field for US accounts. Minimum string length: `12` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#body-routing-number) routing\_number string deprecated Routing number of your bank account. This field is getting deprecated in favor of the `account.routing_number` field for US accounts. Minimum string length: `9` #### Response 201 application/json External Account object created US bank account using account and routing numbers for ACH or Wire transfers [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-customer-id) customer\_id string required The id of the Bridge customer that this External Account belongs to Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-account-owner-name) account\_owner\_name string required Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns: * ach: `^(?!\s*$)[\x20-\x7E]*$` * wire: ``^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$`` Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-created-at) created\_at string required Time of creation of the External Account [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-updated-at) updated\_at string required Time of last update of the External Account [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-active) active boolean required Whether or not this External Account is active [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-account-type) account\_type enum required Type of the bank account. Available options: `us` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-currency) currency enum required Currency associated with the bank account. Must be `usd` for US accounts. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-account) account us · object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-bank-name) bank\_name string Bank name of the account (e.g. "Chase") Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-account-owner-type) account\_owner\_type enum The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required. Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-first-name) first\_name string First name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-last-name) last\_name string Last name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-business-name) business\_name string Business name of the business account holder. Required when the `account_owner_type` is `business` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-deactivation-reason) deactivation\_reason enum Reason for deactivation when this External Account is inactive Available options: `plaid_item_error`, `deactivated_due_to_bounceback`, `deleted_by_developer`, `requested_by_developer`, `invalid_account_number`, `invalid_bank_validation`, `rejected_by_bank_provider` [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-deactivation-details) deactivation\_details string Additional details about the deactivation when this External Account is inactive [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-beneficiary-address-valid) beneficiary\_address\_valid boolean Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts [​](https://apidocs.bridge.xyz/api-reference/developers/configure-a-fee-external-account#response-last-4) last\_4 string deprecated Last 4 digits of the bank account number. This field is getting deprecated in favor of the `account.last_4` field Minimum string length: `1` Was this page helpful? YesNo [Get the configured fee External Account](https://apidocs.bridge.xyz/api-reference/developers/get-the-configured-fee-external-account) [Get all KYC links.](https://apidocs.bridge.xyz/api-reference/kyc-links/get-all-kyc-links) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Generate a Plaid Link token for a customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Plaid Generate a Plaid Link token for a customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Generate a Plaid Link token for a customer cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/plaid_link_requests \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 201 PlaidLinkRequestSuccessResponse { "link_token": "plaid_link_token_123", "link_token_expires_at": "2023-03-23T03:22:34.086Z", "callback_url": "https://api.bridge.xyz/v0/plaid_exchange_public_token/plaid_link_token_123" } POST / customers / {customerID} / plaid\_link\_requests Try it Generate a Plaid Link token for a customer cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/plaid_link_requests \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 201 PlaidLinkRequestSuccessResponse { "link_token": "plaid_link_token_123", "link_token_expires_at": "2023-03-23T03:22:34.086Z", "callback_url": "https://api.bridge.xyz/v0/plaid_exchange_public_token/plaid_link_token_123" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 201 application/json Plaid Link token generated [​](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer#response-link-token) link\_token string Link token generated via the Plaid Link SDK [​](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer#response-link-token-expires-at) link\_token\_expires\_at string Expiration time of the link token [​](https://apidocs.bridge.xyz/api-reference/plaid/generate-a-plaid-link-token-for-a-customer#response-callback-url) callback\_url string URL to call through Plaid Link Flow's onSuccess callback with the public token passed in the body of the request Was this page helpful? YesNo [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) [Exchange Plaid public token for an access token](https://apidocs.bridge.xyz/api-reference/plaid/exchange-plaid-public-token-for-an-access-token) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get details for a specific Prefunded Account - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Prefunded Accounts Get details for a specific Prefunded Account [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get details for a specific Prefunded Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/prefunded_accounts/{prefundedAccountID} \ --header 'Api-Key: ' 200 SuccessfulPrefundedAccountResponse { "id": "f15972de-4cdd-460c-9da3-34f7321bfa3f", "currency": "usd", "available_balance": "134.12", "name": "my_account", "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } GET / prefunded\_accounts / {prefundedAccountID} Try it Get details for a specific Prefunded Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/prefunded_accounts/{prefundedAccountID} \ --header 'Api-Key: ' 200 SuccessfulPrefundedAccountResponse { "id": "f15972de-4cdd-460c-9da3-34f7321bfa3f", "currency": "usd", "available_balance": "134.12", "name": "my_account", "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account#parameter-prefunded-account-id) prefundedAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successful Prefunded Account object response [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account#response-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account#response-available-balance) available\_balance string required Amount available for spending, represented as a dollar denominated string. Examples include "100.25", "0.1", "1.234567", "1.01" etc. [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account#response-currency) currency enum required currency associated with the bank account. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account#response-name) name string required Serialized name of the account which identifies the counterparty. Was this page helpful? YesNo [Get a list of all Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account) [Get funding history of a Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a list of all Prefunded Account - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Prefunded Accounts Get a list of all Prefunded Account [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a list of all Prefunded Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/prefunded_accounts \ --header 'Api-Key: ' 200 PrefundedAccountsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulPrefundedAccountResponse/value"\ }\ ] } GET / prefunded\_accounts Try it Get a list of all Prefunded Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/prefunded_accounts \ --header 'Api-Key: ' 200 PrefundedAccountsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulPrefundedAccountResponse/value"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account#authorization-api-key) Api-Key string header required #### Response 200 application/json List of prefunded accounts. [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Get all static templates](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates) [Get details for a specific Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a summary of a customer's rewards - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Rewards Get a summary of a customer's rewards [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a summary of a customer's rewards cURL curl --request GET \ --url https://api.bridge.xyz/v0/rewards/{currency}/customer/{customerID} \ --header 'Api-Key: ' 200 CustomerRewardSummary { "developer_id": "2d127766-02fa-44b0-9fc8-a67665dbf109", "customer_id": "02513e85-b0f9-4d79-8320-348ce9efaa11", "currency": "xusd", "balance": "10000.00", "rewards": "23.9725", "updated_at": "2025-01-01T00:00:00.000Z" } GET / rewards / {currency} / customer / {customerID} Try it Get a summary of a customer's rewards cURL curl --request GET \ --url https://api.bridge.xyz/v0/rewards/{currency}/customer/{customerID} \ --header 'Api-Key: ' 200 CustomerRewardSummary { "developer_id": "2d127766-02fa-44b0-9fc8-a67665dbf109", "customer_id": "02513e85-b0f9-4d79-8320-348ce9efaa11", "currency": "xusd", "balance": "10000.00", "rewards": "23.9725", "updated_at": "2025-01-01T00:00:00.000Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#parameter-currency) currency string required The stablecoin symbol [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json The summary of a customer's rewards [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#response-developer-id) developer\_id string The developer ID of the customer [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#response-customer-id) customer\_id string The customer ID of the customer [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#response-currency) currency string The stablecoin symbol for the reward summary [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#response-balance) balance string The balance of the customer in the given stablecoin [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#response-rewards) rewards string The rewards of the customer in the given stablecoin [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards#response-updated-at) updated\_at string The timestamp of the last update to the reward summary, in ISO8601 format Was this page helpful? YesNo [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) [Get a history of a customer's rewards](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Generate a card account statement - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-account-statement#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Generate a card account statement [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Generate a card account statement cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/statements/{period}.pdf \ --header 'Api-Key: ' 200 Example "" POST / customers / {customerID} / card\_accounts / {cardAccountID} / statements / {period} .pdf Try it Generate a card account statement cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/statements/{period}.pdf \ --header 'Api-Key: ' 200 Example "" #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-account-statement#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-account-statement#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-account-statement#parameter-card-account-id) cardAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-account-statement#parameter-period) period string required A string in the `YYYYMM` format representing a card statement period #### Response 200 application/pdf The HTTP response that includes a PDF file as an attachment, with the `Content-Type` set to `application/pdf` and the `Content-Disposition` header configured to indicate it is a statement PDF attachment The response is of type `file`. Was this page helpful? YesNo [Retrieve a card withdrawal](https://apidocs.bridge.xyz/api-reference/cards/retrieve-a-card-withdrawal) [Generate a card statement using Stripe IDs](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a history of a customer's rewards - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Rewards Get a history of a customer's rewards [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a history of a customer's rewards cURL curl --request GET \ --url https://api.bridge.xyz/v0/rewards/{currency}/customer/{customerID}/history \ --header 'Api-Key: ' 200 CustomerRewardHistory { "customer_id": "02513e85-b0f9-4d79-8320-348ce9efaa11", "rewards": [\ {\ "balance": "10000.00",\ "amount": "0.958904",\ "currency": "xusd",\ "date": "2025-01-02"\ },\ {\ "balance": "10100.00",\ "amount": "0.968493",\ "currency": "xusd",\ "date": "2025-01-01"\ }\ ] } GET / rewards / {currency} / customer / {customerID} / history Try it Get a history of a customer's rewards cURL curl --request GET \ --url https://api.bridge.xyz/v0/rewards/{currency}/customer/{customerID}/history \ --header 'Api-Key: ' 200 CustomerRewardHistory { "customer_id": "02513e85-b0f9-4d79-8320-348ce9efaa11", "rewards": [\ {\ "balance": "10000.00",\ "amount": "0.958904",\ "currency": "xusd",\ "date": "2025-01-02"\ },\ {\ "balance": "10100.00",\ "amount": "0.968493",\ "currency": "xusd",\ "date": "2025-01-01"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards#parameter-currency) currency string required The stablecoin symbol [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json The history of a customer's rewards [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards#response-customer-id) customer\_id string The customer ID of the customer [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-history-of-a-customers-rewards#response-rewards) rewards object\[\] The rewards of the customer in the given stablecoin Show child attributes Was this page helpful? YesNo [Get a summary of a customer's rewards](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create Card PIN Update URL - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/create-card-pin-update-url#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Create Card PIN Update URL [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create Card PIN Update URL cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/pin \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 200 Example { "url": "https://secure.example.com/update-pin?token=xyz789" } POST / customers / {customerID} / card\_accounts / {cardAccountID} / pin Try it Create Card PIN Update URL cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/pin \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 200 Example { "url": "https://secure.example.com/update-pin?token=xyz789" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/create-card-pin-update-url#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/cards/create-card-pin-update-url#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/cards/create-card-pin-update-url#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/create-card-pin-update-url#parameter-card-account-id) cardAccountID string required The ID of the card account #### Response 200 application/json URL to update the card PIN Response containing a secure URL to update a card's PIN [​](https://apidocs.bridge.xyz/api-reference/cards/create-card-pin-update-url#response-url) url string required Single-use, time-limited URL that can be used to securely update the card PIN in an iframe Example: `"https://secure.example.com/update-pin?token=xyz789"` Was this page helpful? YesNo [Static Memo Activity Across All Customers](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity-across-all-customers) [Generate an Ephemeral Key to Reveal Card Details](https://apidocs.bridge.xyz/api-reference/cards/generate-an-ephemeral-key-to-reveal-card-details) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Cards - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/guides/cards/overview#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Provision and make card payments Cards [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Bridge cards let customers spend stablecoin balances virtually anywhere in the world that accept Visa - with a virtual card, a physical card, or a mobile wallet. Using Bridge APIs, you can seamlessly provision new cards for your customers, manage balances, and more. Bridge cards are: * **Multi-market:** Launch a card product in multiple markets with a single integration. * **Flexible:** Bridge supports custodial and non-custodial wallets. * **Integrated:** Use card issuing with virtual accounts and wallets to build seamless experiences around sending, receiving, storing and spending stablecoins. * **Revenue generating:** Generate revenue based on your customers’ card spend. Earn a share of profit earned from the card program. Refer the [Cards](https://apidocs.bridge.xyz/platform/cards/overview/overview) section for more in depth details. Was this page helpful? YesNo [Send wallet funds to a fiat external account](https://apidocs.bridge.xyz/get-started/guides/wallets/offramp) [Spend wallet balances using a card](https://apidocs.bridge.xyz/get-started/guides/cards/spend) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Geographies - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/geo#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation What we support Geographies [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) ### [​](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/geo#regional-availability) Regional Availability Bridge can be used to facilitate payments for customers in most countries not on the OFAC sanctions list. ### [​](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/geo#united-states-specific-details) United States Specific Details Within the United States, we can support your customers (both individuals and businesses) in most states, excluding those with a **principal residential or operating addresses (as applicable)** in New York. You can now onboard both businesses and individual users from Florida and Louisiana to transact with Bridge. For businesses, these exclusions can be complicated —a few examples below: * What we can support: * A business’s registered and operating address is in California, but they bank with Chase in New York City * A business is incorporated in New York but primarily operates out of California (Proof of Address verification required) * What we cannot support: * A business’s primary operating address is in New York, and they bank with Wells Fargo in California * A business is incorporated in California but primarily operates their business from within New York ### [​](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/geo#europe-specific-details) Europe Specific Details For customers in some European countries, we require proof of address. Refer [Proof of Address Requirements](https://apidocs.bridge.xyz/platform/customers/compliance/poa) for the list of countries. Was this page helpful? YesNo [Supported blockchains and fiat rails](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/payment-routes) [Dollar access](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/dollar-access) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all External Accounts - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation External Accounts Get all External Accounts [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all External Accounts cURL curl --request GET \ --url https://api.bridge.xyz/v0/external_accounts \ --header 'Api-Key: ' 200 ExternalAccountsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulExternalAccountResponse/value"\ }\ ] } GET / external\_accounts Try it Get all External Accounts cURL curl --request GET \ --url https://api.bridge.xyz/v0/external_accounts \ --header 'Api-Key: ' 200 ExternalAccountsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulExternalAccountResponse/value"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1#parameter-starting-after) starting\_after string This is an external account id. If this is specified, the next page that starts with an external account right AFTER the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts older than the specified external account id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1#parameter-ending-before) ending\_before string This is an external account id. If this is specified, the previous page that ends with an external account right BEFORE the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts newer than the specified external account id will be returned (shouldn't be set if starting\_after is set) #### Response 200 - application/json List of External Accounts (the returned list is empty if no External Accounts exist) [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1#response-data) data (ACH/Wire · object | IBAN · object | SWIFT · object | CLABE · object | Pix · object | GB · object | Bre-B · object)\[\] required US bank account using account and routing numbers for ACH or Wire transfers * ACH/Wire * IBAN * SWIFT * CLABE * Pix * GB * Bre-B Show child attributes [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1#response-count) count integer total number of items in data Was this page helpful? YesNo [Reactivate an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Reactivate an External Account - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation External Accounts Reactivate an External Account [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Reactivate an External Account cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}/reactivate \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 200 400 { "id": "", "customer_id": "", "account_owner_name": "", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "active": true, "account_type": "us", "currency": "usd", "account": { "routing_number": "", "last_4": "", "checking_or_savings": "checking" }, "bank_name": "", "account_owner_type": "individual", "first_name": "", "last_name": "", "business_name": "", "deactivation_reason": "plaid_item_error", "deactivation_details": "", "beneficiary_address_valid": true, "last_4": "", "account_validation": { "validated_account_owner_name": "", "validated_bank_name": "", "validated_document_number_last4": "" } } POST / customers / {customerID} / external\_accounts / {externalAccountID} / reactivate Try it Reactivate an External Account cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}/reactivate \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 200 400 { "id": "", "customer_id": "", "account_owner_name": "", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "active": true, "account_type": "us", "currency": "usd", "account": { "routing_number": "", "last_4": "", "checking_or_savings": "checking" }, "bank_name": "", "account_owner_type": "individual", "first_name": "", "last_name": "", "business_name": "", "deactivation_reason": "plaid_item_error", "deactivation_details": "", "beneficiary_address_valid": true, "last_4": "", "account_validation": { "validated_account_owner_name": "", "validated_bank_name": "", "validated_document_number_last4": "" } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#parameter-external-account-id) externalAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Reactivated External Account object * ACH/Wire * IBAN * SWIFT * CLABE * Pix * GB * Bre-B US bank account using account and routing numbers for ACH or Wire transfers [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-customer-id) customer\_id string required The id of the Bridge customer that this External Account belongs to Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-account-owner-name) account\_owner\_name string required Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns: * ach: `^(?!\s*$)[\x20-\x7E]*$` * wire: ``^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$`` Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-created-at) created\_at string required Time of creation of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-updated-at) updated\_at string required Time of last update of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-active) active boolean required Whether or not this External Account is active [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-account-type) account\_type enum required Type of the bank account. Available options: `us` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-currency) currency enum required Currency associated with the bank account. Must be `usd` for US accounts. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-account) account us · object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-bank-name) bank\_name string Bank name of the account (e.g. "Chase") Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-account-owner-type) account\_owner\_type enum The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required. Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-first-name) first\_name string First name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-last-name) last\_name string Last name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-business-name) business\_name string Business name of the business account holder. Required when the `account_owner_type` is `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-deactivation-reason) deactivation\_reason enum Reason for deactivation when this External Account is inactive Available options: `plaid_item_error`, `deactivated_due_to_bounceback`, `deleted_by_developer`, `requested_by_developer`, `invalid_account_number`, `invalid_bank_validation`, `rejected_by_bank_provider` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-deactivation-details) deactivation\_details string Additional details about the deactivation when this External Account is inactive [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-beneficiary-address-valid) beneficiary\_address\_valid boolean Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-last-4) last\_4 string deprecated Last 4 digits of the bank account number. This field is getting deprecated in favor of the `account.last_4` field Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account#response-one-of-0-account-validation-one-of-0) account\_validation object Present for Pix, SPEI/CLABE, and Bre-B accounts with a successful validation; contains validated owner and bank name. Show child attributes Was this page helpful? YesNo [Deactivate a single External Account object](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object) [Get all External Accounts](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts-1) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a summary of all rewards for a given stablecoin - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Rewards Get a summary of all rewards for a given stablecoin [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a summary of all rewards for a given stablecoin cURL curl --request GET \ --url https://api.bridge.xyz/v0/rewards/{currency} \ --header 'Api-Key: ' 200 RewardSummary { "developer_id": "2d127766-02fa-44b0-9fc8-a67665dbf109", "currency": "xusd", "balance": "10000.00", "rewards": "23.9725", "updated_at": "2025-01-01T00:00:00.000Z" } GET / rewards / {currency} Try it Get a summary of all rewards for a given stablecoin cURL curl --request GET \ --url https://api.bridge.xyz/v0/rewards/{currency} \ --header 'Api-Key: ' 200 RewardSummary { "developer_id": "2d127766-02fa-44b0-9fc8-a67665dbf109", "currency": "xusd", "balance": "10000.00", "rewards": "23.9725", "updated_at": "2025-01-01T00:00:00.000Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin#parameter-currency) currency string required The stablecoin symbol #### Response 200 application/json The 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#response-developer-id) developer\_id string The developer ID of the developer [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin#response-currency) currency string The stablecoin symbol for the reward summary [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin#response-balance) balance string The balance of the developer in the given stablecoin [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin#response-rewards) rewards string The rewards of the developer in the given stablecoin [​](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin#response-updated-at) updated\_at string The timestamp of the last update to the reward summary, in ISO8601 format Was this page helpful? YesNo [Delete a single crypto return policy object](https://apidocs.bridge.xyz/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object) [Get a summary of a customer's rewards](https://apidocs.bridge.xyz/api-reference/rewards/get-a-summary-of-a-customers-rewards) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all External Accounts - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation External Accounts Get all External Accounts [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all External Accounts cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts \ --header 'Api-Key: ' 200 ExternalAccountsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulExternalAccountResponse/value"\ }\ ] } GET / customers / {customerID} / external\_accounts Try it Get all External Accounts cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts \ --header 'Api-Key: ' 200 ExternalAccountsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulExternalAccountResponse/value"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#parameter-starting-after) starting\_after string This is an external account id. If this is specified, the next page that starts with an external account right AFTER the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts older than the specified external account id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#parameter-ending-before) ending\_before string This is an external account id. If this is specified, the previous page that ends with an external account right BEFORE the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts newer than the specified external account id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json List of External Accounts (the returned list is empty if no External Accounts exist) [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#response-data) data (ACH/Wire · object | IBAN · object | SWIFT · object | CLABE · object | Pix · object | GB · object | Bre-B · object)\[\] required US bank account using account and routing numbers for ACH or Wire transfers * ACH/Wire * IBAN * SWIFT * CLABE * Pix * GB * Bre-B Show child attributes [​](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts#response-count) count integer total number of items in data Was this page helpful? YesNo [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) [Create a new External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/create-a-new-external-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get the balance of a Liquidation Address (deprecated) - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Get the balance of a Liquidation Address (deprecated) [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get the balance of a Liquidation Address (deprecated) cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/balances \ --header 'Api-Key: ' 200 DrainsFound { "active_balance": "0", "pending_balance": "100.25" } GET / customers / {customerID} / liquidation\_addresses / {liquidationAddressID} / balances Try it Get the balance of a Liquidation Address (deprecated) cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/balances \ --header 'Api-Key: ' 200 DrainsFound { "active_balance": "0", "pending_balance": "100.25" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated#parameter-liquidation-address-id) liquidationAddressID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Get the current balance of a Liquidation Address [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated#response-data) data object deprecated Show child attributes Was this page helpful? YesNo [Get drain history of a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address) [Liquidation Address Activity Across All Customers](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all Liquidation Addresses - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Get all Liquidation Addresses [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all Liquidation Addresses cURL curl --request GET \ --url https://api.bridge.xyz/v0/liquidation_addresses \ --header 'Api-Key: ' 200 Example { "count": 123, "data": [\ {\ "id": "",\ "currency": "usdb",\ "chain": "arbitrum",\ "customer_id": "",\ "external_account_id": "",\ "destination_payment_rail": "ach",\ "destination_currency": "brl",\ "address": "",\ "created_at": "2023-11-07T05:31:56Z",\ "updated_at": "2023-11-07T05:31:56Z",\ "prefunded_account_id": "",\ "custom_developer_fee_percent": "0.1",\ "global_developer_fee_percent": {\ "percent": "0.2"\ },\ "destination_wire_message": "",\ "destination_sepa_reference": "",\ "destination_spei_reference": "",\ "destination_ach_reference": "",\ "destination_address": "",\ "destination_blockchain_memo": "",\ "return_address": "",\ "state": ""\ }\ ] } GET / liquidation\_addresses Try it Get all Liquidation Addresses cURL curl --request GET \ --url https://api.bridge.xyz/v0/liquidation_addresses \ --header 'Api-Key: ' 200 Example { "count": 123, "data": [\ {\ "id": "",\ "currency": "usdb",\ "chain": "arbitrum",\ "customer_id": "",\ "external_account_id": "",\ "destination_payment_rail": "ach",\ "destination_currency": "brl",\ "address": "",\ "created_at": "2023-11-07T05:31:56Z",\ "updated_at": "2023-11-07T05:31:56Z",\ "prefunded_account_id": "",\ "custom_developer_fee_percent": "0.1",\ "global_developer_fee_percent": {\ "percent": "0.2"\ },\ "destination_wire_message": "",\ "destination_sepa_reference": "",\ "destination_spei_reference": "",\ "destination_ach_reference": "",\ "destination_address": "",\ "destination_blockchain_memo": "",\ "return_address": "",\ "state": ""\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses#parameter-starting-after) starting\_after string This is a liquidation address id. If this is specified, the next page that starts with a liquidation address right AFTER the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address older than the specified liquidation address id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses#parameter-ending-before) ending\_before string This is a liquidation address id. If this is specified, the previous page that ends with a liquidation address right BEFORE the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address newer than the specified liquidation address id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json List of Liquidation Addresses (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Create a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address) [Get a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Deactivate a single External Account object - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation External Accounts Deactivate a single External Account object [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Deactivate a single External Account object cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \ --header 'Api-Key: ' 200 DeletedExternalAccountResponse { "id": "ea_123", "account_type": "us", "currency": "usd", "customer_id": "cust_123", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } DELETE / customers / {customerID} / external\_accounts / {externalAccountID} Try it Deactivate a single External Account object cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \ --header 'Api-Key: ' 200 DeletedExternalAccountResponse { "id": "ea_123", "account_type": "us", "currency": "usd", "customer_id": "cust_123", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#parameter-external-account-id) externalAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successfully deleted External Account object response * ACH/Wire * IBAN * SWIFT * CLABE * Pix * GB * Bre-B US bank account using account and routing numbers for ACH or Wire transfers [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-customer-id) customer\_id string required The id of the Bridge customer that this External Account belongs to Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-account-owner-name) account\_owner\_name string required Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns: * ach: `^(?!\s*$)[\x20-\x7E]*$` * wire: ``^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$`` Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-created-at) created\_at string required Time of creation of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-updated-at) updated\_at string required Time of last update of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-active) active boolean required Whether or not this External Account is active [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-account-type) account\_type enum required Type of the bank account. Available options: `us` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-currency) currency enum required Currency associated with the bank account. Must be `usd` for US accounts. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-account) account us · object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-bank-name) bank\_name string Bank name of the account (e.g. "Chase") Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-account-owner-type) account\_owner\_type enum The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required. Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-first-name) first\_name string First name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-last-name) last\_name string Last name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-business-name) business\_name string Business name of the business account holder. Required when the `account_owner_type` is `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-deactivation-reason) deactivation\_reason enum Reason for deactivation when this External Account is inactive Available options: `plaid_item_error`, `deactivated_due_to_bounceback`, `deleted_by_developer`, `requested_by_developer`, `invalid_account_number`, `invalid_bank_validation`, `rejected_by_bank_provider` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-deactivation-details) deactivation\_details string Additional details about the deactivation when this External Account is inactive [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-beneficiary-address-valid) beneficiary\_address\_valid boolean Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-last-4) last\_4 string deprecated Last 4 digits of the bank account number. This field is getting deprecated in favor of the `account.last_4` field Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object#response-one-of-0-account-validation-one-of-0) account\_validation object Present for Pix, SPEI/CLABE, and Bre-B accounts with a successful validation; contains validated owner and bank name. Show child attributes Was this page helpful? YesNo [Update an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account) [Reactivate an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/reactivate-an-external-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Retrieve an External Account object - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation External Accounts Retrieve an External Account object [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Retrieve an External Account object cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \ --header 'Api-Key: ' 200 SuccessfulExternalAccountResponse { "id": "ea_123", "account_type": "us", "currency": "usd", "customer_id": "cust_123", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } GET / customers / {customerID} / external\_accounts / {externalAccountID} Try it Retrieve an External Account object cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \ --header 'Api-Key: ' 200 SuccessfulExternalAccountResponse { "id": "ea_123", "account_type": "us", "currency": "usd", "customer_id": "cust_123", "account_owner_name": "John Doe", "bank_name": "Wells Fargo", "last_4": "1111", "active": true, "beneficiary_address_valid": true, "account": { "last_4": "1111", "routing_number": "121000248", "checking_or_savings": "checking" }, "created_at": "2020-01-01T00:00:00.000Z", "updated_at": "2020-01-02T00:00:00.000Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#parameter-external-account-id) externalAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successful External Account object response * ACH/Wire * IBAN * SWIFT * CLABE * Pix * GB * Bre-B US bank account using account and routing numbers for ACH or Wire transfers [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-customer-id) customer\_id string required The id of the Bridge customer that this External Account belongs to Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-account-owner-name) account\_owner\_name string required Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns: * ach: `^(?!\s*$)[\x20-\x7E]*$` * wire: ``^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$`` Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-created-at) created\_at string required Time of creation of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-updated-at) updated\_at string required Time of last update of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-active) active boolean required Whether or not this External Account is active [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-account-type) account\_type enum required Type of the bank account. Available options: `us` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-currency) currency enum required Currency associated with the bank account. Must be `usd` for US accounts. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-account) account us · object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-bank-name) bank\_name string Bank name of the account (e.g. "Chase") Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-account-owner-type) account\_owner\_type enum The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required. Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-first-name) first\_name string First name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-last-name) last\_name string Last name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-business-name) business\_name string Business name of the business account holder. Required when the `account_owner_type` is `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-deactivation-reason) deactivation\_reason enum Reason for deactivation when this External Account is inactive Available options: `plaid_item_error`, `deactivated_due_to_bounceback`, `deleted_by_developer`, `requested_by_developer`, `invalid_account_number`, `invalid_bank_validation`, `rejected_by_bank_provider` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-deactivation-details) deactivation\_details string Additional details about the deactivation when this External Account is inactive [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-beneficiary-address-valid) beneficiary\_address\_valid boolean Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-last-4) last\_4 string deprecated Last 4 digits of the bank account number. This field is getting deprecated in favor of the `account.last_4` field Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object#response-one-of-0-account-validation-one-of-0) account\_validation object Present for Pix, SPEI/CLABE, and Bre-B accounts with a successful validation; contains validated owner and bank name. Show child attributes Was this page helpful? YesNo [Create a new External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/create-a-new-external-account) [Update an External Account](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get occupation codes - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/lists/get-occupation-codes#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Lists Get occupation codes [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get occupation codes cURL curl --request GET \ --url https://api.bridge.xyz/v0/lists/occupation_codes \ --header 'Api-Key: ' 200 [\ {\ "display_name": "Accountant and auditor",\ "code": "132011"\ },\ {\ "display_name": "Actor",\ "code": "272011"\ },\ {\ "display_name": "Acupuncturist",\ "code": "291291"\ },\ {\ "display_name": "Administrative services manager",\ "code": "113012"\ },\ {\ "display_name": "Other",\ "code": "other"\ }\ ] GET / lists / occupation\_codes Try it Get occupation codes cURL curl --request GET \ --url https://api.bridge.xyz/v0/lists/occupation_codes \ --header 'Api-Key: ' 200 [\ {\ "display_name": "Accountant and auditor",\ "code": "132011"\ },\ {\ "display_name": "Actor",\ "code": "272011"\ },\ {\ "display_name": "Acupuncturist",\ "code": "291291"\ },\ {\ "display_name": "Administrative services manager",\ "code": "113012"\ },\ {\ "display_name": "Other",\ "code": "other"\ }\ ] #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/lists/get-occupation-codes#authorization-api-key) Api-Key string header required #### Response 200 - application/json The list of occupations that can be used during the KYC flow. [​](https://apidocs.bridge.xyz/api-reference/lists/get-occupation-codes#response-items-display-name) display\_name string Human readable name that customers can select. Example: `"Accountant and auditor"` [​](https://apidocs.bridge.xyz/api-reference/lists/get-occupation-codes#response-items-code) code string The corresponding code that should be sent to the Bridge API representing the customers selection. Example: `"132011"` Was this page helpful? YesNo [Get current exchange rate between two currencies.](https://apidocs.bridge.xyz/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies) [Get countries](https://apidocs.bridge.xyz/api-reference/lists/get-countries) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a mobile wallet push provisioning request - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Create a mobile wallet push provisioning request [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a mobile wallet push provisioning request cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/create_mobile_wallet_provisioning_request \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "wallet_provider": "apple_pay" } ' 200 Example { "wallet_provider": "apple_pay", "apple_pay": { "activation_data": "", "encrypted_pass_data": "", "ephemeral_public_key": "" }, "google_pay": { "opaque_payment_card": "" } } POST / customers / {customerID} / card\_accounts / {cardAccountID} / create\_mobile\_wallet\_provisioning\_request Try it Create a mobile wallet push provisioning request cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/create_mobile_wallet_provisioning_request \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "wallet_provider": "apple_pay" } ' 200 Example { "wallet_provider": "apple_pay", "apple_pay": { "activation_data": "", "encrypted_pass_data": "", "ephemeral_public_key": "" }, "google_pay": { "opaque_payment_card": "" } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#parameter-card-account-id) cardAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json A mobile wallet push provisioning request [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#body-wallet-provider) wallet\_provider enum The wallet provider of the push provisioning request Available options: `apple_pay`, `google_pay` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#body-apple-pay) apple\_pay object Apple Pay specific provisioning request data. Required for `apple_pay` wallet provider. Show child attributes [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#body-google-pay) google\_pay object Google Pay specific push provisioning request data. Required for `google_pay` wallet provider. Show child attributes #### Response 200 application/json A successful push provisioning response The mobile wallet push provisioning response [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#response-wallet-provider) wallet\_provider enum The wallet provider of the push provisioning request Available options: `apple_pay`, `google_pay` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#response-apple-pay) apple\_pay object The detailed provisioning request data that need to be sent directly to the `apple_pay` wallet provider Show child attributes [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-mobile-wallet-push-provisioning-request#response-google-pay) google\_pay object The detailed provisioning request data that need to be sent directly to the `google_pay` wallet provider Show child attributes Was this page helpful? YesNo [Unfreeze the card account](https://apidocs.bridge.xyz/api-reference/cards/unfreeze-the-card-account) [Retrieve pending card authorizations](https://apidocs.bridge.xyz/api-reference/cards/retrieve-pending-card-authorizations) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get drain history of a Liquidation Address - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Get drain history of a Liquidation Address [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get drain history of a Liquidation Address cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains \ --header 'Api-Key: ' 200 DrainsToCryptoFound { "count": 1, "data": [\ {\ "id": "la_123",\ "amount": "100.25",\ "customer_id": "cust_123",\ "liquidation_address_id": "la_456",\ "currency": "usdc",\ "state": "funds_received",\ "created_at": "2020-01-01T00:00:00.000Z",\ "updated_at": "2020-01-01T00:00:00.000Z",\ "deposit_tx_hash": "0xc13d7905be5c989378a945487cd2a1193627ae606009e28e296d48ddaec66162",\ "destination": {\ "payment_rail": "ethereum",\ "currency": "usdt",\ "to_address": "0xb794f5ea0ba39494ce839613fffba74279579268"\ },\ "destination_tx_hash": "0xdeadbeef",\ "receipt": {\ "initial_amount": "100.25",\ "developer_fee": "0.2",\ "subtotal_amount": "100.05",\ "exchange_rate": "1.000000",\ "converted_amount": "100.05",\ "outgoing_amount": "100.05",\ "destination_currency": "usd",\ "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"\ }\ }\ ] } GET / customers / {customerID} / liquidation\_addresses / {liquidationAddressID} / drains Try it Get drain history of a Liquidation Address cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains \ --header 'Api-Key: ' 200 DrainsToCryptoFound { "count": 1, "data": [\ {\ "id": "la_123",\ "amount": "100.25",\ "customer_id": "cust_123",\ "liquidation_address_id": "la_456",\ "currency": "usdc",\ "state": "funds_received",\ "created_at": "2020-01-01T00:00:00.000Z",\ "updated_at": "2020-01-01T00:00:00.000Z",\ "deposit_tx_hash": "0xc13d7905be5c989378a945487cd2a1193627ae606009e28e296d48ddaec66162",\ "destination": {\ "payment_rail": "ethereum",\ "currency": "usdt",\ "to_address": "0xb794f5ea0ba39494ce839613fffba74279579268"\ },\ "destination_tx_hash": "0xdeadbeef",\ "receipt": {\ "initial_amount": "100.25",\ "developer_fee": "0.2",\ "subtotal_amount": "100.05",\ "exchange_rate": "1.000000",\ "converted_amount": "100.05",\ "outgoing_amount": "100.05",\ "destination_currency": "usd",\ "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"\ }\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#parameter-liquidation-address-id) liquidationAddressID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#parameter-starting-after) starting\_after string This is a drain id. If this is specified, the next page that starts with a drain right AFTER the specified drain id on the drain timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that drains older than the specified drain id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#parameter-ending-before) ending\_before string This is a drain id. If this is specified, the previous page that ends with a drain right BEFORE the specified drain id on the drain timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that drains newer than the specified drain id will be returned (shouldn't be set if starting\_after is set) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#parameter-updated-after-ms) updated\_after\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#parameter-updated-before-ms) updated\_before\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned #### Response 200 application/json List of drains (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address#response-data) data object Show child attributes Was this page helpful? YesNo [Update a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address) [Get the balance of a Liquidation Address (deprecated)](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get funding history of a Prefunded Account - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Prefunded Accounts Get funding history of a Prefunded Account [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get funding history of a Prefunded Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/prefunded_accounts/{prefundedAccountID}/history \ --header 'Api-Key: ' 200 SuccessfulCustomerResponse { "count": 1, "data": [\ {\ "id": "abced012-4cdd-460c-9da3-34f7321bfa3f",\ "amount": "500.00",\ "available_balance": "1300.31",\ "currency": "usd",\ "name": "my_account",\ "type": "funding",\ "created_at": "2020-01-01T00:00:00.000Z"\ }\ ] } GET / prefunded\_accounts / {prefundedAccountID} / history Try it Get funding history of a Prefunded Account cURL curl --request GET \ --url https://api.bridge.xyz/v0/prefunded_accounts/{prefundedAccountID}/history \ --header 'Api-Key: ' 200 SuccessfulCustomerResponse { "count": 1, "data": [\ {\ "id": "abced012-4cdd-460c-9da3-34f7321bfa3f",\ "amount": "500.00",\ "available_balance": "1300.31",\ "currency": "usd",\ "name": "my_account",\ "type": "funding",\ "created_at": "2020-01-01T00:00:00.000Z"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#parameter-prefunded-account-id) prefundedAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#parameter-starting-after) starting\_after string This is a prefunded event id. If this is specified, the next page that starts with an event right AFTER the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events older than the specified event id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#parameter-ending-before) ending\_before string This is a prefunded event id. If this is specified, the previous page that ends with an event right BEFORE the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events newer than the specified event id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json Successful Prefunded Account object response [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-amount) amount string required Amount of the transaction, represented as a dollar denominated string. Examples include "100.25", "0.1", "1.234567", "1.01" etc. [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-available-balance) available\_balance string required Amount available for spending, represented as a dollar denominated string. Examples include "100.25", "0.1", "1.234567", "1.01" etc. [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-currency) currency enum required currency associated with the bank account. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-name) name string required Serialized name of the account. [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-type) type enum required The type of the transaction. Available options: `funding`, `refunded transfer` [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-created-at) created\_at string required Time of creation of the External Account [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-withdrawal-id) withdrawal\_id string The ID of the transfer which created this event. Exclusive with deposit\_id. [​](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account#response-deposit-id) deposit\_id string The ID of the transfer which created this event. Exclusive with withdrawal\_id. Was this page helpful? YesNo [Get details for a specific Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account) [Get all Liquidation Addresses for a customer](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Liquidation Address Activity Across All Customers - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Liquidation Address Activity Across All Customers [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Liquidation Address Activity Across All Customers cURL curl --request GET \ --url https://api.bridge.xyz/v0/liquidation_addresses/drains \ --header 'Api-Key: ' 200 DrainsToCryptoFound { "count": 1, "data": [\ {\ "id": "la_123",\ "amount": "100.25",\ "customer_id": "cust_123",\ "liquidation_address_id": "la_456",\ "currency": "usdc",\ "state": "funds_received",\ "created_at": "2020-01-01T00:00:00.000Z",\ "updated_at": "2020-01-01T00:00:00.000Z",\ "deposit_tx_hash": "0xc13d7905be5c989378a945487cd2a1193627ae606009e28e296d48ddaec66162",\ "destination": {\ "payment_rail": "ethereum",\ "currency": "usdt",\ "to_address": "0xb794f5ea0ba39494ce839613fffba74279579268"\ },\ "destination_tx_hash": "0xdeadbeef",\ "receipt": {\ "initial_amount": "100.25",\ "developer_fee": "0.2",\ "subtotal_amount": "100.05",\ "exchange_rate": "1.000000",\ "converted_amount": "100.05",\ "outgoing_amount": "100.05",\ "destination_currency": "usd",\ "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"\ }\ }\ ] } GET / liquidation\_addresses / drains Try it Liquidation Address Activity Across All Customers cURL curl --request GET \ --url https://api.bridge.xyz/v0/liquidation_addresses/drains \ --header 'Api-Key: ' 200 DrainsToCryptoFound { "count": 1, "data": [\ {\ "id": "la_123",\ "amount": "100.25",\ "customer_id": "cust_123",\ "liquidation_address_id": "la_456",\ "currency": "usdc",\ "state": "funds_received",\ "created_at": "2020-01-01T00:00:00.000Z",\ "updated_at": "2020-01-01T00:00:00.000Z",\ "deposit_tx_hash": "0xc13d7905be5c989378a945487cd2a1193627ae606009e28e296d48ddaec66162",\ "destination": {\ "payment_rail": "ethereum",\ "currency": "usdt",\ "to_address": "0xb794f5ea0ba39494ce839613fffba74279579268"\ },\ "destination_tx_hash": "0xdeadbeef",\ "receipt": {\ "initial_amount": "100.25",\ "developer_fee": "0.2",\ "subtotal_amount": "100.05",\ "exchange_rate": "1.000000",\ "converted_amount": "100.05",\ "outgoing_amount": "100.05",\ "destination_currency": "usd",\ "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"\ }\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#parameter-starting-after) starting\_after string This is a drain id. If this is specified, the next page that starts with a drain right AFTER the specified drain id on the drain timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that drains older than the specified drain id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#parameter-ending-before) ending\_before string This is a drain id. If this is specified, the previous page that ends with a drain right BEFORE the specified drain id on the drain timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that drains newer than the specified drain id will be returned (shouldn't be set if starting\_after is set) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#parameter-updated-after-ms) updated\_after\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#parameter-updated-before-ms) updated\_before\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned #### Response 200 application/json List of drains for all liquidation addresses (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#response-count) count integer required The number of events returned [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Get the balance of a Liquidation Address (deprecated)](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated) [List Virtual Accounts by Customer](https://apidocs.bridge.xyz/api-reference/virtual-accounts/list-virtual-accounts-by-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a Liquidation Address - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Get a Liquidation Address [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a Liquidation Address cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID} \ --header 'Api-Key: ' 200 SuccessfulLiquidationAddressGetResponse { "id": "la_123", "chain": "ethereum", "customer_id": "cust_123", "external_account_id": "ext_123", "address": "0x4d0280da2f2fDA5103914bCc5aad114743152A9c", "currency": "usdc", "destination_payment_rail": "wire", "destination_currency": "usd", "destination_wire_message": "a wire message", "state": "active", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } GET / customers / {customerID} / liquidation\_addresses / {liquidationAddressID} Try it Get a Liquidation Address cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID} \ --header 'Api-Key: ' 200 SuccessfulLiquidationAddressGetResponse { "id": "la_123", "chain": "ethereum", "customer_id": "cust_123", "external_account_id": "ext_123", "address": "0x4d0280da2f2fDA5103914bCc5aad114743152A9c", "currency": "usdc", "destination_payment_rail": "wire", "destination_currency": "usd", "destination_wire_message": "a wire message", "state": "active", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#parameter-liquidation-address-id) liquidationAddressID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json A Liquidation Address object response [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-currency) currency enum required Available options: `usdb`, `usdc`, `usdt`, `dai`, `pyusd`, `eurc` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-chain) chain enum required Available options: `arbitrum`, `avalanche_c_chain`, `base`, `celo`, `ethereum`, `optimism`, `polygon`, `solana`, `stellar`, `tempo`, `tron`, `evm` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-customer-id) customer\_id string required The ID of the customer who owns this liquidation address Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-external-account-id) external\_account\_id string required External bank account to which Bridge will send the funds. The currency associated with the External Account must match the destination currency. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-payment-rail) destination\_payment\_rail enum required The payment rail that Bridge will use to send funds to the customer. Available options: `ach`, `wire`, `ach_push`, `ach_same_day`, `arbitrum`, `avalanche_c_chain`, `base`, `bre_b`, `celo`, `ethereum`, `faster_payments`, `fiat_deposit_return`, `optimism`, `pix`, `polygon`, `sepa`, `solana`, `spei`, `stellar`, `swift`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-currency) destination\_currency enum required The currency that Bridge will use to send funds to the customer. Available options: `brl`, `cop`, `dai`, `eur`, `eurc`, `gbp`, `mxn`, `pyusd`, `usd`, `usdb`, `usdc`, `usdt` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-address) address string required The crypto wallet address the customer will send funds to in order to initiate the payment processing [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-created-at) created\_at string required Time of creation of the Liquidation Address [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-updated-at) updated\_at string required Time of last update of the Liquidation Address [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-prefunded-account-id) prefunded\_account\_id string The developer's prefunded account to which Bridge will send the funds. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-custom-developer-fee-percent-one-of-0) custom\_developer\_fee\_percent string | null The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-global-developer-fee-percent) global\_developer\_fee\_percent object The developer fee percent that will be default applied to all Liquidation Addresses. Show child attributes [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-wire-message) destination\_wire\_message string A message to be sent with a wire transfer. Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-sepa-reference) destination\_sepa\_reference string A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`&`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is "Payment via Bridge {unique\_token}". Required string length: `6 - 140` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-spei-reference) destination\_spei\_reference string A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space Required string length: `1 - 40` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-ach-reference) destination\_ach\_reference string A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces. Required string length: `1 - 10` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-address) destination\_address string The crypto wallet address that Bridge will use to send funds to the customer. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-destination-blockchain-memo) destination\_blockchain\_memo string The memo to include in the transaction, for blockchains that support memos only [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-return-address) return\_address string The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction. This address must be on the same chain specified for the liquidation address. Please note, this functionality is not supported on Stellar. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address#response-state) state string The state of the liquidation address. It could be "active" or "deactivated" Was this page helpful? YesNo [Get all Liquidation Addresses](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses) [Update a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all Liquidation Addresses for a customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Get all Liquidation Addresses for a customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all Liquidation Addresses for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses \ --header 'Api-Key: ' 200 Example { "count": 123, "data": [\ {\ "id": "",\ "currency": "usdb",\ "chain": "arbitrum",\ "customer_id": "",\ "external_account_id": "",\ "destination_payment_rail": "ach",\ "destination_currency": "brl",\ "address": "",\ "created_at": "2023-11-07T05:31:56Z",\ "updated_at": "2023-11-07T05:31:56Z",\ "prefunded_account_id": "",\ "custom_developer_fee_percent": "0.1",\ "global_developer_fee_percent": {\ "percent": "0.2"\ },\ "destination_wire_message": "",\ "destination_sepa_reference": "",\ "destination_spei_reference": "",\ "destination_ach_reference": "",\ "destination_address": "",\ "destination_blockchain_memo": "",\ "return_address": "",\ "state": ""\ }\ ] } GET / customers / {customerID} / liquidation\_addresses Try it Get all Liquidation Addresses for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses \ --header 'Api-Key: ' 200 Example { "count": 123, "data": [\ {\ "id": "",\ "currency": "usdb",\ "chain": "arbitrum",\ "customer_id": "",\ "external_account_id": "",\ "destination_payment_rail": "ach",\ "destination_currency": "brl",\ "address": "",\ "created_at": "2023-11-07T05:31:56Z",\ "updated_at": "2023-11-07T05:31:56Z",\ "prefunded_account_id": "",\ "custom_developer_fee_percent": "0.1",\ "global_developer_fee_percent": {\ "percent": "0.2"\ },\ "destination_wire_message": "",\ "destination_sepa_reference": "",\ "destination_spei_reference": "",\ "destination_ach_reference": "",\ "destination_address": "",\ "destination_blockchain_memo": "",\ "return_address": "",\ "state": ""\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#parameter-starting-after) starting\_after string This is a liquidation address id. If this is specified, the next page that starts with a liquidation address right AFTER the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address older than the specified liquidation address id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#parameter-ending-before) ending\_before string This is a liquidation address id. If this is specified, the previous page that ends with a liquidation address right BEFORE the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address newer than the specified liquidation address id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json List of Liquidation Addresses (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Get funding history of a Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account) [Create a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get set up with Bridge - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/introduction/quick-start/get-set-up-with-bridge#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Get started Get set up with Bridge [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) ### [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/get-set-up-with-bridge#step-1-create-a-bridge-account) Step 1: Create a Bridge account **Are you an existing developer?** Head over to [dashboard.bridge.xyz](https://dashboard.bridge.xyz/) to login to your Bridge Dashboard. **Do you want to get started?** [Contact sales](https://www.bridge.xyz/requestfreedemo) . ### [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/get-set-up-with-bridge#step-2-create-your-api-keys) Step 2: Create your API keys Once logged in, click on the “API Keys” tab on the top menu bar and generate a new API key. Safely store your API keys Bridge will make your **API key available only once**, so make sure to **immediately copy and save the key safely and securely**. Your key is used to authenticate into our APIs and is highly sensitive. If it ever gets compromised, you can immediately revoke key access from our dashboard and generate a new key. ### [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/get-set-up-with-bridge#step-3-follow-our-guides-and-start-moving-money) Step 3: Follow our guides and start moving money. [**Create your first customer**](https://apidocs.bridge.xyz/get-started/introduction/quick-start/create-your-first-customer) - This guide walks you through creating your first customer and getting them verified [**Create a one-time payment**](https://apidocs.bridge.xyz/get-started/introduction/quick-start/create-a-one-time-payment) - This guide walks you through moving funds onchain through a bank [**Setting up webhooks**](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-webhooks) - This guide walks you through setting up and using Bridge webhooks to handle customer events in your application. Was this page helpful? YesNo [Platform overview](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview) [Onboard your first customer](https://apidocs.bridge.xyz/get-started/introduction/quick-start/create-your-first-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Update an External Account - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation External Accounts Update an External Account [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Update an External Account cURL curl --request PUT \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "address": { "street_line_1": "", "city": "", "country": "", "street_line_2": "", "state": "", "postal_code": "" }, "account": { "checking_or_savings": "checking", "routing_number": "" } } ' 200 Example { "id": "", "customer_id": "", "account_owner_name": "", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "active": true, "account_type": "us", "currency": "usd", "account": { "routing_number": "", "last_4": "", "checking_or_savings": "checking" }, "bank_name": "", "account_owner_type": "individual", "first_name": "", "last_name": "", "business_name": "", "deactivation_reason": "plaid_item_error", "deactivation_details": "", "beneficiary_address_valid": true, "last_4": "", "account_validation": { "validated_account_owner_name": "", "validated_bank_name": "", "validated_document_number_last4": "" } } PUT / customers / {customerID} / external\_accounts / {externalAccountID} Try it Update an External Account cURL curl --request PUT \ --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "address": { "street_line_1": "", "city": "", "country": "", "street_line_2": "", "state": "", "postal_code": "" }, "account": { "checking_or_savings": "checking", "routing_number": "" } } ' 200 Example { "id": "", "customer_id": "", "account_owner_name": "", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "active": true, "account_type": "us", "currency": "usd", "account": { "routing_number": "", "last_4": "", "checking_or_savings": "checking" }, "bank_name": "", "account_owner_type": "individual", "first_name": "", "last_name": "", "business_name": "", "deactivation_reason": "plaid_item_error", "deactivation_details": "", "beneficiary_address_valid": true, "last_4": "", "account_validation": { "validated_account_owner_name": "", "validated_bank_name": "", "validated_document_number_last4": "" } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#parameter-external-account-id) externalAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json External Account details to be updated [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#body-address) address object required address of the beneficiary of this account Show child attributes [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#body-account) account object US bank account information. Required when the `account_type` is `us`. Show child attributes #### Response 200 application/json External Account object updated * ACH/Wire * IBAN * SWIFT * CLABE * Pix * GB * Bre-B US bank account using account and routing numbers for ACH or Wire transfers [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-customer-id) customer\_id string required The id of the Bridge customer that this External Account belongs to Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-account-owner-name) account\_owner\_name string required Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns: * ach: `^(?!\s*$)[\x20-\x7E]*$` * wire: ``^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$`` Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-created-at) created\_at string required Time of creation of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-updated-at) updated\_at string required Time of last update of the External Account [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-active) active boolean required Whether or not this External Account is active [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-account-type) account\_type enum required Type of the bank account. Available options: `us` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-currency) currency enum required Currency associated with the bank account. Must be `usd` for US accounts. Available options: `usd` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-account) account us · object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-bank-name) bank\_name string Bank name of the account (e.g. "Chase") Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-account-owner-type) account\_owner\_type enum The type of the account ownership. Required when the `account_type` is `iban`. For `individual` ownership, `first_name` and `last_name` are required. For `business` ownership, `business_name` is required. Available options: `individual`, `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-first-name) first\_name string First name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-last-name) last\_name string Last name of the individual account holder. Required when the `account_owner_type` is `individual` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-business-name) business\_name string Business name of the business account holder. Required when the `account_owner_type` is `business` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-deactivation-reason) deactivation\_reason enum Reason for deactivation when this External Account is inactive Available options: `plaid_item_error`, `deactivated_due_to_bounceback`, `deleted_by_developer`, `requested_by_developer`, `invalid_account_number`, `invalid_bank_validation`, `rejected_by_bank_provider` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-deactivation-details) deactivation\_details string Additional details about the deactivation when this External Account is inactive [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-beneficiary-address-valid) beneficiary\_address\_valid boolean Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-last-4) last\_4 string deprecated Last 4 digits of the bank account number. This field is getting deprecated in favor of the `account.last_4` field Minimum string length: `1` [​](https://apidocs.bridge.xyz/api-reference/external-accounts/update-an-external-account#response-one-of-0-account-validation-one-of-0) account\_validation object Present for Pix, SPEI/CLABE, and Bre-B accounts with a successful validation; contains validated owner and bank name. Show child attributes Was this page helpful? YesNo [Retrieve an External Account object](https://apidocs.bridge.xyz/api-reference/external-accounts/retrieve-an-external-account-object) [Deactivate a single External Account object](https://apidocs.bridge.xyz/api-reference/external-accounts/deactivate-a-single-external-account-object) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Custodial wallets - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/guides/wallets/overview#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Integrate custodial wallets Custodial wallets [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Bridge offers fully managed, compliant custody for stablecoins with no third-party integrations required. Using Bridge wallets, you can: * Create wallets for your customers or your business. * Transfer stablecoins in and out using orchestration APIs. * Query balances and transfer history. * Tag and organize wallets as needed. Before creating wallets, make sure you have onboarded your customer and finished any required KYC/KYB or endorsements. Learn more at [wallets](https://apidocs.bridge.xyz/platform/wallets/overview) . Was this page helpful? YesNo [BTC and ETH Support](https://apidocs.bridge.xyz/get-started/guides/move-money/btc-and-eth-support) [Send fiat deposits to your wallet](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a funds withdrawal request - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Create a funds withdrawal request [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a funds withdrawal request cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/withdrawals \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "amount": "", "destination": { "chain": "", "address": "", "memo": "" }, "type": "top_up_balance_withdrawal", "client_note": "" } ' 201 Example { "id": "", "card_account_id": "", "customer_id": "", "amount": "", "currency": "usdc", "destination": { "chain": "", "address": "", "memo": "", "tx_hash": "" }, "created_at": "", "updated_at": "", "type": "top_up_balance_withdrawal", "client_note": "" } POST / customers / {customerID} / card\_accounts / {cardAccountID} / withdrawals Try it Create a funds withdrawal request cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/withdrawals \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "amount": "", "destination": { "chain": "", "address": "", "memo": "" }, "type": "top_up_balance_withdrawal", "client_note": "" } ' 201 Example { "id": "", "card_account_id": "", "customer_id": "", "amount": "", "currency": "usdc", "destination": { "chain": "", "address": "", "memo": "", "tx_hash": "" }, "created_at": "", "updated_at": "", "type": "top_up_balance_withdrawal", "client_note": "" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#parameter-card-account-id) cardAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json The withdrawal request A card funds withdrawal [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#body-amount) amount string required The amount represented as a decimal string [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#body-destination) destination object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#body-type) type enum The type of the withdrawal. Defaults to `top_up_balance_withdrawal`. Available options: `top_up_balance_withdrawal`, `fee` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#body-client-note) client\_note string An optional client-provided note for the withdrawal #### Response 201 application/json The successfully created card funds withdrawal A card funds withdrawal [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-id) id string required ID of the withdrawal Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-card-account-id) card\_account\_id string required ID of the card account associated with the withdrawal Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-customer-id) customer\_id string required ID of the customer who owns the card account Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-amount) amount string required The amount represented as a decimal string [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-currency) currency enum required The currency of the withdrawal, which is the crypto currency on the card account Available options: `usdc` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-destination) destination object required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-created-at) created\_at string required Timestamp when the withdrawal was created, in ISO8601 format [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-updated-at) updated\_at string required Timestamp when the withdrawal was last updated, in ISO8601 format [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-type) type enum The type of the withdrawal. Defaults to `top_up_balance_withdrawal`. Available options: `top_up_balance_withdrawal`, `fee` [​](https://apidocs.bridge.xyz/api-reference/cards/create-a-funds-withdrawal-request#response-client-note) client\_note string An optional client-provided note for the withdrawal Was this page helpful? YesNo [Retrieve the withdrawal history of funds](https://apidocs.bridge.xyz/api-reference/cards/retrieve-the-withdrawal-history-of-funds) [Retrieve a card withdrawal](https://apidocs.bridge.xyz/api-reference/cards/retrieve-a-card-withdrawal) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a Liquidation Address - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Create a Liquidation Address [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a Liquidation Address cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "currency": "usdb", "chain": "arbitrum", "external_account_id": "", "prefunded_account_id": "", "bridge_wallet_id": "", "destination_wire_message": "", "destination_sepa_reference": "", "destination_ach_reference": "", "destination_spei_reference": "", "destination_reference": "", "destination_payment_rail": "ach", "destination_currency": "brl", "destination_address": "", "destination_blockchain_memo": "", "return_address": "", "custom_developer_fee_percent": "0.1" } ' 201 SuccessfulLiquidationAddressCreateResponse { "id": "la_123", "chain": "ethereum", "customer_id": "cust_123", "external_account_id": "ext_123", "address": "0x4d0280da2f2fDA5103914bCc5aad114743152A9c", "currency": "usdc", "state": "active", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } POST / customers / {customerID} / liquidation\_addresses Try it Create a Liquidation Address cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "currency": "usdb", "chain": "arbitrum", "external_account_id": "", "prefunded_account_id": "", "bridge_wallet_id": "", "destination_wire_message": "", "destination_sepa_reference": "", "destination_ach_reference": "", "destination_spei_reference": "", "destination_reference": "", "destination_payment_rail": "ach", "destination_currency": "brl", "destination_address": "", "destination_blockchain_memo": "", "return_address": "", "custom_developer_fee_percent": "0.1" } ' 201 SuccessfulLiquidationAddressCreateResponse { "id": "la_123", "chain": "ethereum", "customer_id": "cust_123", "external_account_id": "ext_123", "address": "0x4d0280da2f2fDA5103914bCc5aad114743152A9c", "currency": "usdc", "state": "active", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json Liquidation Address object to be created [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-currency) currency enum required Available options: `usdb`, `usdc`, `usdt`, `dai`, `pyusd`, `eurc` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-chain) chain enum required Available options: `arbitrum`, `avalanche_c_chain`, `base`, `celo`, `ethereum`, `optimism`, `polygon`, `solana`, `stellar`, `tempo`, `tron`, `evm` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-external-account-id) external\_account\_id string External bank account to which Bridge will send the funds. The currency associated with the External Account must match the destination currency. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-prefunded-account-id) prefunded\_account\_id string The developer's prefunded account id that Bridge will send the funds to. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-bridge-wallet-id) bridge\_wallet\_id string The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the payment rail. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-wire-message) destination\_wire\_message string A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 characters according to the Fedwire standard. Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-sepa-reference) destination\_sepa\_reference string A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`&`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is "Payment via Bridge {unique\_token}". Required string length: `6 - 140` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-ach-reference) destination\_ach\_reference string A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces. Required string length: `1 - 10` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-spei-reference) destination\_spei\_reference string A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space Required string length: `1 - 40` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-reference) destination\_reference string A payment reference message for newer payment rails (e.g. Pix). [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-payment-rail) destination\_payment\_rail enum The payment rail that Bridge will use to send funds to the customer. Will default to ACH if not specified. Available options: `ach`, `wire`, `ach_push`, `ach_same_day`, `arbitrum`, `avalanche_c_chain`, `base`, `bre_b`, `celo`, `ethereum`, `faster_payments`, `fiat_deposit_return`, `optimism`, `pix`, `polygon`, `sepa`, `solana`, `spei`, `stellar`, `swift`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-currency) destination\_currency enum The currency that Bridge will use to send funds to the customer. Will default to USD if not specified. Available options: `brl`, `cop`, `dai`, `eur`, `eurc`, `gbp`, `mxn`, `pyusd`, `usd`, `usdb`, `usdc`, `usdt` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-address) destination\_address string The crypto wallet address that Bridge will use to send funds to the customer. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-destination-blockchain-memo) destination\_blockchain\_memo string The memo to include in the transaction, for blockchains that support memos only [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-return-address) return\_address string The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction. This address must be on the same chain specified for the liquidation address. Please note, this functionality is not supported on Stellar. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#body-custom-developer-fee-percent-one-of-0) custom\_developer\_fee\_percent string | null The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` #### Response 201 application/json Liquidation Address object created [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-currency) currency enum required Available options: `usdb`, `usdc`, `usdt`, `dai`, `pyusd`, `eurc` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-chain) chain enum required Available options: `arbitrum`, `avalanche_c_chain`, `base`, `celo`, `ethereum`, `optimism`, `polygon`, `solana`, `stellar`, `tempo`, `tron`, `evm` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-payment-rail) destination\_payment\_rail enum required The payment rail that Bridge will use to send funds to the customer. Available options: `ach`, `wire`, `ach_push`, `ach_same_day`, `arbitrum`, `avalanche_c_chain`, `base`, `bre_b`, `celo`, `ethereum`, `faster_payments`, `fiat_deposit_return`, `optimism`, `pix`, `polygon`, `sepa`, `solana`, `spei`, `stellar`, `swift`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-currency) destination\_currency enum required The currency that Bridge will use to send funds to the customer. Available options: `brl`, `cop`, `dai`, `eur`, `eurc`, `gbp`, `mxn`, `pyusd`, `usd`, `usdb`, `usdc`, `usdt` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-external-account-id) external\_account\_id string External bank account to which Bridge will send the funds. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-prefunded-account-id) prefunded\_account\_id string The developer's prefunded account to which Bridge will send the funds. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-bridge-wallet-id) bridge\_wallet\_id string The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the payment rail. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-wire-message) destination\_wire\_message string A message to be sent with a wire transfer. Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-sepa-reference) destination\_sepa\_reference string A reference message to be sent with a SEPA transaction. Required string length: `6 - 140` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-ach-reference) destination\_ach\_reference string A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces. Required string length: `1 - 10` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-spei-reference) destination\_spei\_reference string A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space Required string length: `1 - 40` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-reference) destination\_reference string A payment reference message for newer payment rails (e.g. Pix). [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-address) destination\_address string The crypto wallet address that Bridge will use to send funds to the customer. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-destination-blockchain-memo) destination\_blockchain\_memo string The memo to include in the transaction, for blockchains that support memos only [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-return-address) return\_address string The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction. This address must be on the same chain specified for the liquidation address. Please note, this functionality is not supported on Stellar. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-custom-developer-fee-percent-one-of-0) custom\_developer\_fee\_percent string | null The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-address) address string The blockchain address the customer will send funds to. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#response-state) state string The state of the liquidation address. It could be "active" or "deactivated" Was this page helpful? YesNo [Get all Liquidation Addresses for a customer](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer) [Get all Liquidation Addresses](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Supported blockchains and fiat rails - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/payment-routes#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation What we support Supported blockchains and fiat rails [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) The following stablecoins and blockchains are supported across all Bridge APIs. Note that **USDB** is Bridge’s native stablecoin and **earns rewards automatically** when held. Interested in support for other assets or blockchains? **Contact us directly** to discuss integration. ### [​](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/payment-routes#important) Important * ⚠️ Deposits sent to **unsupported asset/blockchain pairs** or to **incorrect addresses** may be **irretrievable and permanently lost**. * Make sure that you are sending amounts above the **transaction minimum**, learn more about how minimums are enforced [here](https://apidocs.bridge.xyz/platform/orchestration/fees-and-mins/mins) . Refer the below table for supported payment routes and transaction minimums. * **USDT and all Bridge issued stablecoins are not supported for users in the EEA** due to regulatory restrictions ### [​](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/payment-routes#supported-fiat-rails) **Supported fiat rails** * ACH (USD) * Wire (USD) * SEPA (EUR) * SPEI (MXN) * Pix (BRL) * Faster Payments (GBP) * Bre-B & Bank Transfer (COP) - BETA * and more coming soon! ### [​](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/payment-routes#route-explorer) **Route Explorer** Below, you will find all the routes we support. You can use the filters to search for the routes you are interested in. Was this page helpful? YesNo [Set up a sandbox environment](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-sandbox) [Geographies](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/geo) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Update a Liquidation Address - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Liquidation Addresses Update a Liquidation Address [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Update a Liquidation Address cURL curl --request PUT \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "external_account_id": "", "custom_developer_fee_percent": "0.1", "destination_ach_reference": "", "destination_wire_message": "", "destination_sepa_reference": "", "destination_spei_reference": "", "return_address": "" } ' 200 SuccessfulLiquidationAddressUpdateResponse { "id": "la_123", "chain": "ethereum", "customer_id": "cust_123", "external_account_id": "ext_123", "address": "0x4d0280da2f2fDA5103914bCc5aad114743152A9c", "currency": "usdc", "destination_payment_rail": "wire", "destination_currency": "usd", "destination_wire_message": "a wire message", "state": "active", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } PUT / customers / {customerID} / liquidation\_addresses / {liquidationAddressID} Try it Update a Liquidation Address cURL curl --request PUT \ --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "external_account_id": "", "custom_developer_fee_percent": "0.1", "destination_ach_reference": "", "destination_wire_message": "", "destination_sepa_reference": "", "destination_spei_reference": "", "return_address": "" } ' 200 SuccessfulLiquidationAddressUpdateResponse { "id": "la_123", "chain": "ethereum", "customer_id": "cust_123", "external_account_id": "ext_123", "address": "0x4d0280da2f2fDA5103914bCc5aad114743152A9c", "currency": "usdc", "destination_payment_rail": "wire", "destination_currency": "usd", "destination_wire_message": "a wire message", "state": "active", "created_at": "2023-11-22T21:31:30.515Z", "updated_at": "2023-11-22T21:31:30.515Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#parameter-liquidation-address-id) liquidationAddressID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json Liquidation Address details to be updated [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#body-external-account-id) external\_account\_id string An optional identifier for the external account you wish to associate with this liquidation schedule. Note: Only one liquidation address can be associated with an external account per (customer, chain, currency). [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#body-custom-developer-fee-percent-one-of-0) custom\_developer\_fee\_percent string | null The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#body-destination-ach-reference) destination\_ach\_reference string A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces. Required string length: `1 - 10` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#body-destination-wire-message) destination\_wire\_message string A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 characters according to the Fedwire standard. Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#body-destination-sepa-reference) destination\_sepa\_reference string A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`&`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is "Payment via Bridge {unique\_token}". Required string length: `6 - 140` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#body-destination-spei-reference) destination\_spei\_reference string A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space Required string length: `1 - 40` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#body-return-address) return\_address string The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction. This address must be on the same chain specified for the liquidation address. Please note, this functionality is not supported on Stellar. #### Response 200 application/json Updated Liquidation Address object [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-id) id string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-currency) currency enum required Available options: `usdb`, `usdc`, `usdt`, `dai`, `pyusd`, `eurc` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-chain) chain enum required Available options: `arbitrum`, `avalanche_c_chain`, `base`, `celo`, `ethereum`, `optimism`, `polygon`, `solana`, `stellar`, `tempo`, `tron`, `evm` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-customer-id) customer\_id string required The ID of the customer who owns this liquidation address Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-external-account-id) external\_account\_id string required External bank account to which Bridge will send the funds. The currency associated with the External Account must match the destination currency. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-payment-rail) destination\_payment\_rail enum required The payment rail that Bridge will use to send funds to the customer. Available options: `ach`, `wire`, `ach_push`, `ach_same_day`, `arbitrum`, `avalanche_c_chain`, `base`, `bre_b`, `celo`, `ethereum`, `faster_payments`, `fiat_deposit_return`, `optimism`, `pix`, `polygon`, `sepa`, `solana`, `spei`, `stellar`, `swift`, `tempo`, `tron` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-currency) destination\_currency enum required The currency that Bridge will use to send funds to the customer. Available options: `brl`, `cop`, `dai`, `eur`, `eurc`, `gbp`, `mxn`, `pyusd`, `usd`, `usdb`, `usdc`, `usdt` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-address) address string required The crypto wallet address the customer will send funds to in order to initiate the payment processing [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-created-at) created\_at string required Time of creation of the Liquidation Address [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-updated-at) updated\_at string required Time of last update of the Liquidation Address [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-prefunded-account-id) prefunded\_account\_id string The developer's prefunded account to which Bridge will send the funds. Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-custom-developer-fee-percent-one-of-0) custom\_developer\_fee\_percent string | null The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-global-developer-fee-percent) global\_developer\_fee\_percent object The developer fee percent that will be default applied to all Liquidation Addresses. Show child attributes [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-wire-message) destination\_wire\_message string A message to be sent with a wire transfer. Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-sepa-reference) destination\_sepa\_reference string A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`&`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is "Payment via Bridge {unique\_token}". Required string length: `6 - 140` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-spei-reference) destination\_spei\_reference string A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space Required string length: `1 - 40` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-ach-reference) destination\_ach\_reference string A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces. Required string length: `1 - 10` [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-address) destination\_address string The crypto wallet address that Bridge will use to send funds to the customer. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-destination-blockchain-memo) destination\_blockchain\_memo string The memo to include in the transaction, for blockchains that support memos only [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-return-address) return\_address string The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction. This address must be on the same chain specified for the liquidation address. Please note, this functionality is not supported on Stellar. [​](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/update-a-liquidation-address#response-state) state string The state of the liquidation address. It could be "active" or "deactivated" Was this page helpful? YesNo [Get a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-a-liquidation-address) [Get drain history of a Liquidation Address](https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Send fiat deposits to your wallet - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Integrate custodial wallets Send fiat deposits to your wallet [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) This guide walks you through creating a crypto wallet for a customer, then linking it to a virtual account so fiat deposits (e.g. ACH, SEPA) are automatically converted and delivered to the wallet as stablecoins. ![](https://files.readme.io/d051ccd62a78c5556e3401e032c74ee265918ddd1aa35e45263bbb434b1253d3-image.png) * * * 1 [](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp#) Step 1: Create a wallet ----------------------- Create a new Bridge-managed crypto wallet for your customer. This wallet will hold funds (e.g. USDB) and can earn yield. Request curl --request POST \ --url https://api.bridge.xyz/v0/customers//wallets \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "chain": "solana" }' See all 8 lines Response { "id": "wallet_abc123", "chain": "solana", "address": "4oG1sWkP8vcrnhbkzZc1m9RTT2VUjZHKx92qiVFK7FuZ", "created_at": "2025-07-15T18:00:00Z" } See all 6 lines Use the `bridge_wallet_id` (wallet\_abc123 above) when referencing the wallet in other Bridge APIs. 2 [](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp#) Step 2: Create a virtual account that onramps to the wallet ----------------------------------------------------------- Now, link the wallet to a virtual account. Any fiat deposits into the account will be automatically converted to USDB and delivered to the wallet. Request curl --request POST \ --url https://api.bridge.xyz/v0/customers//virtual_accounts \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "source": { "currency": "usd" }, "destination": { "payment_rail": "solana", "currency": "usdb", "bridge_wallet_id": "wallet_abc123" } }' See all 15 lines Response { "id": "va_123", "status": "activated", "customer_id": "cust_alice", "source_deposit_instructions": { "currency": "usd", "bank_beneficiary_name": "Alice Customer", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_routing_number": "101019644", "bank_account_number": "123456789", "payment_rails": ["ach_push", "wire"], }, "destination": { "bridge_wallet_id": "wallet_abc123", "currency": "usdb" } } See all 18 lines 3 [](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp#) Step 3: Share the virtual account address ----------------------------------------- Share the virtual account details (account and routing number) with your customer. When they send a fiat deposit, Bridge will: * Match the payment * Convert it to stablecoin (e.g. USDB) * Deliver it to the linked wallet 4 [](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp#) Step 4: Check wallet balance ---------------------------- Use this API to check wallet balances and confirm the funds have landed. Request curl --request GET --url --header 'Api-Key: ' --header 'accept: application/json' See all 4 lines Response { "id": "uuid", "chain": "solana", "address": "the-blockchain-address", "created_at": "2024-09-01T02:03:04.567Z", "updated_at": "2024-09-01T02:03:04.567Z", "balances": [ \ {\ "balance": "123.456789",\ "currency": "usdb", \ "chain": "solana",\ "contract_address": "ENL66PGy8d8j5KNqLtCcg4uidDUac5ibt45wbjH9REzB", \ } \ ] } See all 15 lines Was this page helpful? YesNo [Custodial wallets](https://apidocs.bridge.xyz/get-started/guides/wallets/overview) [Send wallet funds to a crypto address](https://apidocs.bridge.xyz/get-started/guides/wallets/crypto-to-crypto) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get associated persons for a business customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/get-associated-persons-for-a-business-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Get associated persons for a business customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get associated persons for a business customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons \ --header 'Api-Key: ' 200 AssociatedPersonsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulAssociatedPersonResponse/value"\ }\ ] } GET / customers / {customerID} / associated\_persons Try it Get associated persons for a business customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons \ --header 'Api-Key: ' 200 AssociatedPersonsFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulAssociatedPersonResponse/value"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/get-associated-persons-for-a-business-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-associated-persons-for-a-business-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json List of associated persons (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/customers/get-associated-persons-for-a-business-customer#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Delete a single customer object](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Delete a single associated person - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Delete a single associated person [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Delete a single associated person cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } DELETE / customers / {customerID} / associated\_persons / {associatedPersonID} Try it Delete a single associated person cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#parameter-associated-person-id) associatedPersonID string required Unique identifier for an associated person A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successfully deleted associated person [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-id) id string required Unique identifier for the associated person [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-created-at) created\_at integer required Created timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-updated-at) updated\_at integer required Last updated timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-email) email string The email address of the associated person [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-first-name) first\_name string The first name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-last-name) last\_name string The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-has-ownership) has\_ownership boolean True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-has-control) has\_control boolean True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-is-signer) is\_signer boolean True if this person is able to authorize transactions on behalf of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-attested-ownership-structure-at) attested\_ownership\_structure\_at string When this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person#response-relationship-established-at) relationship\_established\_at string When the associated person relationship was established in format yyyy-mm-dd. Was this page helpful? YesNo [Update a single associated person](https://apidocs.bridge.xyz/api-reference/customers/update-a-single-associated-person) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Platform overview - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Get started Platform overview [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Bridge APIs are modular building blocks that let you create fast, flexible, and compliant payment experiences. Whether you’re collecting fiat, moving stablecoins, or issuing cards, our APIs are designed to support your unique use case — across fiat and crypto. This guide outlines the **core product categories**, what each product does, and **when you should use them**. * * * [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview#-orchestration-move-money) 🔁 Orchestration: Move money --------------------------------------------------------------------------------------------------------------------------------------- Bridge orchestration APIs power your fiat and crypto flows. Go from fiat to crypto (onramps), crypto to fiat (offramps), and crypto to crypto. | Product | Description | Use when you need to… | | --- | --- | --- | | **Virtual Accounts** | **Unique fiat deposit addresses** (ACH, Wire, SEPA, SPEI) issued to your customers. | Collect fiat bank transfers - especially for recurring deposits. | | **Transfers** | **One-time fiat or stablecoin transfers**. Supports onramps, offramps, and crypto-to-crypto flows. | When you need to send or receive money programmatically - either fiat or crypto. | | **Static Template Transfers** | **Reusable transfer instructions** for **recurring**, template-based transfers. AKA payment routes in dashboard | Let customers make recurring payments. | | **Liquidation Addresses** | **On-chain addresses** that auto-forward to a crypto or fiat destination. | Accept crypto at fixed addresses and automatically route or convert funds. | | **Prefunded Accounts** | Load fiat into Bridge-managed balances for instant offramps. | **Guarantee fast withdrawals** without waiting for inbound deposits to settle. | * * * [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview#-wallets-custody-crypto) 👜 Wallets: Custody crypto ----------------------------------------------------------------------------------------------------------------------------------- Bridge offers secure custodial wallets that allow you to hold and transfer stablecoins — with full compliance built-in. You can provision wallets for your customers or even for yourself to help with treasury management. | **Product** | **Description** | **Use When You Need To…** | | --- | --- | --- | | **Bridge Wallets** | Custodial wallets for managing crypto on behalf of users or your business. | Custody crypto and power stablecoin transfers. | * * * [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview#-cards-spend-stablecoins-anywhere) 💳 Cards: Spend stablecoins anywhere ------------------------------------------------------------------------------------------------------------------------------------------------------- Let users spend their stablecoin balances globally using virtual Visa cards. | **Product** | **Description** | **Use When You Need To…** | | --- | --- | --- | | **Cards** | Issue virtual cards linked to Bridge or external wallets. | When you want to enable customers to spend stablecoin balances anywhere Visa is accepted globally. | * * * [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview#-issuance-create-or-use-stablecoins) 🪙 Issuance: Create or use stablecoins ----------------------------------------------------------------------------------------------------------------------------------------------------------- Use Bridge’s stablecoin (USDB) or launch your own branded version. | **Product** | **Description** | **Use When You Need To…** | | --- | --- | --- | | **USDB / Custom Stablecoins** | Mint USDB or branded stablecoins that earn yield on held balances. | Offer branded stablecoins, or earn yield on reserve balances. | * * * [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/overview#-customers-onboarding-&-compliance) 👤 Customers: Onboarding & compliance --------------------------------------------------------------------------------------------------------------------------------------------------------- Bridge provides built-in tools to onboard and manage your users with full KYC/KYB compliance. | **Product** | **Description** | **Use When You Need To…** | | --- | --- | --- | | **Customer Onboarding** | Verify identity and onboard customers across financial rails and products. | Onboard users to new payment products and need to satisfy compliance requirements. | Was this page helpful? YesNo [Welcome](https://apidocs.bridge.xyz/get-started/introduction/overview) [Get set up with Bridge](https://apidocs.bridge.xyz/get-started/introduction/quick-start/get-set-up-with-bridge) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a single associated person - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Get a single associated person [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a single associated person cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } GET / customers / {customerID} / associated\_persons / {associatedPersonID} Try it Get a single associated person cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons/{associatedPersonID} \ --header 'Api-Key: ' 200 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#parameter-associated-person-id) associatedPersonID string required Unique identifier for an associated person A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successful associated person response [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-id) id string required Unique identifier for the associated person [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-created-at) created\_at integer required Created timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-updated-at) updated\_at integer required Last updated timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-email) email string The email address of the associated person [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-first-name) first\_name string The first name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-last-name) last\_name string The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-has-ownership) has\_ownership boolean True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-has-control) has\_control boolean True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-is-signer) is\_signer boolean True if this person is able to authorize transactions on behalf of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-attested-ownership-structure-at) attested\_ownership\_structure\_at string When this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person#response-relationship-established-at) relationship\_established\_at string When the associated person relationship was established in format yyyy-mm-dd. Was this page helpful? YesNo [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) [Update a single associated person](https://apidocs.bridge.xyz/api-reference/customers/update-a-single-associated-person) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all static templates for a customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Get all static templates for a customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all static templates for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_templates \ --header 'Api-Key: ' 200 StaticTemplatesFound { "count": 2, "data": [\ {\ "$ref": "#/components/examples/AchOnrampFundsReceivedTransferResponse/value"\ },\ {\ "$ref": "#/components/examples/AchOfframpTransferResponse/value"\ }\ ] } GET / customers / {customerID} / static\_templates Try it Get all static templates for a customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_templates \ --header 'Api-Key: ' 200 StaticTemplatesFound { "count": 2, "data": [\ {\ "$ref": "#/components/examples/AchOnrampFundsReceivedTransferResponse/value"\ },\ {\ "$ref": "#/components/examples/AchOfframpTransferResponse/value"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#parameter-starting-after) starting\_after string This is a transfer id. If this is specified, the next page that starts with a transfer right AFTER the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers older than the specified transfer id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#parameter-ending-before) ending\_before string This is a transfer id. If this is specified, the previous page that ends with a transfer right BEFORE the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers newer than the specified transfer id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json List of static templates (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#response-count) count integer required The number of static templates returned [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Get all transfers](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all customers - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Get all customers [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all customers cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers \ --header 'Api-Key: ' 200 CustomersFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulCustomerResponse/value"\ },\ {\ "$ref": "#/components/examples/SuccessfulCustomerResponse2/value"\ }\ ] } GET / customers Try it Get all customers cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers \ --header 'Api-Key: ' 200 CustomersFound { "data": [\ {\ "$ref": "#/components/examples/SuccessfulCustomerResponse/value"\ },\ {\ "$ref": "#/components/examples/SuccessfulCustomerResponse2/value"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#parameter-starting-after) starting\_after string This is a customer id. If this is specified, the next page that starts with a customer right AFTER the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers older than the specified customer id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#parameter-ending-before) ending\_before string This is a customer id. If this is specified, the previous page that ends with a customer right BEFORE the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers newer than the specified customer id will be returned (shouldn't be set if starting\_after is set) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#parameter-email) email string If included, filters to customers with the given email #### Response 200 application/json List of customers (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-customers#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Get a Bridge Wallet](https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-a-bridge-wallet-1) [Create a customer](https://apidocs.bridge.xyz/api-reference/customers/create-a-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Retrieve a hosted URL for ToS acceptance for an existing customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Retrieve a hosted URL for ToS acceptance for an existing customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Retrieve a hosted URL for ToS acceptance for an existing customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/tos_acceptance_link \ --header 'Api-Key: ' 200 TosAcceptanceLink { "url": "https://compliance.bridge.xyz/accept-terms-of-service?email=sage%40blick-mayer.example&t=74ea7c13-2b52-5073-bd12-6879f92b88dd" } GET / customers / {customerID} / tos\_acceptance\_link Try it Retrieve a hosted URL for ToS acceptance for an existing customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/tos_acceptance_link \ --header 'Api-Key: ' 200 TosAcceptanceLink { "url": "https://compliance.bridge.xyz/accept-terms-of-service?email=sage%40blick-mayer.example&t=74ea7c13-2b52-5073-bd12-6879f92b88dd" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json A Hosted URL for ToS acceptance [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer#response-url) url string required A hosted URL for ToS acceptance Was this page helpful? YesNo [Delete a single associated person](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-associated-person) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a Static Memo - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Static Memos Get a Static Memo [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a Static Memo cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos/{staticMemoID} \ --header 'Api-Key: ' 200 { "id": "", "developer_fee_percent": "0.1", "source_deposit_instructions": { "currency": "usd", "payment_rails": [\ "ach_push",\ "wire"\ ], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "created_at": "2023-11-07T05:31:56Z" } GET / customers / {customerID} / static\_memos / {staticMemoID} Try it Get a Static Memo cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos/{staticMemoID} \ --header 'Api-Key: ' 200 { "id": "", "developer_fee_percent": "0.1", "source_deposit_instructions": { "currency": "usd", "payment_rails": [\ "ach_push",\ "wire"\ ], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "created_at": "2023-11-07T05:31:56Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#parameter-static-memo-id) staticMemoID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 - application/json Successful static memo object response [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#response-developer-fee-percent) developer\_fee\_percent string The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#response-source-deposit-instructions) source\_deposit\_instructions object Show child attributes Example: { "currency": "usd", "payment_rails": ["ach_push", "wire"], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#response-destination) destination object Show child attributes Example: { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo#response-created-at) created\_at string Time of creation of the static memo Was this page helpful? YesNo [Create a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo) [Update a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Delete a transfer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/transfers/delete-a-transfer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Transfers Delete a transfer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Delete a transfer cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/transfers/{transferID} \ --header 'Api-Key: ' 200 DELETE / transfers / {transferID} Try it Delete a transfer cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/transfers/{transferID} \ --header 'Api-Key: ' 200 #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/transfers/delete-a-transfer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/transfers/delete-a-transfer#parameter-transfer-id) transferID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 Successful deletion of transfer Was this page helpful? YesNo [Update a transfer](https://apidocs.bridge.xyz/api-reference/transfers/update-a-transfer) [Get all static templates](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Set up a sandbox environment - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-sandbox#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Get started Set up a sandbox environment [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Bridge has a sandbox environment for you to quickly begin testing your integration without having to move real money. To access this sandbox, you must first reach out to [support@bridge.xyz](mailto:support@bridge.xyz) to get onboarded with a Developer account within Bridge. Afterwards, you’ll be able to generate sandbox API keys [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-sandbox#step-1-generate-a-sandbox-key) Step 1: Generate a Sandbox Key ------------------------------------------------------------------------------------------------------------------------------------------------------- **Note that only dashboard admins have access to both sandbox and prod API keys.** Please ask your dashboard admin for access if you don’t have it * Go to [https://dashboard.bridge.xyz/](https://dashboard.bridge.xyz/) and log in with your email. * Then, ensure the “Sandbox” toggle is turned on (blue). * Then, hit the button to generate a sandbox key. * Sandbox keys should be prefixed with `sk-test`. [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-sandbox#step-2-hit-an-api) Step 2: Hit an API ------------------------------------------------------------------------------------------------------------------------------- Bridge’s sandbox is currently functional with the customer creation and KYC process. For example, here is how you can create a Bridge customer. **Note that the sandbox base url is** [https://api.sandbox.bridge.xyz](https://api.sandbox.bridge.xyz/) curl --location --request POST 'https://api.sandbox.bridge.xyz/v0/customers' \ --header 'Content-Type: application/json' \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --data-raw '{ "first_name": "John", "last_name": "Doe", "email": "johndoe@johndoe.com", "address": { "street_line_1": "123 Washington St", "street_line_2": "Apt 2F", "city": "San Francisco", "state": "CA", "postal_code": "10001", "country": "USA" }, "birth_date": "1989-09-09", "tax_identification_number": "111-11-1111", "phone": "+15555555555", "signed_agreement_id": "", "type": "individual" }' See all 22 lines We recommend the following steps to get a sense of how to use Bridge: * Create a customer * Fetch that customer * Examine simulated KYC * Creating fake liquidation addresses, transfers and fiat deposit instructions (Note: there is no real money movement in Sandbox) [​](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-sandbox#differences-with-production) Differences with Production -------------------------------------------------------------------------------------------------------------------------------------------------- Sandbox differs from production in a few key areas. We highly recommend using the Sandbox only to test API request/response schemas and Production itself for any other kind of testing. **Onboarding/KYC** * Customers must be created via the API; they cannot be created using kyc links. * Customers are automatically approved (no KYC/KYB flow) * Sandbox is subject to arbitrary rate limits; we may drop your requests anytime. * The signed agreement ID in production cannot be arbitrary * While in production you can have multiple users under the same Developer Account, in Sandbox each of those users will be scoped under their own unique Developer Account. In particular, changes made by one user in the sandbox won’t be visible to other users **even if those users share a developer account in production**. **Payments** * There is no real money movement in Sandbox. * Plaid does not work in Sandbox. * There is no testnet support in Sandbox. * Virtual Accounts, Static Memos, Liquidation Addresses, and Transfers are created with dummy data. * There are no payments-related webhooks fired in sandbox. Wallets and Stablecoin Issuance are only supported in Production If you have suggests for how to improve our sandbox experience, please reach out to us at [support@bridge.xyz](mailto:support@bridge.xyz) , thanks! Was this page helpful? YesNo [Configure webhooks](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-webhooks) [Supported blockchains and fiat rails](https://apidocs.bridge.xyz/get-started/introduction/what-we-support/payment-routes) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a single customer object - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Get a single customer object [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a single customer object cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID} \ --header 'Api-Key: ' 200 SuccessfulCustomerResponse { "id": "00000000-0000-0000-0000-000000000000", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "status": "active", "type": "individual", "persona_inquiry_type": "gov_id_db", "created_at": "2025-11-19T21:14:58.328Z", "updated_at": "2025-11-19T21:16:02.894Z", "rejection_reasons": [], "has_accepted_terms_of_service": true, "endorsements": [\ {\ "name": "base",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v1",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance",\ "post_processing"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ },\ {\ "name": "sepa",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v2",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ }\ ], "future_requirements_due": [], "requirements_due": [\ "external_account"\ ], "capabilities": { "payin_crypto": "active", "payout_crypto": "active", "payin_fiat": "pending", "payout_fiat": "pending" } } GET / customers / {customerID} Try it Get a single customer object cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID} \ --header 'Api-Key: ' 200 SuccessfulCustomerResponse { "id": "00000000-0000-0000-0000-000000000000", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "status": "active", "type": "individual", "persona_inquiry_type": "gov_id_db", "created_at": "2025-11-19T21:14:58.328Z", "updated_at": "2025-11-19T21:16:02.894Z", "rejection_reasons": [], "has_accepted_terms_of_service": true, "endorsements": [\ {\ "name": "base",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v1",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance",\ "post_processing"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ },\ {\ "name": "sepa",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v2",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ }\ ], "future_requirements_due": [], "requirements_due": [\ "external_account"\ ], "capabilities": { "payin_crypto": "active", "payout_crypto": "active", "payin_fiat": "pending", "payout_fiat": "pending" } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successful customer object response [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-first-name) first\_name string Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-last-name) last\_name string Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-email) email string Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-status) status enum `offboarded`: represents a customer's account that was internally reviewed and closed due to suspicious activity. `paused`: represents a customer's account that is currently under review because of activity on the platform. Available options: `active`, `awaiting_questionnaire`, `awaiting_ubo`, `incomplete`, `not_started`, `offboarded`, `paused`, `rejected`, `under_review` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-capabilities) capabilities object Show child attributes [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-future-requirements-due) future\_requirements\_due enum\[\] Information about requirements that may be needed in the future for the customer (eg. enhanced KYC checks for high volume transactions etc.). Please consult our KYC guide on how to resolve each requirement. Available options: `id_verification` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-requirements-due) requirements\_due enum\[\] KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement. Available options: `external_account`, `id_verification` [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-created-at) created\_at string Time of creation of the customer [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-updated-at) updated\_at string Time of last update of the customer [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-rejection-reasons) rejection\_reasons object\[\] Reasons why a customer KYC was rejected Show child attributes [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-has-accepted-terms-of-service) has\_accepted\_terms\_of\_service boolean Whether the customer has accepted the terms of service. [​](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-customer-object#response-endorsements) endorsements object\[\] A summary of whether the customer has received approvals to complete onboarding or use certain products/services offered by Bridge. Show child attributes Was this page helpful? YesNo [Create a customer](https://apidocs.bridge.xyz/api-reference/customers/create-a-customer) [Update a single customer object](https://apidocs.bridge.xyz/api-reference/customers/update-a-single-customer-object) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Retrieve a hosted KYC Link for an existing customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Retrieve a hosted KYC Link for an existing customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Retrieve a hosted KYC Link for an existing customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/kyc_link \ --header 'Api-Key: ' 200 KycLink { "url": "https://bridge.withpersona.com/verify?inquiry-template-id=itmpl_NtIXpb9AbEYCPxGo5iRbc9d2&reference-id=75d2f259-6810-4cde-a9b9-83eca42b0ebf" } GET / customers / {customerID} / kyc\_link Try it Retrieve a hosted KYC Link for an existing customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/kyc_link \ --header 'Api-Key: ' 200 KycLink { "url": "https://bridge.withpersona.com/verify?inquiry-template-id=itmpl_NtIXpb9AbEYCPxGo5iRbc9d2&reference-id=75d2f259-6810-4cde-a9b9-83eca42b0ebf" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer#parameter-endorsement) endorsement enum An endorsement is the approval required for a customer to use a particular product or service offered by Bridge Available options: `sepa`, `spei`, `cards` [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer#parameter-redirect-uri) redirect\_uri string An optional url encoded link that users will be redirected to after completing the hosted KYC flow. Example: `"http%3A%2F%2Fexample.com%2Fredirect"` #### Response 200 application/json A Hosted URL for KYC [​](https://apidocs.bridge.xyz/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer#response-url) url string required A hosted KYC link Was this page helpful? YesNo [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) [Get all transfers](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Delete a single customer object - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Delete a single customer object [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Delete a single customer object cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/customers/{customerID} \ --header 'Api-Key: ' 200 DeletedCustomerResponse { "id": "00000000-0000-0000-0000-000000000000", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "status": "active", "type": "individual", "persona_inquiry_type": "gov_id_db", "created_at": "2025-11-19T21:14:58.328Z", "updated_at": "2025-11-19T21:16:02.894Z", "rejection_reasons": [], "has_accepted_terms_of_service": true, "endorsements": [\ {\ "name": "base",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v1",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance",\ "post_processing"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ },\ {\ "name": "sepa",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v2",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ }\ ], "future_requirements_due": [], "requirements_due": [\ "external_account"\ ], "capabilities": { "payin_crypto": "active", "payout_crypto": "active", "payin_fiat": "pending", "payout_fiat": "pending" } } DELETE / customers / {customerID} Try it Delete a single customer object cURL curl --request DELETE \ --url https://api.bridge.xyz/v0/customers/{customerID} \ --header 'Api-Key: ' 200 DeletedCustomerResponse { "id": "00000000-0000-0000-0000-000000000000", "first_name": "John", "last_name": "Doe", "email": "johndoe@example.com", "status": "active", "type": "individual", "persona_inquiry_type": "gov_id_db", "created_at": "2025-11-19T21:14:58.328Z", "updated_at": "2025-11-19T21:16:02.894Z", "rejection_reasons": [], "has_accepted_terms_of_service": true, "endorsements": [\ {\ "name": "base",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v1",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance",\ "post_processing"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ },\ {\ "name": "sepa",\ "status": "approved",\ "requirements": {\ "complete": [\ "terms_of_service_v2",\ "first_name",\ "last_name",\ "tax_identification_number",\ "email_address",\ "address_of_residence",\ "date_of_birth",\ "proof_of_address",\ "sanctions_screen",\ "pep_screen",\ "blocklist_lookup",\ "min_age_18",\ "selfie_verification",\ "government_id_rejection_checks_passed",\ "government_id_review_checks_passed",\ "government_id_reliance"\ ],\ "pending": [],\ "missing": null,\ "issues": []\ }\ }\ ], "future_requirements_due": [], "requirements_due": [\ "external_account"\ ], "capabilities": { "payin_crypto": "active", "payout_crypto": "active", "payin_fiat": "pending", "payout_fiat": "pending" } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json Successfully deleted customer object response [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-first-name) first\_name string Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-last-name) last\_name string Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-email) email string Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-status) status enum `offboarded`: represents a customer's account that was internally reviewed and closed due to suspicious activity. `paused`: represents a customer's account that is currently under review because of activity on the platform. Available options: `active`, `awaiting_questionnaire`, `awaiting_ubo`, `incomplete`, `not_started`, `offboarded`, `paused`, `rejected`, `under_review` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-capabilities) capabilities object Show child attributes [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-future-requirements-due) future\_requirements\_due enum\[\] Information about requirements that may be needed in the future for the customer (eg. enhanced KYC checks for high volume transactions etc.). Please consult our KYC guide on how to resolve each requirement. Available options: `id_verification` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-requirements-due) requirements\_due enum\[\] KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement. Available options: `external_account`, `id_verification` [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-created-at) created\_at string Time of creation of the customer [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-updated-at) updated\_at string Time of last update of the customer [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-rejection-reasons) rejection\_reasons object\[\] Reasons why a customer KYC was rejected Show child attributes [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-has-accepted-terms-of-service) has\_accepted\_terms\_of\_service boolean Whether the customer has accepted the terms of service. [​](https://apidocs.bridge.xyz/api-reference/customers/delete-a-single-customer-object#response-endorsements) endorsements object\[\] A summary of whether the customer has received approvals to complete onboarding or use certain products/services offered by Bridge. Show child attributes Was this page helpful? YesNo [Update a single customer object](https://apidocs.bridge.xyz/api-reference/customers/update-a-single-customer-object) [Get associated persons for a business customer](https://apidocs.bridge.xyz/api-reference/customers/get-associated-persons-for-a-business-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Send wallet funds to a crypto address - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/guides/wallets/crypto-to-crypto#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Integrate custodial wallets Send wallet funds to a crypto address [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Bridge wallets are secure, custodial crypto wallets that let you send and receive stablecoins with ease. Once you’ve provisioned a wallet for your customer or company, you can send and receive funds using orchestration API. You must use Bridge’s orchestration APIs to move funds. **Do not attempt to send directly** from the wallet address. ![](https://files.readme.io/bcd6a3bfe25913355630174c61719239120611cd39ded4ffb188eaecd2a7bb07-image.png) * * * 1 [](https://apidocs.bridge.xyz/get-started/guides/wallets/crypto-to-crypto#) Step 1: Create a Bridge wallet ------------------------------ Request curl --request POST \ --url https://api.bridge.xyz/v0/customers//wallets \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "chain": "solana" }' See all 8 lines Response { "id": "wallet_123", "chain": "solana", "address": "the-blockchain-address", "created_at": "2024-09-01T02:03:04.567Z", "updated_at": "2024-09-01T02:03:04.567Z" } See all 7 lines Note the `id` returned — this is your `bridge_wallet_id`. 2 [](https://apidocs.bridge.xyz/get-started/guides/wallets/crypto-to-crypto#) Step 2: Transfer funds from wallet to crypto address ---------------------------------------------------- Use the [Transfers](https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer) API with `bridge_wallet` as the source. Request curl --location --request POST 'https://api.bridge.xyz/v0/transfers' \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "amount": "10.0", "on_behalf_of": "", "developer_fee": "0.0", "source": { "payment_rail": "bridge_wallet", "currency": "usdb", "bridge_wallet_id": "wallet_123" }, "destination": { "payment_rail": "ethereum", "currency": "usdc", "to_address": "0xdeadbeef..." } }' See all 19 lines Response { "id": "transfer_abc", "amount": "10.0", ... "source": { "payment_rail": "bridge_wallet", "currency": "usdb", "bridge_wallet_id": "wallet_123" }, "destination": { "payment_rail": "ethereum", "currency": "usdc", "to_address": "0xdeadbeef" }, } See all 15 lines This will initiate a crypto transfer from your Bridge wallet to the specified blockchain address. 3 [](https://apidocs.bridge.xyz/get-started/guides/wallets/crypto-to-crypto#) Step 3: Monitor transfer status (optional) ------------------------------------------ Use the Transfer ID returned in the response to monitor progress via the [Get a transfer](https://apidocs.bridge.xyz/api-reference/transfers/get-a-transfer) endpoint or by listening to webhooks — learn more at [Setting up webhooks](https://apidocs.bridge.xyz/get-started/introduction/quick-start/setting-up-webhooks) . Request curl --request GET \ --url https://api.bridge.xyz/v0/transfers/ \ --header 'Api-Key: ' See all 4 lines Was this page helpful? YesNo [Send fiat deposits to your wallet](https://apidocs.bridge.xyz/get-started/guides/wallets/onramp) [Send wallet funds to a fiat external account](https://apidocs.bridge.xyz/get-started/guides/wallets/offramp) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Request a hosted URL for ToS acceptance for new customer creation - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/request-a-hosted-url-for-tos-acceptance-for-new-customer-creation#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Request a hosted URL for ToS acceptance for new customer creation [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Request a hosted URL for ToS acceptance for new customer creation cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/tos_links \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 201 TosUrl { "data": { "url": "https://compliance.bridge.xyz/accept-terms-of-service?session_token=4d5d8c45-9feb-422a-bb5e-0fd32e3b3c53&redirect_uri=https%3A%2F%2Fgoogle.com" } } POST / customers / tos\_links Try it Request a hosted URL for ToS acceptance for new customer creation cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/tos_links \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' 201 TosUrl { "data": { "url": "https://compliance.bridge.xyz/accept-terms-of-service?session_token=4d5d8c45-9feb-422a-bb5e-0fd32e3b3c53&redirect_uri=https%3A%2F%2Fgoogle.com" } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/request-a-hosted-url-for-tos-acceptance-for-new-customer-creation#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/customers/request-a-hosted-url-for-tos-acceptance-for-new-customer-creation#parameter-idempotency-key) Idempotency-Key string required #### Response 201 application/json A Bridge hosted URL for users to complete terms of service signing. [​](https://apidocs.bridge.xyz/api-reference/customers/request-a-hosted-url-for-tos-acceptance-for-new-customer-creation#response-url) url string required A Bridge hosted URL for users to complete terms of service signing. Was this page helpful? YesNo [Get all static templates for a customer](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer) [Get all External Accounts](https://apidocs.bridge.xyz/api-reference/external-accounts/get-all-external-accounts) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # List Static Memos for Customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Static Memos List Static Memos for Customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) List Static Memos for Customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos \ --header 'Api-Key: ' 200 { "count": 123, "data": [\ {\ "id": "",\ "developer_fee_percent": "0.1",\ "source_deposit_instructions": {\ "currency": "usd",\ "payment_rails": [\ "ach_push",\ "wire"\ ],\ "deposit_message": "EXAMPLE_MEMO_MESSAGE",\ "bank_name": "Lead Bank",\ "bank_address": "1801 Main St., Kansas City, MO 64108",\ "bank_beneficiary_name": "Bridge Ventures Inc",\ "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946",\ "bank_account_number": "123456789",\ "bank_routing_number": "87654321"\ },\ "destination": {\ "currency": "usdc",\ "payment_rail": "polygon",\ "address": "0xdeadbeef"\ },\ "created_at": "2023-11-07T05:31:56Z"\ }\ ] } GET / customers / {customerID} / static\_memos Try it List Static Memos for Customer cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos \ --header 'Api-Key: ' 200 { "count": 123, "data": [\ {\ "id": "",\ "developer_fee_percent": "0.1",\ "source_deposit_instructions": {\ "currency": "usd",\ "payment_rails": [\ "ach_push",\ "wire"\ ],\ "deposit_message": "EXAMPLE_MEMO_MESSAGE",\ "bank_name": "Lead Bank",\ "bank_address": "1801 Main St., Kansas City, MO 64108",\ "bank_beneficiary_name": "Bridge Ventures Inc",\ "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946",\ "bank_account_number": "123456789",\ "bank_routing_number": "87654321"\ },\ "destination": {\ "currency": "usdc",\ "payment_rail": "polygon",\ "address": "0xdeadbeef"\ },\ "created_at": "2023-11-07T05:31:56Z"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#parameter-status) status enum Limit results to those with the given activation status The activation status of the Virtual Account Available options: `activated`, `deactivated` [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#parameter-starting-after) starting\_after string This is a static memo id. If this is specified, the next page that starts with a static memo right AFTER the specified static memo id on the static memo timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that static memo older than the specified static memo id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#parameter-ending-before) ending\_before string This is a static memo id. If this is specified, the previous page that ends with a static memo right BEFORE the specified static memo id on the static memo timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that static memo newer than the specified static memo id will be returned (shouldn't be set if starting\_after is set) #### Response 200 - application/json List of Static Memos [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [List Static Memos](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos) [Create a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Spend wallet balances using a card - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/guides/cards/spend#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Provision and make card payments Spend wallet balances using a card [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) You can issue a virtual or physical card that spends directly from a Bridge-managed wallet or external crypto wallet. Here’s how to set that up. ![](https://files.readme.io/abd125101ad0ef13134d7af37f6937eaaaa254bb7824de1552694da371805f0c-image.png) * * * 1 [](https://apidocs.bridge.xyz/get-started/guides/cards/spend#) Step 1: Prepare a Bridge wallet ------------------------------- ### [​](https://apidocs.bridge.xyz/get-started/guides/cards/spend#create-a-wallet) Create a wallet First, create a Bridge wallet (optional if you’re using an external wallet). Use the wallet’s `address` when issuing a card. Request curl --request POST \ --url https://api.bridge.xyz/v0/customers//wallets \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data '{ "chain": "solana" }' See all 8 lines Response { "id": "wallet_abc123", "address": "4oG1sWkP8vcrnhbkzZc1m9RTT2VUjZHKx92qiVFK7FuZ", "chain": "solana" } See all 5 lines Keep note of the wallet ID and address as you will need this in the next step. ### [​](https://apidocs.bridge.xyz/get-started/guides/cards/spend#fund-the-wallet) Fund the wallet The below example uses Bridge’s transfer API to fund the wallet. There are a variety of methods to fund the wallet using Bridge’s orchestration APIs (virtual accounts, transfers, or liquidation addresses). Learn more at [Bridge Wallets](https://apidocs.bridge.xyz/platform/wallets/overview) . curl --location --request POST 'https://api.bridge.xyz/v0/transfers' \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --data-raw '{ "on_behalf_of": "cust_alice", "source": { "payment_rail": "ach_push", "currency": "usd", }, "destination": { "payment_rail": "solana", "currency": "usdb", "bridge_wallet_id": "wallet_abc123" } "features": { "flexible_amount": true // allows for any deposit amount } }' See all 18 lines 2 [](https://apidocs.bridge.xyz/get-started/guides/cards/spend#) Step 2: Provision a card ------------------------ Now create a card account tied to a Bridge wallet. curl --request POST \ --url https://api.bridge.xyz/v0/customers/customerID/card_accounts \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '{ "currency": "usdb", "chain": "solana", "crypto_account": { "type": "bridge_wallet", "address": "4oG1sWkP8vcrnhbkzZc1m9RTT2VUjZHKx92qiVFK7FuZ" } }' See all 12 lines ### [​](https://apidocs.bridge.xyz/get-started/guides/cards/spend#retrieve-card-details) Retrieve card details Access card metadata, expiration, and access a secure image of the card. Request curl -X GET 'https://api.bridge.xyz/v0/customers//card_accounts/' \ --header 'Api-Key: ' See all 2 lines Response { "id": "XXX-YYY", "status": "active", "card_image_url": "https://...", "card_details": { "last_4": "1264", "expiry": "10/24", "bin": "44325280" } } See all 10 lines You can now share these card details with your customer to **start spending!** 3 [](https://apidocs.bridge.xyz/get-started/guides/cards/spend#) Step 3: Make a transaction -------------------------- Now that you have the details for your card, you can use it to make transactions! Use your Bridge issued card like any normal card in e-commerce checkout flows. 4 [](https://apidocs.bridge.xyz/get-started/guides/cards/spend#) Step 4: Monitor transactions ---------------------------- Subscribe to the `card_transaction.created` webhook to see newly created transactions. { "event_type": "card_transaction.created", "event_object": { "status": "approved", "amount": "-10.25", "merchant_name": "ROCKET RIDES", "authorized_at": "2025-02-04T05:19:25.000Z" } } Subscribe to the `card_transaction.updated.status_transitioned` webhook to see settled transactions. { "event_type": "card_transaction.updated.status_transitioned", "event_object": { "status": "settled", "settled_amount": "-10.25", "posted_at": "2025-02-06T03:01:30.000Z" }, "event_object_changes": { "status": ["approved", "settled"], "settled_amount": [null, "-10.25"], "posted_at": [null, "2025-02-06T03:01:30.000Z"] } } Or you can fetch transactions via the [Retrieve card transactions](https://apidocs.bridge.xyz/api-reference/cards/retrieve-card-transactions) API. * * * [​](https://apidocs.bridge.xyz/get-started/guides/cards/spend#money-movement-overview) Money Movement Overview ----------------------------------------------------------------------------------------------------------------- ![](https://files.readme.io/6929a243e3e872e7d1dcfd126c26611127127713f65bd0f0c92e4fd921ec4642-image.png) [​](https://apidocs.bridge.xyz/get-started/guides/cards/spend#resources) Resources ------------------------------------------------------------------------------------- Check out the [Cards](https://apidocs.bridge.xyz/platform/cards/overview/overview) section for more in depth details! Was this page helpful? YesNo [Cards](https://apidocs.bridge.xyz/get-started/guides/cards/overview) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a new associated person for a business customer - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Create a new associated person for a business customer [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a new associated person for a business customer cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "first_name": "", "last_name": "", "email": "", "residential_address": { "street_line_1": "", "city": "", "country": "", "street_line_2": "", "subdivision": "", "postal_code": "" }, "birth_date": "", "has_ownership": true, "has_control": true, "is_signer": true, "identifying_information": [\ {\ "type": "drivers_license",\ "issuing_country": "",\ "number": "",\ "description": "",\ "expiration": "",\ "image_front": "",\ "image_back": ""\ }\ ], "middle_name": "", "transliterated_first_name": "", "transliterated_middle_name": "", "transliterated_last_name": "", "phone": "", "is_director": true, "title": "", "ownership_percentage": 123, "attested_ownership_structure_at": "", "relationship_established_at": "", "verified_govid_at": "", "verified_selfie_at": "", "completed_customer_safety_check_at": "", "documents": [\ {\ "purposes": [\ "proof_of_account_purpose"\ ],\ "file": "",\ "description": ""\ }\ ] } ' 201 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } POST / customers / {customerID} / associated\_persons Try it Create a new associated person for a business customer cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/associated_persons \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "first_name": "", "last_name": "", "email": "", "residential_address": { "street_line_1": "", "city": "", "country": "", "street_line_2": "", "subdivision": "", "postal_code": "" }, "birth_date": "", "has_ownership": true, "has_control": true, "is_signer": true, "identifying_information": [\ {\ "type": "drivers_license",\ "issuing_country": "",\ "number": "",\ "description": "",\ "expiration": "",\ "image_front": "",\ "image_back": ""\ }\ ], "middle_name": "", "transliterated_first_name": "", "transliterated_middle_name": "", "transliterated_last_name": "", "phone": "", "is_director": true, "title": "", "ownership_percentage": 123, "attested_ownership_structure_at": "", "relationship_established_at": "", "verified_govid_at": "", "verified_selfie_at": "", "completed_customer_safety_check_at": "", "documents": [\ {\ "purposes": [\ "proof_of_account_purpose"\ ],\ "file": "",\ "description": ""\ }\ ] } ' 201 SuccessfulAssociatedPersonResponse { "id": "associated_person_1234567890", "email": "associated_person@business.co", "first_name": "John", "last_name": "Smith", "has_ownership": true, "has_control": true, "is_signer": true, "title": "Chief Executive Officer", "relationship_established_at": "2025-05-27T17:55:33.308Z", "created_at": "2025-05-27T17:55:33.308Z", "updated_at": "2025-05-27T17:55:33.308Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json New associated person to be created [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-first-name) first\_name string required The first name of the associated person Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-last-name) last\_name string required The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-email) email string required The persons primary email address Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-residential-address) residential\_address object required The residential address of the associated person. This must be a physical address and cannot be a PO Box. Show child attributes [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-birth-date) birth\_date string required Date of birth in format yyyy-mm-dd. Must be at least 18 years old. Required string length: `10` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-has-ownership) has\_ownership boolean required True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-has-control) has\_control boolean required True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. At least one control person must be specified. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-is-signer) is\_signer boolean required True if this person is able to authorize transactions on behalf of the business. At least one signer must be specified. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-identifying-information) identifying\_information Identification Information · object\[\] required Show child attributes [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-middle-name) middle\_name string The middle name of the associated person Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-transliterated-first-name) transliterated\_first\_name string Required when the `first_name` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-transliterated-middle-name) transliterated\_middle\_name string Required when the `middle_name` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-transliterated-last-name) transliterated\_last\_name string Required when the `last_name` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Required string length: `1 - 256` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-phone) phone string The persons phone in format "+12223334444" Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-transliterated-residential-address) transliterated\_residential\_address object Required when any part of the `residential_address` includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~ Show child attributes [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-is-director) is\_director boolean True if this person is an appointed director of the company. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. Required if has\_control is true. Required string length: `1 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-ownership-percentage) ownership\_percentage integer Ultimate ownership percentage of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-attested-ownership-structure-at) attested\_ownership\_structure\_at string The date or timestamp when this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-relationship-established-at) relationship\_established\_at string The date or timestamp when the associated person relationship was established in format yyyy-mm-dd. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-verified-govid-at) verified\_govid\_at string The date or timestamp for when individual's government ID was successfully verified. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-verified-selfie-at) verified\_selfie\_at string The date or timestamp for when individual's selfie was successfully verified. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-completed-customer-safety-check-at) completed\_customer\_safety\_check\_at string The date or timestamp for when individual successfully passed customer safety check. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#body-documents) documents Documents · object\[\] Please click "ADD OBJECT" for more information. Show child attributes #### Response 201 application/json Associated person created [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-id) id string required Unique identifier for the associated person [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-created-at) created\_at integer required Created timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-updated-at) updated\_at integer required Last updated timestamp in milliseconds since Unix epoch [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-email) email string The email address of the associated person [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-first-name) first\_name string The first name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-last-name) last\_name string The last name of the associated person Required string length: `2 - 1024` [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-has-ownership) has\_ownership boolean True if this person has at least 25% ownership of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-has-control) has\_control boolean True if this is the control person of the company, having significant responsibility to control, manage or influence the activities of the business entity. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-is-signer) is\_signer boolean True if this person is able to authorize transactions on behalf of the business. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-title) title string The title of this associated person at the company, e.g. CEO, CFO, etc. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-attested-ownership-structure-at) attested\_ownership\_structure\_at string When this individual attested to the correctness of the ownership structure provided to Bridge. If provided by at least one control person, ownership documents for the business are not required. [​](https://apidocs.bridge.xyz/api-reference/customers/create-a-new-associated-person-for-a-business-customer#response-relationship-established-at) relationship\_established\_at string When the associated person relationship was established in format yyyy-mm-dd. Was this page helpful? YesNo [Get associated persons for a business customer](https://apidocs.bridge.xyz/api-reference/customers/get-associated-persons-for-a-business-customer) [Get a single associated person](https://apidocs.bridge.xyz/api-reference/customers/get-a-single-associated-person) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Create a Static Memo - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Static Memos Create a Static Memo [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Create a Static Memo cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "source": { "currency": "usd", "payment_rail": "wire" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "developer_fee_percent": "0.1" } ' 200 { "id": "", "developer_fee_percent": "0.1", "source_deposit_instructions": { "currency": "usd", "payment_rails": [\ "ach_push",\ "wire"\ ], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "created_at": "2023-11-07T05:31:56Z" } POST / customers / {customerID} / static\_memos Try it Create a Static Memo cURL curl --request POST \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: ' \ --data ' { "source": { "currency": "usd", "payment_rail": "wire" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "developer_fee_percent": "0.1" } ' 200 { "id": "", "developer_fee_percent": "0.1", "source_deposit_instructions": { "currency": "usd", "payment_rails": [\ "ach_push",\ "wire"\ ], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "created_at": "2023-11-07T05:31:56Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#authorization-api-key) Api-Key string header required #### Headers [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#parameter-idempotency-key) Idempotency-Key string required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json Static Memo object to be created [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#body-source) source object required Show child attributes Example: { "currency": "usd", "payment_rail": "wire" } [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#body-destination) destination object required Show child attributes Example: { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#body-developer-fee-percent) developer\_fee\_percent string The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` #### Response 200 - application/json Static Memo object created [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#response-developer-fee-percent) developer\_fee\_percent string The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#response-source-deposit-instructions) source\_deposit\_instructions object Show child attributes Example: { "currency": "usd", "payment_rails": ["ach_push", "wire"], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#response-destination) destination object Show child attributes Example: { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/create-a-static-memo#response-created-at) created\_at string Time of creation of the static memo Was this page helpful? YesNo [List Static Memos for Customer](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer) [Get a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Static Memo Activity - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Static Memos Static Memo Activity [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Static Memo Activity cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos/{staticMemoID}/history \ --header 'Api-Key: ' 200 { "count": 4, "data": [\ {\ "id": "sm_event_456",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "payment_submitted",\ "amount": "120.0",\ "currency": "usd",\ "developer_fee_amount": "1.25",\ "exchange_fee_amount": "2.2",\ "subtotal_amount": "120.0",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "destination_tx_hash": "0xdeadbeef",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "ach_push",\ "description": "ACH description, if available"\ }\ },\ {\ "id": "sm_event_123",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "funds_received",\ "amount": "123.45",\ "currency": "usd",\ "developer_fee_amount": "0.0",\ "exchange_fee_amount": "0.0",\ "subtotal_amount": "123.45",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "ach_push",\ "description": "ACH description, if available"\ }\ },\ {\ "id": "sm_event_457",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "payment_submitted",\ "amount": "120.0",\ "currency": "usd",\ "developer_fee_amount": "1.25",\ "exchange_fee_amount": "2.2",\ "subtotal_amount": "120.0",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "destination_tx_hash": "0xdeadbeef",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "wire",\ "bank_beneficiary_name": "Bank beneficiary",\ "bank_beneficiary_address": "Bank beneficiary address",\ "originator_name": "Originator Name",\ "originator_address": "Originator Address",\ "bank_routing_number": "1234567890",\ "bank_name": "Bank name",\ "imad": "IMAD of incoming wire, if available",\ "omad": "OMAD of incoming wire, if available (deprecated)"\ }\ },\ {\ "id": "sm_event_124",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "funds_received",\ "amount": "123.45",\ "currency": "usd",\ "developer_fee_amount": "0.0",\ "exchange_fee_amount": "0.0",\ "subtotal_amount": "123.45",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "wire",\ "bank_beneficiary_name": "Bank beneficiary",\ "bank_beneficiary_address": "Bank beneficiary address",\ "originator_name": "Originator Name",\ "originator_address": "Originator Address",\ "bank_routing_number": "1234567890",\ "bank_name": "Bank name",\ "imad": "IMAD of incoming wire, if available",\ "omad": "OMAD of incoming wire, if available (deprecated)"\ }\ }\ ] } GET / customers / {customerID} / static\_memos / {staticMemoID} / history Try it Static Memo Activity cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos/{staticMemoID}/history \ --header 'Api-Key: ' 200 { "count": 4, "data": [\ {\ "id": "sm_event_456",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "payment_submitted",\ "amount": "120.0",\ "currency": "usd",\ "developer_fee_amount": "1.25",\ "exchange_fee_amount": "2.2",\ "subtotal_amount": "120.0",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "destination_tx_hash": "0xdeadbeef",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "ach_push",\ "description": "ACH description, if available"\ }\ },\ {\ "id": "sm_event_123",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "funds_received",\ "amount": "123.45",\ "currency": "usd",\ "developer_fee_amount": "0.0",\ "exchange_fee_amount": "0.0",\ "subtotal_amount": "123.45",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "ach_push",\ "description": "ACH description, if available"\ }\ },\ {\ "id": "sm_event_457",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "payment_submitted",\ "amount": "120.0",\ "currency": "usd",\ "developer_fee_amount": "1.25",\ "exchange_fee_amount": "2.2",\ "subtotal_amount": "120.0",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "destination_tx_hash": "0xdeadbeef",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "wire",\ "bank_beneficiary_name": "Bank beneficiary",\ "bank_beneficiary_address": "Bank beneficiary address",\ "originator_name": "Originator Name",\ "originator_address": "Originator Address",\ "bank_routing_number": "1234567890",\ "bank_name": "Bank name",\ "imad": "IMAD of incoming wire, if available",\ "omad": "OMAD of incoming wire, if available (deprecated)"\ }\ },\ {\ "id": "sm_event_124",\ "customer_id": "cust_alice",\ "virtual_account_id": "sm_123",\ "type": "funds_received",\ "amount": "123.45",\ "currency": "usd",\ "developer_fee_amount": "0.0",\ "exchange_fee_amount": "0.0",\ "subtotal_amount": "123.45",\ "gas_fee": "0.0",\ "deposit_id": "deposit_123",\ "created_at": "2020-01-01T00:00:00.000Z",\ "source_deposit_instructions": {\ "deposit_message": "BVI7depositmessage"\ },\ "source": {\ "payment_rail": "wire",\ "bank_beneficiary_name": "Bank beneficiary",\ "bank_beneficiary_address": "Bank beneficiary address",\ "originator_name": "Originator Name",\ "originator_address": "Originator Address",\ "bank_routing_number": "1234567890",\ "bank_name": "Bank name",\ "imad": "IMAD of incoming wire, if available",\ "omad": "OMAD of incoming wire, if available (deprecated)"\ }\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-static-memo-id) staticMemoID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-deposit-id) deposit\_id string The deposit id associated with the events. Cannot be passed if deposit\_ids is also passed [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-deposit-ids) deposit\_ids string\[\] The deposit ids associated with the events. Pass a list of deposit ids like "deposit\_ids\[\]=id1&deposit\_ids\[\]=id2". Cannot be passed if deposit\_id is also passed [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-tx-hash) tx\_hash string The hash of the transaction [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-starting-after) starting\_after string This is an event id. If this is specified, the next page that starts with an event right AFTER the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events older than the specified event id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-ending-before) ending\_before string This is an event id. If this is specified, the previous page that ends with an event right BEFORE the specified event id on the event timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that events newer than the specified event id will be returned (shouldn't be set if starting\_after is set) [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#parameter-event-type) event\_type enum Filter history by event type Available options: `funds_received`, `payment_submitted`, `payment_processed`, `in_review`, `refund`, `refund_in_flight`, `refund_failed`, `microdeposit`, `account_update`, `deactivation`, `activation` #### Response 200 - application/json List of Static Memo events [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#response-count) count integer required The number of events returned [​](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Update a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo) [Static Memo Activity Across All Customers](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity-across-all-customers) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a listing of your card program's card designs - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/get-a-listing-of-your-card-programs-card-designs#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Get a listing of your card program's card designs [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a listing of your card program's card designs cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/cards/designs \ --header 'Api-Key: ' 200 Example { "card\_designs": \[ { "shortname": "", "type": "virtual" } \], "default\_card\_design\_shortname": "" } GET / developer / cards / designs Try it Get a listing of your card program's card designs cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/cards/designs \ --header 'Api-Key: ' 200 Example { "card\_designs": \[ { "shortname": "", "type": "virtual" } \], "default\_card\_design\_shortname": "" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-listing-of-your-card-programs-card-designs#authorization-api-key) Api-Key string header required #### Response 200 application/json A listing of the designs that you can use to issue a card with. A listing of the designs that you can use to issue a card with. [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-listing-of-your-card-programs-card-designs#response-card-designs) card\_designs object\[\] A listing of the designs that you can use to issue a card with. Show child attributes [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-listing-of-your-card-programs-card-designs#response-default-card-design-shortname) default\_card\_design\_shortname string The shortname of the default card design Was this page helpful? YesNo [Get a summary of your card program](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program) [Retrieve a card account](https://apidocs.bridge.xyz/api-reference/cards/retrieve-a-card-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # List Static Memos - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Static Memos List Static Memos [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) List Static Memos cURL curl --request GET \ --url https://api.bridge.xyz/v0/static_memos \ --header 'Api-Key: ' 200 { "count": 123, "data": [\ {\ "id": "",\ "developer_fee_percent": "0.1",\ "source_deposit_instructions": {\ "currency": "usd",\ "payment_rails": [\ "ach_push",\ "wire"\ ],\ "deposit_message": "EXAMPLE_MEMO_MESSAGE",\ "bank_name": "Lead Bank",\ "bank_address": "1801 Main St., Kansas City, MO 64108",\ "bank_beneficiary_name": "Bridge Ventures Inc",\ "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946",\ "bank_account_number": "123456789",\ "bank_routing_number": "87654321"\ },\ "destination": {\ "currency": "usdc",\ "payment_rail": "polygon",\ "address": "0xdeadbeef"\ },\ "created_at": "2023-11-07T05:31:56Z"\ }\ ] } GET / static\_memos Try it List Static Memos cURL curl --request GET \ --url https://api.bridge.xyz/v0/static_memos \ --header 'Api-Key: ' 200 { "count": 123, "data": [\ {\ "id": "",\ "developer_fee_percent": "0.1",\ "source_deposit_instructions": {\ "currency": "usd",\ "payment_rails": [\ "ach_push",\ "wire"\ ],\ "deposit_message": "EXAMPLE_MEMO_MESSAGE",\ "bank_name": "Lead Bank",\ "bank_address": "1801 Main St., Kansas City, MO 64108",\ "bank_beneficiary_name": "Bridge Ventures Inc",\ "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946",\ "bank_account_number": "123456789",\ "bank_routing_number": "87654321"\ },\ "destination": {\ "currency": "usdc",\ "payment_rail": "polygon",\ "address": "0xdeadbeef"\ },\ "created_at": "2023-11-07T05:31:56Z"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#parameter-status) status enum Limit results to those with the given activation status The activation status of the Virtual Account Available options: `activated`, `deactivated` [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#parameter-starting-after) starting\_after string This is a static memo id. If this is specified, the next page that starts with a static memo right AFTER the specified static memo id on the static memo timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that static memo older than the specified static memo id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#parameter-ending-before) ending\_before string This is a static memo id. If this is specified, the previous page that ends with a static memo right BEFORE the specified static memo id on the static memo timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that static memo newer than the specified static memo id will be returned (shouldn't be set if starting\_after is set) #### Response 200 - application/json List of Static Memos [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#response-count) count integer required total number of items in data [​](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Virtual Account Activity Across All Customers](https://apidocs.bridge.xyz/api-reference/virtual-accounts/virtual-account-activity-across-all-customers) [List Static Memos for Customer](https://apidocs.bridge.xyz/api-reference/static-memos/list-static-memos-for-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all static templates - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Transfers Get all static templates [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all static templates cURL curl --request GET \ --url https://api.bridge.xyz/v0/transfers/static_templates \ --header 'Api-Key: ' 200 TransfersFound { "count": 2, "data": [\ {\ "$ref": "#/components/examples/AchOnrampFundsReceivedTransferResponse"\ },\ {\ "$ref": "#/components/examples/AchOfframpTransferResponse"\ }\ ] } GET / transfers / static\_templates Try it Get all static templates cURL curl --request GET \ --url https://api.bridge.xyz/v0/transfers/static_templates \ --header 'Api-Key: ' 200 TransfersFound { "count": 2, "data": [\ {\ "$ref": "#/components/examples/AchOnrampFundsReceivedTransferResponse"\ },\ {\ "$ref": "#/components/examples/AchOfframpTransferResponse"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates#parameter-starting-after) starting\_after string This is a transfer id. If this is specified, the next page that starts with a transfer right AFTER the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers older than the specified transfer id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates#parameter-ending-before) ending\_before string This is a transfer id. If this is specified, the previous page that ends with a transfer right BEFORE the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers newer than the specified transfer id will be returned (shouldn't be set if starting\_after is set) #### Response 200 application/json List of static templates (the returned list is empty if none found). Static templates are transfers that are used as templates for other transfers and can be created using the static\_templates feature flag. [​](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates#response-count) count integer required The number of static templates returned [​](https://apidocs.bridge.xyz/api-reference/transfers/get-all-static-templates#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Delete a transfer](https://apidocs.bridge.xyz/api-reference/transfers/delete-a-transfer) [Get a list of all Prefunded Account](https://apidocs.bridge.xyz/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Update a Static Memo - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Static Memos Update a Static Memo [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Update a Static Memo cURL curl --request PUT \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos/{staticMemoID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "developer_fee_percent": "0.1" } ' 200 { "id": "", "developer_fee_percent": "0.1", "source_deposit_instructions": { "currency": "usd", "payment_rails": [\ "ach_push",\ "wire"\ ], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "created_at": "2023-11-07T05:31:56Z" } PUT / customers / {customerID} / static\_memos / {staticMemoID} Try it Update a Static Memo cURL curl --request PUT \ --url https://api.bridge.xyz/v0/customers/{customerID}/static_memos/{staticMemoID} \ --header 'Api-Key: ' \ --header 'Content-Type: application/json' \ --data ' { "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "developer_fee_percent": "0.1" } ' 200 { "id": "", "developer_fee_percent": "0.1", "source_deposit_instructions": { "currency": "usd", "payment_rails": [\ "ach_push",\ "wire"\ ], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321" }, "destination": { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef" }, "created_at": "2023-11-07T05:31:56Z" } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#parameter-static-memo-id) staticMemoID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Body application/json The Static Memo details to be updated [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#body-destination) destination object Show child attributes Example: { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#body-developer-fee-percent) developer\_fee\_percent string The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` #### Response 200 - application/json Updated Static Memo object [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#response-id) id string A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#response-developer-fee-percent) developer\_fee\_percent string The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API. Example: `"0.1"` [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#response-source-deposit-instructions) source\_deposit\_instructions object Show child attributes Example: { "currency": "usd", "payment_rails": ["ach_push", "wire"], "deposit_message": "EXAMPLE_MEMO_MESSAGE", "bank_name": "Lead Bank", "bank_address": "1801 Main St., Kansas City, MO 64108", "bank_beneficiary_name": "Bridge Ventures Inc", "bank_beneficiary_address": "21750 Hardy Oak Blvd, Ste 104 PMB 77950, San Antonio, Texas, 78258-4946", "bank_account_number": "123456789", "bank_routing_number": "87654321"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#response-destination) destination object Show child attributes Example: { "currency": "usdc", "payment_rail": "polygon", "address": "0xdeadbeef"} [​](https://apidocs.bridge.xyz/api-reference/static-memos/update-a-static-memo#response-created-at) created\_at string Time of creation of the static memo Was this page helpful? YesNo [Get a Static Memo](https://apidocs.bridge.xyz/api-reference/static-memos/get-a-static-memo) [Static Memo Activity](https://apidocs.bridge.xyz/api-reference/static-memos/static-memo-activity) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Generate a card statement using Stripe IDs - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Generate a card statement using Stripe IDs [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Generate a card statement using Stripe IDs cURL curl --request POST \ --url https://api.bridge.xyz/v0/cardholders/{cardholderID}/cards/{cardID}/statements/{period}.pdf \ --header 'Api-Key: ' 200 Example "" POST / cardholders / {cardholderID} / cards / {cardID} / statements / {period} .pdf Try it Generate a card statement using Stripe IDs cURL curl --request POST \ --url https://api.bridge.xyz/v0/cardholders/{cardholderID}/cards/{cardID}/statements/{period}.pdf \ --header 'Api-Key: ' 200 Example "" #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids#parameter-cardholder-id) cardholderID string required The Stripe cardholder ID (e.g. `ich_...`) [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids#parameter-card-id) cardID string required The Stripe card ID (e.g. `ic_...`) [​](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-statement-using-stripe-ids#parameter-period) period string required A string in the `YYYYMM` format representing a card statement period #### Response 200 application/pdf The HTTP response that includes a PDF file as an attachment, with the `Content-Type` set to `application/pdf` and the `Content-Disposition` header configured to indicate it is a statement PDF attachment The response is of type `file`. Was this page helpful? YesNo [Generate a card account statement](https://apidocs.bridge.xyz/api-reference/cards/generate-a-card-account-statement) [Create a Batch Settlement Schedule](https://apidocs.bridge.xyz/api-reference/batch-settlements/create-a-batch-settlement-schedule) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get a summary of your card program - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Get a summary of your card program [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get a summary of your card program cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/cards/summary \ --header 'Api-Key: ' 200 Example { "period": "year", "period_starting": "2025-01-01", "cards_provisioned_count": 1123, "card_transactions_count": 31415, "provisioned_cards_by_country": { "USA": 123, "MEX": 45 }, "transaction_volume": "-100.0", "transacting_card_accounts_count": 2047, "card_transactions_count_by_country": { "USA": 74, "MEX": 55 }, "transaction_volume_by_country": { "USA": "7.04", "MEX": "5.0" }, "transacting_cards_by_country": { "USA": 123, "MEX": 45 } } GET / developer / cards / summary Try it Get a summary of your card program cURL curl --request GET \ --url https://api.bridge.xyz/v0/developer/cards/summary \ --header 'Api-Key: ' 200 Example { "period": "year", "period_starting": "2025-01-01", "cards_provisioned_count": 1123, "card_transactions_count": 31415, "provisioned_cards_by_country": { "USA": 123, "MEX": 45 }, "transaction_volume": "-100.0", "transacting_card_accounts_count": 2047, "card_transactions_count_by_country": { "USA": 74, "MEX": 55 }, "transaction_volume_by_country": { "USA": "7.04", "MEX": "5.0" }, "transacting_cards_by_country": { "USA": 123, "MEX": 45 } } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#authorization-api-key) Api-Key string header required #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#parameter-period) period enum required The type of period to summarize the card program by. If `lifetime` is specified, the `period_key` is not required. Available options: `year`, `month`, `week`, `day`, `lifetime` [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#parameter-period-key) period\_key string A string to indicate the period to retrieve the card program summary for. * For `year`, the period key should be in the `YYYY` format * For `month`, the period key should be in the `YYYYMM` format * For `week`, the period key should be in the `YYYYMMDD` format indicating the beginning day of the week. * For `day`, the period key should be in the `YYYYMMDD` format * For `lifetime`, the period key is not required Note that if a specific period is specified, this endpoint currently only supports fetching for periods with complete data (e.g. only up to the previous year, month, week, or day). #### Response 200 application/json The summary of a card program The summary of a card program for a given period [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-period) period enum The period type of the card program summary Available options: `year`, `month`, `week`, `day`, `lifetime` [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-period-starting) period\_starting string The starting date of the period, in ISO8601 format Example: `"2025-01-01"` [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-cards-provisioned-count) cards\_provisioned\_count integer The number of cards provisioned during the period Example: `1123` [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-card-transactions-count) card\_transactions\_count integer The number of card transactions during the period, excluding refunds. Example: `31415` [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-provisioned-cards-by-country) provisioned\_cards\_by\_country object The number of cards provisioned during the period, by issuing country. The key is the ISO-3166-1 alpha-3 country code, and the value is the number of cards provisioned for that issuing country. Example: { "USA": 123, "MEX": 45 } [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-transaction-volume) transaction\_volume string The total transaction volume during the period, in USD Example: `"-100.0"` [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-transacting-card-accounts-count) transacting\_card\_accounts\_count integer The number of card accounts that transacted during the period Example: `2047` [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-card-transactions-count-by-country) card\_transactions\_count\_by\_country object The number of card transactions during the period, by merchant country. The key is the ISO-3166-1 alpha-3 country code, and the value is the number of card transactions for that merchant country. Example: { "USA": 74, "MEX": 55 } [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-transaction-volume-by-country) transaction\_volume\_by\_country object The transaction volume during the period, by merchant country. The key is the ISO-3166-1 alpha-3 country code, and the value is the transaction volume for that merchant country. Example: { "USA": "7.04", "MEX": "5.0" } [​](https://apidocs.bridge.xyz/api-reference/cards/get-a-summary-of-your-card-program#response-transacting-cards-by-country) transacting\_cards\_by\_country object The number of cards that transacted during the period, by issuing country. The key is the ISO-3166-1 alpha-3 country code, and the value is the number of cards transacted for that issuing country. Example: { "USA": 123, "MEX": 45 } Was this page helpful? YesNo [Generate an Ephemeral Key to Reveal Card Details](https://apidocs.bridge.xyz/api-reference/cards/generate-an-ephemeral-key-to-reveal-card-details) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Retrieve authorization controls - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Cards Retrieve authorization controls [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Retrieve authorization controls cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/auth_controls \ --header 'Api-Key: ' 200 Example { "customer_id": "", "card_account_id": "", "spending_limits": [\ {\ "period": "daily",\ "total_amount": "",\ "remaining_amount": "",\ "timezone": "",\ "next_reset_at": "",\ "currency": "usd"\ }\ ] } GET / customers / {customerID} / card\_accounts / {cardAccountID} / auth\_controls Try it Retrieve authorization controls cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts/{cardAccountID}/auth_controls \ --header 'Api-Key: ' 200 Example { "customer_id": "", "card_account_id": "", "spending_limits": [\ {\ "period": "daily",\ "total_amount": "",\ "remaining_amount": "",\ "timezone": "",\ "next_reset_at": "",\ "currency": "usd"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` [​](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls#parameter-card-account-id) cardAccountID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Response 200 application/json The authorization controls [​](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls#response-customer-id) customer\_id string required The ID of the customer [​](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls#response-card-account-id) card\_account\_id string required The ID of the card account [​](https://apidocs.bridge.xyz/api-reference/cards/retrieve-authorization-controls#response-spending-limits) spending\_limits object\[\] required The various spending limits for the card account for the current time period Show child attributes Was this page helpful? YesNo [Retrieve a card transaction](https://apidocs.bridge.xyz/api-reference/cards/retrieve-a-card-transaction) [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) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Get all transfers - Bridge [Skip to main content](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Customers Get all transfers [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Get all transfers cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/transfers \ --header 'Api-Key: ' 200 TransfersFound { "count": 2, "data": [\ {\ "$ref": "#/components/examples/AchOnrampFundsReceivedTransferResponse/value"\ },\ {\ "$ref": "#/components/examples/AchOfframpTransferResponse/value"\ }\ ] } GET / customers / {customerID} / transfers Try it Get all transfers cURL curl --request GET \ --url https://api.bridge.xyz/v0/customers/{customerID}/transfers \ --header 'Api-Key: ' 200 TransfersFound { "count": 2, "data": [\ {\ "$ref": "#/components/examples/AchOnrampFundsReceivedTransferResponse/value"\ },\ {\ "$ref": "#/components/examples/AchOfframpTransferResponse/value"\ }\ ] } #### Authorizations [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#authorization-api-key) Api-Key string header required #### Path Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-customer-id) customerID string required A UUID that uniquely identifies a resource Required string length: `1 - 42` Pattern: `[a-z0-9]*` #### Query Parameters [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-limit) limit integer The number of items to return (default of 10, max of 100) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-starting-after) starting\_after string This is a transfer id. If this is specified, the next page that starts with a transfer right AFTER the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers older than the specified transfer id will be returned (shouldn't be set if ending\_before is set) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-ending-before) ending\_before string This is a transfer id. If this is specified, the previous page that ends with a transfer right BEFORE the specified transfer id on the transfer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that transfers newer than the specified transfer id will be returned (shouldn't be set if starting\_after is set) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-tx-hash) tx\_hash string The hash of the transaction [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-updated-after-ms) updated\_after\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-updated-before-ms) updated\_before\_ms integer This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#parameter-state) state enum Filter transfers by their external state. See [Transfer States](https://apidocs.bridge.xyz/platform/orchestration/transfers/transfer-states) for more details. Available options: `awaiting_funds`, `funds_received`, `payment_submitted`, `payment_processed`, `in_review`, `kyc_required`, `kyc_in_review`, `developer_kyb_required`, `canceled`, `error`, `returned`, `refund_in_flight`, `refund_failed`, `refunded`, `undeliverable` #### Response 200 application/json List of transfers (the returned list is empty if none found) [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#response-count) count integer required The number of transfers returned [​](https://apidocs.bridge.xyz/api-reference/customers/get-all-transfers#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [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) [Get all static templates for a customer](https://apidocs.bridge.xyz/api-reference/customers/get-all-static-templates-for-a-customer) ⌘I Assistant Responses are generated using AI and may contain mistakes. --- # Payroll - Bridge [Skip to main content](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll#content-area) [Bridge home page![light logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)![dark logo](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/logo/bridge_logo.png?fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=3da6f2e8f14f2b938d7a051e797ffc2d)](https://apidocs.bridge.xyz/) Search... ⌘KAsk AI Search... Navigation Common use cases Payroll [Home](https://apidocs.bridge.xyz/) [Get Started](https://apidocs.bridge.xyz/get-started/introduction/overview) [Developer Platform](https://apidocs.bridge.xyz/platform/orchestration/overview) [API reference](https://apidocs.bridge.xyz/api-reference/introduction/introduction) [Changelog](https://apidocs.bridge.xyz/changelog/changelog) Enable employers to pay employees and contractors globally by creating a wallet and virtual account for the employer and a wallet for each employee. Fiat deposits into the virtual account are converted to stablecoins and held in the employer’s wallet. Use the Transfers API to pay out funds from the employer to the employee. ![Payroll.png](https://mintcdn.com/bridge-727305d3/cQZ0TmcY4hf9xT0k/images/Payroll.png?w=2500&fit=max&auto=format&n=cQZ0TmcY4hf9xT0k&q=85&s=5bba4eea1998a5ea84ac9357c81331fa) * * * [​](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll#step-1-generate-your-api-keys) Step 1: Generate your API Keys ------------------------------------------------------------------------------------------------------------------------------------------- Head over to [**dashboard.bridge.xyz**](https://dashboard.bridge.xyz/) . Once logged in, click on the “API Keys” tab on the top menu bar and generate a new API key. Bridge will make your **API key available only once**, so make sure to **immediately copy and save the key safely and securely**. Your key is used to authenticate into our APIs and is highly sensitive. If it ever gets compromised, you can immediately revoke key access from our dashboard and generate a new key. [​](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll#step-2-onboard-a-customer) Step 2: Onboard a customer ----------------------------------------------------------------------------------------------------------------------------------- Create a customer ID for each employer to manage payroll. Customers will need to accept our terms of service and complete KYC. Check out this [guide](https://apidocs.bridge.xyz/get-started/introduction/quick-start/create-your-first-customer) for a full in depth explanation on onboarding customers. The below example walks you through using a KYC link to onboard your customer. Request curl --location --request POST 'https://api.bridge.xyz/v0/kyc_links' \ --header 'Content-Type: application/json' \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --data-raw '{ "full_name": "John Doe", "email": "johndoe@example.com", "type": "individual" }' Response { "id": "uuid", "full_name": "John Doe", "email": "johndoe@example.com", "type": "individual", // or "business" "kyc_link": "https://bridge.withpersona.com/verify?", "tos_link": "https://dashboard.bridge.xyz/accept-terms-of-service?", "kyc_status": "not_started", // or "under_review", "incomplete", "approved" or "rejected" "rejection_reasons": [], "tos_status": "pending", // or "approved" "created_at": "2025-07-16T18:28:25.970Z", "customer_id": "customer_id", "persona_inquiry_type": "gov_id_db" } Guide the user through: 1. Visiting the `tos_link` and accepting terms of service 2. Completing identity verification via the `kyc_link` This process typically takes less than a minute and updates automatically once complete. [​](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll#step-3-create-a-wallet-for-the-employer) Step 3: Create a wallet for the employer --------------------------------------------------------------------------------------------------------------------------------------------------------------- Create a wallet to hold the employer’s payroll funds. Request curl --request POST \ --url https://api.bridge.xyz/v0/customers/{employer-customer-id}/wallets \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data '{ "chain": "solana" }' Response { "id": "employer-wallet-id-123", "chain": "solana", "address": "0x353253250000000001340033", "created_at": "2024-09-01T02:03:04.567Z", "updated_at": "2024-09-01T02:03:04.567Z" } [​](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll#step-4-create-a-wallet-for-an-employee) Step 4: Create a wallet for an employee ------------------------------------------------------------------------------------------------------------------------------------------------------------- Create a wallet for each employee to get paid in stablecoins. Request curl --request POST \ --url https://api.bridge.xyz/v0/customers/{employee-customer-id}/wallets \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data '{ "chain": "solana" }' Response { "id": "employee-wallet-id-abc", "chain": "solana", "address": "0x444415153153500000120", "created_at": "2024-09-01T02:03:04.567Z", "updated_at": "2024-09-01T02:03:04.567Z" } [​](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll#step-5-create-a-virtual-account) Step 5: Create a virtual account ----------------------------------------------------------------------------------------------------------------------------------------------- Create a USD or EUR account for the employer. Provide them with the bank instructions so they can deposit payroll. Deposits are converted to stablecoins and sent to their wallet. Use the [Virtual Accounts](https://apidocs.bridge.xyz/api-reference/virtual-accounts/create-a-virtual-account) API to provision permanent fiat deposit addresses for your customers. You define the `source` currency for the account and configure the `destination` to specify where Bridge should deliver the converted funds. Bridge handles the fiat-to-crypto conversion and sends the funds on-chain automatically. Request curl --location --request POST 'https://api.bridge.xyz/v0/customers//virtual_accounts' \ --header 'Content-Type: application/json' \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --data-raw '{ # The source object specifies a USD virtual account. "source": { "currency": "usd", }, # You can specify the employer's wallet as the destination to receive funds "destination": { "payment_rail": "solana", "currency": "usdc", "bridge_wallet_id": "employer-wallet-id-123" } }' [​](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/payroll#step-6-make-a-transfer) Step 6: Make a transfer ----------------------------------------------------------------------------------------------------------------------------- Use the Transfers API to move funds from the employer’s wallet to the employee’s wallet. You will need to call the API for each employee. Use the [Transfers](https://apidocs.bridge.xyz/api-reference/transfers/create-a-transfer) API with the employer’s `bridge_wallet` as the source and the employee’s `bridge_wallet` as the destination. Request curl --location --request POST 'https://api.bridge.xyz/v0/transfers' \ --header 'Api-Key: ' \ --header 'Idempotency-Key: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "amount": "10.0", "on_behalf_of": "", "developer_fee": "0.0", "source": { "payment_rail": "bridge_wallet", "currency": "usdc", "bridge_wallet_id": "employer-wallet-id-123" }, "destination": { "payment_rail": "solana", "currency": "usdc", "bridge_wallet_id": "employee-wallet-id-abc" } }' Bridge will then initiate a crypto transfer from between the two specified bridge wallets. Was this page helpful? YesNo [Remittances](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/remittances) [Cross-border payments](https://apidocs.bridge.xyz/get-started/guides/common-use-cases/cross-border-payments) ⌘I Assistant Responses are generated using AI and may contain mistakes. ---