The Bridge API to move into, out of, and between any form of a dollar — customers/KYC, transfers, virtual accounts, liquidation addresses, Bridge Wallets, external accounts, cards, exchange rates, webhooks, and more. 128 operations across 24 resource groups. OpenAPI 3.0.2.
{
"openapi": "3.0.2",
"info": {
"title": "Bridge API",
"description": "APIs to move into, out of, and between any form of a dollar",
"version": "1"
},
"servers": [
{
"url": "https://api.bridge.xyz/v0",
"description": "The base path for all resources"
}
],
"tags": [
{
"name": "Customers"
},
{
"name": "Fiat Payout Configuration"
},
{
"name": "External Accounts"
},
{
"name": "Transfers"
},
{
"name": "Prefunded Accounts"
},
{
"name": "Balances"
},
{
"name": "Liquidation Addresses"
},
{
"name": "Developers"
},
{
"name": "API Keys"
},
{
"name": "Plaid"
},
{
"name": "Virtual Accounts"
},
{
"name": "Static Memos"
},
{
"name": "Cards"
},
{
"name": "Funds Requests"
},
{
"name": "Webhooks"
},
{
"name": "Lists"
},
{
"name": "Crypto Return Policies"
},
{
"name": "Rewards"
},
{
"name": "Associated Persons"
},
{
"name": "Sandbox"
}
],
"paths": {
"/wallets": {
"get": {
"summary": "Get all Bridge Wallets",
"description": "List of Bridge Wallets",
"tags": [
"Bridge Wallets"
],
"parameters": [
{
"$ref": "#/components/parameters/LimitParameter"
},
{
"$ref": "#/components/parameters/BridgeWalletStartingAfterParameter"
},
{
"$ref": "#/components/parameters/BridgeWalletEndingBeforeParameter"
}
],
"responses": {
"200": {
"description": "List of Bridge Wallets",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BridgeWalletsList"
},
"examples": {
"SuccessfulBridgeWalletListResponse": {
"$ref": "#/components/examples/SuccessfulBridgeWalletListResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/wallets/total_balances": {
"get": {
"summary": "Get total balances of all Bridge Wallets",
"tags": [
"Bridge Wallets"
],
"description": "Get the total balances of all Bridge Wallets",
"responses": {
"200": {
"description": "Total balances of all Bridge Wallets",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BridgeWalletTotalBalance"
}
},
"examples": {
"TotalBalancesFound": {
"$ref": "#/components/examples/SuccessfulTotalBalancesResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/wallets/{bridgeWalletID}": {
"get": {
"summary": "Get a Bridge Wallet",
"description": "Retrieve a Bridge Wallet by its ID",
"tags": [
"Bridge Wallets"
],
"parameters": [
{
"$ref": "#/components/parameters/BridgeWalletIDParameter"
}
],
"responses": {
"200": {
"description": "A Bridge Wallet object response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BridgeWalletWithBalances"
},
"examples": {
"SuccessfulBridgeWalletGetResponse": {
"$ref": "#/components/examples/SuccessfulBridgeWalletGetResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/wallets/{bridgeWalletID}/history": {
"parameters": [
{
"$ref": "#/components/parameters/BridgeWalletIDParameter"
},
{
"$ref": "#/components/parameters/LimitParameter"
},
{
"$ref": "#/components/parameters/BridgeWalletHistoryStartingAfterParameter"
},
{
"$ref": "#/components/parameters/BridgeWalletHistoryEndingBeforeParameter"
},
{
"$ref": "#/components/parameters/BridgeWalletHistoryStartingTimeParameter"
},
{
"$ref": "#/components/parameters/BridgeWalletHistoryEndingTimeParameter"
}
],
"get": {
"summary": "Get transaction history for a Bridge Wallet",
"tags": [
"Bridge Wallets"
],
"description": "Get the list of transactions involving this Bridge Wallet",
"responses": {
"200": {
"$ref": "#/components/responses/BridgeWalletHistoryResponse"
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/customers": {
"get": {
"summary": "Get all customers",
"description": "Get the full list of all customers created on Bridge",
"tags": [
"Customers"
],
"parameters": [
{
"$ref": "#/components/parameters/CustomerStartingAfterParameter"
},
{
"$ref": "#/components/parameters/CustomerEndingBeforeParameter"
},
{
"$ref": "#/components/parameters/LimitParameter"
},
{
"$ref": "#/components/parameters/CustomerEmailParameter"
}
],
"responses": {
"200": {
"description": "List of customers (the returned list is empty if none found)",
"content": {
"application/json": {
"schema": {
"title": "Customers",
"type": "object",
"required": [
"count",
"data"
],
"properties": {
"count": {
"description": "total number of items in data",
"type": "integer"
},
"data": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
"examples": {
"CustomersFound": {
"summary": "A non-empty list of customers",
"value": {
"data": [
{
"$ref": "#/components/examples/SuccessfulCustomerResponse/value"
},
{
"$ref": "#/components/examples/SuccessfulCustomerResponse2/value"
}
]
}
},
"NoCustomersFound": {
"summary": "An empty list of customers",
"value": {
"data": []
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"post": {
"summary": "Create a customer",
"tags": [
"Customers"
],
"parameters": [
{
"$ref": "#/components/parameters/IdempotencyKeyParameter"
}
],
"requestBody": {
"description": "Customer object to be created.\n\nNo fields are strictly required by the API. For example, it is valid to create a customer without a first name, last name, or residential address, but this customer will not be granted endorsements required to transact on Bridge until the necessary information is provided, possibly via a PUT request.\n",
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateIndividualCustomerPayload"
},
{
"$ref": "#/components/schemas/CreateBusinessCustomerPayload"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"individual": "#/components/schemas/CreateIndividualCustomerPayload",
"business": "#/components/schemas/CreateBusinessCustomerPayload"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Customer object created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
},
"examples": {
"IndividualCustomerCreated": {
"summary": "Customer successfully created",
"$ref": "#/components/examples/SuccessfulCustomerResponse"
},
"BusinessCustomerCreated": {
"summary": "Customer successfully created",
"$ref": "#/components/examples/SuccessfulCustomerResponse2"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/customers/{customerID}": {
"parameters": [
{
"$ref": "#/components/parameters/CustomerIDParameter"
}
],
"get": {
"summary": "Get a single customer object",
"tags": [
"Customers"
],
"description": "Retrieve a customer object from the passed in customer ID",
"responses": {
"200": {
"description": "Successful customer object response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
},
"examples": {
"SuccessfulCustomerResponse": {
"$ref": "#/components/examples/SuccessfulCustomerResponse"
},
"RejectedCustomerResponse": {
"$ref": "#/components/examples/RejectedCustomerResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"summary": "Update a single customer object",
"tags": [
"Customers"
],
"requestBody": {
"description": "Customer object to update with",
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateIndividualCustomerPayload"
},
{
"$ref": "#/components/schemas/UpdateBusinessCustomerPayload"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"individual": "#/components/schemas/UpdateIndividualCustomerPayload",
"business": "#/components/schemas/UpdateBusinessCustomerPayload"
}
}
}
}
}
},
"description": "Updates to be made to the specified customer.\n\nNo fields are strictly required by the API. It is generally valid to provide any subset of data in a PUT request. For business customers, associated persons cannot be updated via PUT, and should instead be managed using v0/associated_persons.\n",
"responses": {
"200": {
"description": "Successful customer object response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
},
"examples": {
"SuccessfulCustomerResponse": {
"$ref": "#/components/examples/SuccessfulCustomerResponse"
},
"RejectedCustomerResponse": {
"$ref": "#/components/examples/RejectedCustomerResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"summary": "Delete a single customer object",
"tags": [
"Customers"
],
"description": "Delete a customer object from the passed in customer ID",
"responses": {
"200": {
"description": "Successfully deleted customer object response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
},
"examples": {
"DeletedCustomerResponse": {
"$ref": "#/components/examples/SuccessfulCustomerResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/customers/{customerID}/external_accounts": {
"parameters": [
{
"$ref": "#/components/parameters/CustomerIDParameter"
}
],
"get": {
"summary": "Get all External Accounts",
"tags": [
"External Accounts"
],
"description": "Get all External Accounts for a passed in customer.",
"parameters": [
{
"$ref": "#/components/parameters/LimitParameter"
},
{
"$ref": "#/components/parameters/ExternalAccountStartingAfterParameter"
},
{
"$ref": "#/components/parameters/ExternalAccountEndingBeforeParameter"
}
],
"responses": {
"200": {
"description": "List of External Accounts (the returned list is empty if no External Accounts exist)",
"content": {
"application/json": {
"schema": {
"title": "ExternalAccount",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/ExternalAccountResponse"
}
},
"count": {
"description": "total number of items in data",
"type": "integer"
}
}
},
"examples": {
"ExternalAccountsFound": {
"summary": "A non-empty list of External Accounts",
"value": {
"data": [
{
"$ref": "#/components/examples/SuccessfulExternalAccountResponse/value"
}
]
}
},
"NoExternalAccountsFound": {
"summary": "An empty list of External Accounts",
"value": {
"data": [],
"count": 0
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"post": {
"summary": "Create a new External Account",
"tags": [
"External Accounts"
],
"description": "_Note_: If adding US external accounts, we recommend reading through the US Beneficiary Address Validation doc ([link](https://apidocs.bridge.xyz/docs/us-beneficiary-address-validation)) to avoid issues related to incorrect addresses.\n",
"parameters": [
{
"$ref": "#/components/parameters/IdempotencyKeyParameter"
}
],
"requestBody": {
"description": "New External Account object to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateExternalAccountInput"
},
"examples": {
"ACH": {
"$ref": "#/components/examples/CreateAchExternalAccountRequest"
},
"IBAN": {
"$ref": "#/components/examples/CreateIbanExternalAccountRequest"
},
"SWIFT": {
"$ref": "#/components/examples/CreateSwiftExternalAccountRequest"
},
"CLABE": {
"$ref": "#/components/examples/CreateClabeExternalAccountRequest"
},
"Pix_Key": {
"$ref": "#/components/examples/CreatePixExternalAccountRequest"
},
"Pix_BrCode": {
"$ref": "#/components/examples/CreateBrCodeExternalAccountRequest"
},
"BreB": {
"$ref": "#/components/examples/CreateBreBExternalAccountRequest"
},
"CO_Bank_Transfer": {
"$ref": "#/components/examples/CreateCoBankTransferExternalAccountRequest"
}
}
}
}
},
"responses": {
"201": {
"description": "External Account object created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalAccountResponse"
},
"examples": {
"ACH": {
"$ref": "#/components/examples/SuccessfulExternalAccountResponse"
},
"IBAN": {
"$ref": "#/components/examples/SuccessfulIbanExternalAccountResponse"
},
"SWIFT": {
"$ref": "#/components/examples/SuccessfulSwiftExternalAccountResponse"
},
"CLABE": {
"$ref": "#/components/examples/SuccessfulClabeExternalAccountResponse"
},
"Pix_Key": {
"$ref": "#/components/examples/SuccessfulPixKeyExternalAccountResponse"
},
"Pix_BrCode": {
"$ref": "#/components/examples/SuccessfulBrCodeExternalAccountResponse"
},
"BreB": {
"$ref": "#/components/examples/SuccessfulBreBExternalAccountResponse"
},
"CO_Bank_Transfer": {
"$ref": "#/components/examples/SuccessfulCoBankTransferExternalAccountResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/customers/{customerID}/external_accounts/{externalAccountID}": {
"parameters": [
{
"$ref": "#/components/parameters/CustomerIDParameter"
},
{
"$ref": "#/components/parameters/ExternalAccountIDParameter"
}
],
"get": {
"summary": "Retrieve an External Account object",
"description": "Retrieve an External Account object (banks, debit cards etc) from the passed in customer ID and External Account ID",
"tags": [
"External Accounts"
],
"responses": {
"200": {
"description": "Successful External Account object response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalAccountResponse"
},
"examples": {
"SuccessfulExternalAccountResponse": {
"$ref": "#/components/examples/SuccessfulExternalAccountResponse"
},
"SuccessfulIbanExternalAccountResponse": {
"$ref": "#/components/examples/SuccessfulIbanExternalAccountResponse"
},
"SuccessfulPixKeyExternalAccountResponse": {
"$ref": "#/components/examples/SuccessfulPixKeyExternalAccountResponse"
},
"SuccessfulBrCodeExternalAccountResponse": {
"$ref": "#/components/examples/SuccessfulBrCodeExternalAccountResponse"
},
"SuccessfulBreBExternalAccountResponse": {
"$ref": "#/components/examples/SuccessfulBreBExternalAccountResponse"
},
"SuccessfulCoBankTransferExternalAccountResponse": {
"$ref": "#/components/examples/SuccessfulCoBankTransferExternalAccountResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"summary": "Update an External Account",
"tags": [
"External Accounts"
],
"requestBody": {
"description": "External Account details to be updated",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateExternalAccountInput"
}
}
}
},
"responses": {
"200": {
"description": "External Account object updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalAccountResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadExternalAccountUpdateError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"delete": {
"summary": "Delete a single External Account object",
"tags": [
"External Accounts"
],
"description": "Delete an External Account object from the passed in External Account ID",
"responses": {
"200": {
"description": "Successfully deleted External Account object response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalAccountResponse"
},
"examples": {
"DeletedExternalAccountResponse": {
"$ref": "#/components/examples/SuccessfulExternalAccountResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/customers/{customerID}/associated_persons": {
"parameters": [
{
"$ref": "#/components/parameters/CustomerIDParameter"
}
],
"get": {
"summary": "Get associated persons for a business customer",
"tags": [
"Customers"
],
"description": "Get all associated persons for a business customer.",
"responses": {
"200": {
"description": "List of associated persons (the returned list is empty if none found)",
"content": {
"application/json": {
"schema": {
"title": "AssociatedPersonsList",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/AssociatedPersonResponse"
}
}
}
},
"examples": {
"AssociatedPersonsFound": {
"summary": "A non-empty list of associated persons",
"value": {
"data": [
{
"$ref": "#/components/examples/SuccessfulAssociatedPersonResponse/value"
}
]
}
},
"NoAssociatedPersonsFound": {
"summary": "An empty list of associated persons",
"value": {
"data": []
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"post": {
"summary": "Create a new associated person for a business customer",
"tags": [
"Customers"
],
"parameters": [
{
"$ref": "#/components/parameters/IdempotencyKeyParameter"
}
],
"requestBody": {
"description": "New associated person to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssociatedPerson"
}
}
}
},
"responses": {
"201": {
"description": "Associated person created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssociatedPersonResponse"
},
"examples": {
"SuccessfulAssociatedPersonResponse": {
"$ref": "#/components/examples/SuccessfulAssociatedPersonResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"400": {
"$ref": "#/components/responses/BadRequestError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
}
},
"/customers/{customerID}/associated_persons/{associatedPersonID}": {
"parameters": [
{
"$ref": "#/components/parameters/CustomerIDParameter"
},
{
"$ref": "#/components/parameters/AssociatedPersonIDParameter"
}
],
"get": {
"summary": "Get a single associated person",
"tags": [
"Customers"
],
"description": "Retrieve an associated person by ID",
"responses": {
"200": {
"description": "Successful associated person response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssociatedPersonResponse"
},
"examples": {
"SuccessfulAssociatedPersonResponse": {
"$ref": "#/components/examples/SuccessfulAssociatedPersonResponse"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationError"
},
"404": {
"$ref": "#/components/responses/NotFoundError"
},
"500": {
"$ref": "#/components/responses/UnexpectedError"
}
}
},
"put": {
"summary": "Update a single associated person",
"tags": [
"Customers"
],
"requestBody": {
"description": "Associated person data to update",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssociatedPerson"
}
}
}
},
"responses": {
"200": {
"description": "Updated associated person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssociatedPersonResponse"
},
"examples": {
"SuccessfulAssociatedPersonResponse
# --- truncated at 32 KB (728 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bridge/refs/heads/main/openapi/bridge-openapi-original.json