Payment Accounts

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

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Popups

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

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

List of payment accounts

Request

List all payment accounts

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

Responses

success

Bodyapplication/json
payment_accountsArray of objects
metaobject
Response
application/json
{
  "payment_accounts": [
    { … }
  ],
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Create a payment account

Request

Create a payment account

Bodyapplication/json
payment_accountobjectrequired
payment_account.​namestringrequired
payment_account.​integration_classstringrequired
payment_account.​adapter_classstring
payment_account.​activeboolean
payment_account.​testboolean
payment_account.​gateway_typestring
payment_account.​sandboxboolean
payment_account.​apple_pay_enabledboolean
payment_account.​google_pay_enabledboolean
payment_account.​sub_adapterstring
payment_account.​credentialsobjectrequired
payment_account.​company_country_idsArray of integers
payment_account.​droplet_installation_idinteger
payment_account.​auto_assign_to_cartboolean
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/payment_accounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_account": {
      "name": "string",
      "integration_class": "string",
      "adapter_class": "string",
      "active": true,
      "test": true,
      "gateway_type": "string",
      "sandbox": true,
      "apple_pay_enabled": true,
      "google_pay_enabled": true,
      "sub_adapter": "string",
      "credentials": {},
      "company_country_ids": [
        0
      ],
      "droplet_installation_id": 0,
      "auto_assign_to_cart": true
    }
  }'

Responses

created

Bodyapplication/json
payment_accountobject
metaobject
Response
application/json
{
  "payment_account": {
    "id": 1,
    "active": true,
    "integration_class": "Paypal",
    "adapter_class": "ActiveMerchant::Billing::SpreedlyCoreGateway",
    "adapter_class_label": "SpreedlyCoreGateway",
    "name": "Test Payment",
    "settings": {},
    "test": false,
    "domain": { … },
    "droplet_installation": {},
    "auto_assign_to_cart": false,
    "countries": [ … ],
    "sandbox": false,
    "apple_pay_enabled": false,
    "google_pay_enabled": false,
    "sub_adapter": "acapture",
    "credentials": {}
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Get a payment account

Request

Get a payment account

Path
idstringrequired

Id of payment account.

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

Responses

success

Bodyapplication/json
payment_accountobject
metaobject
Response
application/json
{
  "payment_account": {
    "id": 1,
    "active": true,
    "integration_class": "Paypal",
    "adapter_class": "ActiveMerchant::Billing::SpreedlyCoreGateway",
    "adapter_class_label": "SpreedlyCoreGateway",
    "name": "Test Payment",
    "settings": {},
    "test": false,
    "domain": { … },
    "droplet_installation": {},
    "auto_assign_to_cart": false,
    "countries": [ … ],
    "sandbox": false,
    "apple_pay_enabled": false,
    "google_pay_enabled": false,
    "sub_adapter": "acapture",
    "credentials": {}
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update a payment account

Request

Update a payment account

Path
idintegerrequired
Bodyapplication/json
idintegerrequired
payment_accountobjectrequired
payment_account.​namestringnon-empty
payment_account.​integration_classstringnon-empty
payment_account.​adapter_classstringnon-empty
payment_account.​activeboolean
payment_account.​testboolean
payment_account.​gateway_typestring
payment_account.​sandboxboolean
payment_account.​apple_pay_enabledboolean
payment_account.​google_pay_enabledboolean
payment_account.​sub_adapterstring
payment_account.​credentialsobject
payment_account.​company_country_idsArray of integers
payment_account.​droplet_installation_idinteger
payment_account.​auto_assign_to_cartboolean
curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/payment_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "payment_account": {
      "name": "string",
      "integration_class": "string",
      "adapter_class": "string",
      "active": true,
      "test": true,
      "gateway_type": "string",
      "sandbox": true,
      "apple_pay_enabled": true,
      "google_pay_enabled": true,
      "sub_adapter": "string",
      "credentials": {},
      "company_country_ids": [
        0
      ],
      "droplet_installation_id": 0,
      "auto_assign_to_cart": true
    }
  }'

Responses

updated

Bodyapplication/json
payment_accountobject
metaobject
Response
application/json
{
  "payment_account": {
    "id": 1,
    "active": true,
    "integration_class": "Paypal",
    "adapter_class": "ActiveMerchant::Billing::SpreedlyCoreGateway",
    "adapter_class_label": "SpreedlyCoreGateway",
    "name": "Test Payment",
    "settings": {},
    "test": false,
    "domain": { … },
    "droplet_installation": {},
    "auto_assign_to_cart": false,
    "countries": [ … ],
    "sandbox": false,
    "apple_pay_enabled": false,
    "google_pay_enabled": false,
    "sub_adapter": "acapture",
    "credentials": {}
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Delete a payment account

Request

Delete a single payment account

Path
idstringrequired

Id of payment account to be deleted.

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

Responses

success

Bodyapplication/json
payment_accountobject
metaobject
Response
application/json
{
  "payment_account": {
    "id": 1
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Get credentials schema for a payment integration

Request

Returns the credentials schema for a specific payment integration

Query
integration_classstringrequired

Name of Integration

Example: integration_class=CreditCard
adapter_classstring

Optional adapter class for integrations that support it

Example: adapter_class=ActiveMerchant::Billing::SpreedlyCoreGateway
sub_adapterstring

Optional sub-adapter for integrations that support it

Example: sub_adapter=adyen
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/payment_accounts/credentials_schema?adapter_class=string&integration_class=string&sub_adapter=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
credentials_schemaobject

Schema for credentials required by the integration

Example: {"merchant_account":{"label":"Merchant Account","type":"string","required":true,"safe":true},"username":{"label":"Username","type":"string","required":true,"safe":true},"password":{"label":"Password","type":"string","required":true,"safe":false}}
metaobject
Response
application/json
{
  "credentials_schema": {
    "merchant_account": { … },
    "username": { … },
    "password": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations