Payment
/
Tokenize credit card

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
Languages
Servers
Mock server
https://fluid-commerce.redocly.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 Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

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 Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

MCC Codes

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Tokenize credit card

Request

Bodyapplication/json
credit_cardobjectrequired
credit_card.​first_namestringrequired
credit_card.​last_namestringrequired
credit_card.​numberstringrequired
credit_card.​verification_valuestringrequired
credit_card.​monthstringrequired
credit_card.​yearstringrequired
credit_card.​emailstring
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/payments/tokenize_card \
  -H 'Content-Type: application/json' \
  -d '{
    "credit_card": {
      "first_name": "string",
      "last_name": "string",
      "number": "string",
      "verification_value": "string",
      "month": "string",
      "year": "string",
      "email": "string"
    }
  }'

Responses

Credit card response

Bodyapplication/json
transactionobject
metaobject
Response
application/json
{
  "transaction": {
    "token": "test_token_123",
    "created_at": "2025-03-06T12:00:00",
    "updated_at": "2025-03-06T12:00:00",
    "succeeded": true,
    "transaction_type": "AddPaymentMethod",
    "retained": true,
    "state": "succeeded",
    "message_key": "messages.transaction_succeeded",
    "message": "Succeeded!",
    "payment_method": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2025-02-03T08:04:10Z"
  }
}

Create payment record using payment account id and cart info

Request

Path
payment_account_idintegerrequired

ID of the existing payment account

Example: 123
Bodyapplication/jsonrequired
cart_tokenstringrequired
Example: "cart_token"
payment_methodobjectrequired
payment_method.​integration_classstringrequired
Example: "Droplet"
payment_method.​sourcestringrequired
Example: "droplet"
curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/payments/{payment_account_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "cart_token": "cart_token",
    "payment_method": {
      "integration_class": "Droplet",
      "source": "droplet"
    }
  }'

Responses

Credit card response

Bodyapplication/json
paymentobject(Commerce::Payment)
metaobject
Response
application/json
{
  "payment": {
    "id": 0,
    "uuid": "fpi_1cubfbteb6op7bld34xpae",
    "action": "capture",
    "status": "success",
    "payment_account": 272,
    "cart_token": "ct_4CeYE6VQNxASEBYZXpN4hi"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

List payment transactions

Request

Query
pageobject

Pagination parameters

sorted_bystring
Example: sorted_by=amount_asc
order_idinteger

Filter by order ID or order token

cart_idinteger

Filter by cart ID or cart token

transaction_idstring

Filter by transaction ID

payment_actionstring

Filter by payment action

Enum"show""update""create_payment_source""create_payment_token""create_customer_token""create_paypal_order""retain""verify""authorize""capture"
Example: payment_action=show
statusstring

Filter by payment status

Enum"unsent""sent""received""success""declined""pending""error""expired"
Example: status=sent
company_idinteger

Filter by company ID

integrationstring

Filter by integration class

Enum"Affirm""AliPayCitcon""AliPayHkCitcon""BankTransferCitcon""BlikPpro""Bread""CashAppCitcon""CreditCard""Droplet""GCashCitcon"
Example: integration=Paypal
gatewaystring

Filter by gateway name

Enum"ActiveMerchant::Billing::AdyenGateway""ActiveMerchant::Billing::Bogus""ActiveMerchant::Billing::BraintreeGateway""ActiveMerchant::Billing::CheckoutV2Gateway""ActiveMerchant::Billing::CyberSourceRestGateway""ActiveMerchant::Billing::NmiGateway""ActiveMerchant::Billing::PaypalRestGateway""ActiveMerchant::Billing::StripePaymentIntentsGateway""ActiveMerchant::Billing::WorldpayGateway"
Example: gateway=ActiveMerchant::Billing::NmiGateway
currencyinteger

Filter by currency code

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/transactions?cart_id=0&company_id=0&currency=0&cursor=eyJpZCI6MX0%3D&gateway=ActiveMerchant%3A%3ABilling%3A%3AAdyenGateway&integration=Affirm&limit=20&order_id=0&payment_action=show&sorted_by=string&status=unsent&transaction_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

payments retrieved

Bodyapplication/json
transactionsArray of objects(Commerce::Payment)
metaobject
Response
application/json
{
  "transactions": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

List of filter options of transactions

Request

curl -i -X GET \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/transactions/filter_options \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

filter options

Bodyapplication/json
integrationsArray of objects
payment_statusesArray of objects
payment_actionsArray of strings
Example: ["capture"]
gatewaysArray of objects
metaobject
Response
application/json
{
  "integrations": [
    { … }
  ],
  "payment_statuses": [
    { … }
  ],
  "payment_actions": [
    "capture"
  ],
  "gateways": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update the payment transaction

Request

Path
payment_uuidstringrequired

UUID of the existing payment

Example: fpi_19dskrgidi2agx2glqpmks
Bodyapplication/jsonrequired
descriptionstring
Example: "some description"
metadataobject
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/payments/{payment_uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "some description",
    "metadata": {}
  }'

Responses

updates the payment

Bodyapplication/json
paymentobject(Commerce::Payment)
metaobject
Response
application/json
{
  "payment": {
    "id": 0,
    "slug": "fpi_1cubfbteb6op7bld34xpae",
    "action": "capture",
    "status": "success",
    "company_id": 980191418,
    "company_name": "Acme Inc",
    "customer_id": 0,
    "customer_name": "John Doe",
    "cart_id": 270825,
    "subscription_id": 0,
    "card_id": 0,
    "parent_id": 0,
    "amount": "31.46",
    "currency_code": "USD",
    "integration_class": "CreditCard",
    "adapter_class": "ActiveMerchant::Billing::CyberSourceRestGateway",
    "transaction_id": "7555764170626662903812",
    "refunded_amount": "0.0",
    "last_refunded_at": "string",
    "voided_at": "string",
    "created_at": "2025-08-19T04:06:56.399Z",
    "updated_at": "2025-08-19T04:06:58.467Z",
    "response_status": "string",
    "response_message": "PENDING",
    "processing_fee": 0,
    "fee_status": "string",
    "invoice_id": 0,
    "am_authorization": "7555764170626662903812|31.46",
    "cart_token": "ct_4CeYE6VQNxASEBYZXpN4hi",
    "latency": "0.45 seconds",
    "payment_account": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Show the payment transaction

Request

Path
payment_uuidstringrequired

UUID of the existing payment

Example: fpi_19dskrgidi2agx2glqpmks
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/payments/{payment_uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

show payment details

Bodyapplication/json
paymentobject(Commerce::Payment)
metaobject
Response
application/json
{
  "payment": {
    "id": 0,
    "slug": "fpi_1cubfbteb6op7bld34xpae",
    "action": "capture",
    "status": "success",
    "company_id": 980191418,
    "company_name": "Acme Inc",
    "customer_id": 0,
    "customer_name": "John Doe",
    "cart_id": 270825,
    "subscription_id": 0,
    "card_id": 0,
    "parent_id": 0,
    "amount": "31.46",
    "currency_code": "USD",
    "integration_class": "CreditCard",
    "adapter_class": "ActiveMerchant::Billing::CyberSourceRestGateway",
    "transaction_id": "7555764170626662903812",
    "refunded_amount": "0.0",
    "last_refunded_at": "string",
    "voided_at": "string",
    "created_at": "2025-08-19T04:06:56.399Z",
    "updated_at": "2025-08-19T04:06:58.467Z",
    "response_status": "string",
    "response_message": "PENDING",
    "processing_fee": 0,
    "fee_status": "string",
    "invoice_id": 0,
    "am_authorization": "7555764170626662903812|31.46",
    "cart_token": "ct_4CeYE6VQNxASEBYZXpN4hi",
    "latency": "0.45 seconds",
    "payment_account": { … },
    "request": {},
    "response": {},
    "related_transactions": []
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Settle authorized payment transaction

Request

Query
order_tokenstring

token of the existing order

Example: order_token=fo_19dskrgidi2agx2glqpmks
order_idstring

id of the existing order

Example: order_id=123
curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/payments/settle?order_id=string&order_token=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

settles the payment

Bodyapplication/json
paymentobject(Commerce::Payment)
metaobject
Response
application/json
{
  "payment": {
    "id": 0,
    "slug": "fpi_1cubfbteb6op7bld34xpae",
    "action": "capture",
    "status": "success",
    "company_id": 980191418,
    "company_name": "Acme Inc",
    "customer_id": 0,
    "customer_name": "John Doe",
    "cart_id": 270825,
    "subscription_id": 0,
    "card_id": 0,
    "parent_id": 0,
    "amount": "31.46",
    "currency_code": "USD",
    "integration_class": "CreditCard",
    "adapter_class": "ActiveMerchant::Billing::CyberSourceRestGateway",
    "transaction_id": "7555764170626662903812",
    "refunded_amount": "0.0",
    "last_refunded_at": "string",
    "voided_at": "string",
    "created_at": "2025-08-19T04:06:56.399Z",
    "updated_at": "2025-08-19T04:06:58.467Z",
    "response_status": "string",
    "response_message": "PENDING",
    "processing_fee": 0,
    "fee_status": "string",
    "invoice_id": 0,
    "am_authorization": "7555764170626662903812|31.46",
    "cart_token": "ct_4CeYE6VQNxASEBYZXpN4hi",
    "latency": "0.45 seconds",
    "payment_account": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Search

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantCountries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Delete a media

Request

Path
idintegerrequired

Media ID

Example: 1
curl -i -X DELETE \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/media/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media destroyed

Bodyapplication/json
string
Response
application/json
"string"