Get company bank account

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description

swagger.json

swagger.yaml

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://docs.fluid.app/_mock/docs/apis/swagger/

Production server with company subdomain

https://{company}.fluid.app/

Local development server

http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

List company bank accounts

Request

Path

company_idintegerrequired

Example: 1

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/bank_accounts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

bank accounts retrieved

Bodyapplication/json

bank_accountsArray of objectsrequired

bank_accounts[].idinteger

Example: 1

bank_accounts[].entity_idinteger

Example: 1

bank_accounts[].bank_namestring

Example: "Chase Bank"

bank_accounts[].holder_namestring

Example: "John Doe"

bank_accounts[].account_numberstring

Example: "1234567890"

bank_accounts[].routing_numberstring or null

Example: "021000021"

bank_accounts[].swift_bicstring or null

Example: "CHASUSUS33"

bank_accounts[].country_isostring or null

Example: "US"

bank_accounts[].currency_isostring or null

Example: "USD"

bank_accounts[].citystring or null

Example: "New York"

bank_accounts[].primaryboolean

Example: false

bank_accounts[].statusstring

Enum"active""inactive"

Example: "active"

bank_accounts[].last_3_months_bank_statements_file_urlstring or null

Example: "https://example.com/bank-statements.pdf"

bank_accounts[].last_3_months_bank_statements_file_namestring or null

Example: "bank-statements.pdf"

bank_accounts[].bank_letter_or_voided_check_file_urlstring or null

Example: "https://example.com/bank-letter.pdf"

bank_accounts[].bank_letter_or_voided_check_file_namestring or null

Example: "bank-letter.pdf"

bank_accounts[].created_atstring

Example: "2025-01-15T10:30:00Z"

bank_accounts[].updated_atstring

Example: "2025-01-15T10:30:00Z"

metaobjectrequired

Response

application/json

{
  "bank_accounts": [
    { … }
  ],
  "meta": {}
}

Create company bank account

Request

Path

company_idintegerrequired

Example: 1

Bodyapplication/json

bank_accountobjectrequired

bank_account.entity_idintegerrequired

Associated entity ID

Example: 1

bank_account.bank_namestringrequired

Bank name

Example: "Chase Bank"

bank_account.holder_namestringrequired

Account holder name

Example: "John Doe"

bank_account.account_numberstringrequired

Bank account number

Example: "1234567890"

bank_account.routing_numberstring or null

Bank routing number

Example: "021000021"

bank_account.swift_bicstring or null

SWIFT/BIC code

Example: "CHASUSUS33"

bank_account.country_isostring or null

Country ISO code

Example: "US"

bank_account.currency_isostring or null

Currency ISO code

Example: "USD"

bank_account.citystring or null

City

Example: "New York"

bank_account.primaryboolean

Whether this is the primary bank account

Example: false

bank_account.statusstring

Bank account status (active or inactive)

Enum"active""inactive"

Example: "active"

bank_account.last_3_months_bank_statements_file_urlstring or null

Last 3 months bank statements document file URL

Example: "https://example.com/bank-statements.pdf"

bank_account.last_3_months_bank_statements_file_namestring or null

Last 3 months bank statements document file name

Example: "bank-statements.pdf"

bank_account.bank_letter_or_voided_check_file_urlstring or null

Bank letter or voided check document file URL

Example: "https://example.com/bank-letter.pdf"

bank_account.bank_letter_or_voided_check_file_namestring or null

Bank letter or voided check document file name

Example: "bank-letter.pdf"

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/bank_accounts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account": {
      "entity_id": 1,
      "bank_name": "Chase Bank",
      "holder_name": "John Doe",
      "account_number": "1234567890",
      "routing_number": "021000021",
      "swift_bic": "CHASUSUS33",
      "country_iso": "US",
      "currency_iso": "USD",
      "city": "New York",
      "primary": false,
      "status": "active",
      "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf",
      "last_3_months_bank_statements_file_name": "bank-statements.pdf",
      "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf",
      "bank_letter_or_voided_check_file_name": "bank-letter.pdf"
    }
  }'

Responses

bank account created

Bodyapplication/json

bank_accountobjectrequired

bank_account.idinteger

Example: 1

bank_account.entity_idinteger

Example: 1

bank_account.bank_namestring

Example: "Chase Bank"

bank_account.holder_namestring

Example: "John Doe"

bank_account.account_numberstring

Example: "1234567890"

bank_account.routing_numberstring or null

Example: "021000021"

bank_account.swift_bicstring or null

Example: "CHASUSUS33"

bank_account.country_isostring or null

Example: "US"

bank_account.currency_isostring or null

Example: "USD"

bank_account.citystring or null

Example: "New York"

bank_account.primaryboolean

Example: false

bank_account.statusstring

Enum"active""inactive"

Example: "active"

bank_account.last_3_months_bank_statements_file_urlstring or null

Example: "https://example.com/bank-statements.pdf"

bank_account.last_3_months_bank_statements_file_namestring or null

Example: "bank-statements.pdf"

bank_account.bank_letter_or_voided_check_file_urlstring or null

Example: "https://example.com/bank-letter.pdf"

bank_account.bank_letter_or_voided_check_file_namestring or null

Example: "bank-letter.pdf"

bank_account.created_atstring

Example: "2025-01-15T10:30:00Z"

bank_account.updated_atstring

Example: "2025-01-15T10:30:00Z"

metaobjectrequired

Response

application/json

{
  "bank_account": {
    "id": 1,
    "entity_id": 1,
    "bank_name": "Chase Bank",
    "holder_name": "John Doe",
    "account_number": "1234567890",
    "routing_number": "021000021",
    "swift_bic": "CHASUSUS33",
    "country_iso": "US",
    "currency_iso": "USD",
    "city": "New York",
    "primary": false,
    "status": "active",
    "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf",
    "last_3_months_bank_statements_file_name": "bank-statements.pdf",
    "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf",
    "bank_letter_or_voided_check_file_name": "bank-letter.pdf",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Get company bank account

Request

Path

company_idintegerrequired

Example: 1

idintegerrequired

Example: 1

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/bank_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

bank account retrieved

Bodyapplication/json

bank_accountobjectrequired

bank_account.idinteger

Example: 1

bank_account.entity_idinteger

Example: 1

bank_account.bank_namestring

Example: "Chase Bank"

bank_account.holder_namestring

Example: "John Doe"

bank_account.account_numberstring

Example: "1234567890"

bank_account.routing_numberstring or null

Example: "021000021"

bank_account.swift_bicstring or null

Example: "CHASUSUS33"

bank_account.country_isostring or null

Example: "US"

bank_account.currency_isostring or null

Example: "USD"

bank_account.citystring or null

Example: "New York"

bank_account.primaryboolean

Example: false

bank_account.statusstring

Enum"active""inactive"

Example: "active"

bank_account.last_3_months_bank_statements_file_urlstring or null

Example: "https://example.com/bank-statements.pdf"

bank_account.last_3_months_bank_statements_file_namestring or null

Example: "bank-statements.pdf"

bank_account.bank_letter_or_voided_check_file_urlstring or null

Example: "https://example.com/bank-letter.pdf"

bank_account.bank_letter_or_voided_check_file_namestring or null

Example: "bank-letter.pdf"

bank_account.created_atstring

Example: "2025-01-15T10:30:00Z"

bank_account.updated_atstring

Example: "2025-01-15T10:30:00Z"

metaobjectrequired

Response

application/json

{
  "bank_account": {
    "id": 1,
    "entity_id": 1,
    "bank_name": "Chase Bank",
    "holder_name": "John Doe",
    "account_number": "1234567890",
    "routing_number": "021000021",
    "swift_bic": "CHASUSUS33",
    "country_iso": "US",
    "currency_iso": "USD",
    "city": "New York",
    "primary": false,
    "status": "active",
    "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf",
    "last_3_months_bank_statements_file_name": "bank-statements.pdf",
    "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf",
    "bank_letter_or_voided_check_file_name": "bank-letter.pdf",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Update company bank account

Request

Path

company_idintegerrequired

Example: 1

idintegerrequired

Example: 1

Bodyapplication/json

bank_accountobjectrequired

bank_account.entity_idinteger or null

Associated entity ID

Example: 1

bank_account.bank_namestring or null

Bank name

Example: "Chase Bank"

bank_account.holder_namestring or null

Account holder name

Example: "John Doe"

bank_account.account_numberstring or null

Bank account number

Example: "1234567890"

bank_account.routing_numberstring or null

Bank routing number

Example: "021000021"

bank_account.swift_bicstring or null

SWIFT/BIC code

Example: "CHASUSUS33"

bank_account.country_isostring or null

Country ISO code

Example: "US"

bank_account.currency_isostring or null

Currency ISO code

Example: "USD"

bank_account.citystring or null

City

Example: "New York"

bank_account.primaryboolean

Whether this is the primary bank account

Example: false

bank_account.statusstring

Bank account status (active or inactive)

Enum"active""inactive"

Example: "active"

bank_account.last_3_months_bank_statements_file_urlstring or null

Last 3 months bank statements document file URL

Example: "https://example.com/bank-statements.pdf"

bank_account.last_3_months_bank_statements_file_namestring or null

Last 3 months bank statements document file name

Example: "bank-statements.pdf"

bank_account.bank_letter_or_voided_check_file_urlstring or null

Bank letter or voided check document file URL

Example: "https://example.com/bank-letter.pdf"

bank_account.bank_letter_or_voided_check_file_namestring or null

Bank letter or voided check document file name

Example: "bank-letter.pdf"

curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/bank_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account": {
      "entity_id": 1,
      "bank_name": "Chase Bank",
      "holder_name": "John Doe",
      "account_number": "1234567890",
      "routing_number": "021000021",
      "swift_bic": "CHASUSUS33",
      "country_iso": "US",
      "currency_iso": "USD",
      "city": "New York",
      "primary": false,
      "status": "active",
      "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf",
      "last_3_months_bank_statements_file_name": "bank-statements.pdf",
      "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf",
      "bank_letter_or_voided_check_file_name": "bank-letter.pdf"
    }
  }'

Responses

bank account updated

Bodyapplication/json

bank_accountobjectrequired

bank_account.idinteger

Example: 1

bank_account.entity_idinteger

Example: 1

bank_account.bank_namestring

Example: "Chase Bank"

bank_account.holder_namestring

Example: "John Doe"

bank_account.account_numberstring

Example: "1234567890"

bank_account.routing_numberstring or null

Example: "021000021"

bank_account.swift_bicstring or null

Example: "CHASUSUS33"

bank_account.country_isostring or null

Example: "US"

bank_account.currency_isostring or null

Example: "USD"

bank_account.citystring or null

Example: "New York"

bank_account.primaryboolean

Example: false

bank_account.statusstring

Enum"active""inactive"

Example: "active"

bank_account.last_3_months_bank_statements_file_urlstring or null

Example: "https://example.com/bank-statements.pdf"

bank_account.last_3_months_bank_statements_file_namestring or null

Example: "bank-statements.pdf"

bank_account.bank_letter_or_voided_check_file_urlstring or null

Example: "https://example.com/bank-letter.pdf"

bank_account.bank_letter_or_voided_check_file_namestring or null

Example: "bank-letter.pdf"

bank_account.created_atstring

Example: "2025-01-15T10:30:00Z"

bank_account.updated_atstring

Example: "2025-01-15T10:30:00Z"

metaobjectrequired

Response

application/json

{
  "bank_account": {
    "id": 1,
    "entity_id": 1,
    "bank_name": "Chase Bank",
    "holder_name": "John Doe",
    "account_number": "1234567890",
    "routing_number": "021000021",
    "swift_bic": "CHASUSUS33",
    "country_iso": "US",
    "currency_iso": "USD",
    "city": "New York",
    "primary": false,
    "status": "active",
    "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf",
    "last_3_months_bank_statements_file_name": "bank-statements.pdf",
    "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf",
    "bank_letter_or_voided_check_file_name": "bank-letter.pdf",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Delete company bank account

Request

Path

company_idintegerrequired

Example: 1

idintegerrequired

Example: 1

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/bank_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

bank account deleted

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shop

Operations

Sitemap

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantCountries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

Get a specific media

Request

Path

idintegerrequired

Media ID

Example: 1

Query

language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/media/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media retrieved successfully

Bodyapplication/json

idintegerrequired

user_idinteger or null

titlestringrequired

descriptionobject or null

strippedstring or null

media_typestringrequired

Enum"share""update""training""upload"

media_formatstring or null

image_urlstring or null

video_urlstring or null

pdf_urlstring or null

kindstring or null

activebooleanrequired

visibilityinteger or null

share_linkstring or null

preview_linkstring or null

viewsintegerrequired

leadsintegerrequired

watchobject or null

video_statusstring or null

durationinteger or null

cta_urlstring or null

cta_button_textstring or null

cta_enabledbooleanrequired

cta_action_typestring or null

video_shopping_enabledbooleanrequired

prompts_enabledbooleanrequired

ranksArray of strings

settingsobject or null

application_theme_template_idinteger or null

created_atstring(date-time)required

subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects

tagsArray of objects

slugstring or null

URL-friendly slug for the media item

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects

commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

Response

application/json

{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string"
}

Fluid Commerce APIs (1.0)

Admins

Agreements

Announcements

ApplePay

Application Themes

ApplicationThemeResources

ApplicationThemeTemplates

Authentication

Bank Accounts

List company bank accounts

Request

Responses

Was this helpful?

Create company bank account

RequestExpand all

Responses

Was this helpful?

Get company bank account

Request

Responses

Was this helpful?

Update company bank account

RequestExpand all

Responses

Was this helpful?

Delete company bank account

Request

Responses

Was this helpful?

Brand Guidelines

Business Types

Callback Definitions

Callback Registrations

Callback Schemas

Carts

Catch Ups

Categories

Checkout

Collections

Companies

Company Countries

Contacts

Countries

Currencies

Customer Orders

CustomerNotes

Customers

DAM Query

Dam

Default Libraries

DefaultMySites

Devices

Discounts

Display Settings

Domains

Drop Zones

Droplet Categories

Droplet Installations

Droplets

Enrollment Packs

Enrollments

Entities

FairShare Order Journey

Fantasy Points

Feature Flags

File Resources

Fluid Orchestration

Fluid Orchestration - Configurations

Fluid Orchestration - Rule Based

Fluid Orchestration - Default Fallback

Fluid Pay

Form Elements

Forms

GlobalEmbeds

Impersonation

Inventory Levels

Labels

Languages

MCC Codes

Request

Request