The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.
For APIs that authenticate with User tokens, see the Rep APIs documentation.
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/payment_accounts?country_ids%5B%5D=string&page=0&per_page=0&sandbox=true&search_query=string&sorted_by=string&status=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "payment_accounts": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": { … } } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/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, "mid": null, "entity_id": null, "recurring_only": null } }'
{ "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": { … }, "countries": [ … ], "icon": "https://example.com/icon.png", "droplet_installation": {}, "auto_assign_to_cart": false, "mid": "123456789012345", "entity": {}, "paypal_seller_verified": false, "recurring_only": false, "sandbox": false, "apple_pay_enabled": false, "google_pay_enabled": false, "sub_adapter": "acapture", "credentials": {}, "paypal_seller_email": "test@example.com", "paypal_consent_revoked": false }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/payment_accounts/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "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": { … }, "countries": [ … ], "icon": "https://example.com/icon.png", "droplet_installation": {}, "auto_assign_to_cart": false, "mid": "123456789012345", "entity": {}, "paypal_seller_verified": false, "recurring_only": false, "sandbox": false, "apple_pay_enabled": false, "google_pay_enabled": false, "sub_adapter": "acapture", "credentials": {}, "paypal_seller_email": "test@example.com", "paypal_consent_revoked": false }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X PUT \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/payment_accounts/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "id": null, "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, "mid": null, "entity_id": null, "recurring_only": null } }'
{ "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": { … }, "countries": [ … ], "icon": "https://example.com/icon.png", "droplet_installation": {}, "auto_assign_to_cart": false, "mid": "123456789012345", "entity": {}, "paypal_seller_verified": false, "recurring_only": false, "sandbox": false, "apple_pay_enabled": false, "google_pay_enabled": false, "sub_adapter": "acapture", "credentials": {}, "paypal_seller_email": "test@example.com", "paypal_consent_revoked": false }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/payment_accounts/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "payment_account": { "id": 1 }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/payment_accounts/credentials_schema?adapter_class=string&integration_class=string&sub_adapter=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
successful
Schema for credentials required by the integration
{ "credentials_schema": { "merchant_account": { … }, "username": { … }, "password": { … } }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
Social Media