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 POST \ https://docs.fluid.app/_mock/docs/apis/company.api/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" } }'
{ "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" } }
curl -i -X POST \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/payments/{payment_account_id}' \ -H 'Content-Type: application/json' \ -d '{ "cart_token": "cart_token", "payment_method": { "integration_class": "Droplet", "source": "droplet" } }'
{ "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" } }
Filter by payment action
Filter by payment status
Filter by integration class
Filter by gateway name
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/transactions?cart_id=0&company_id=0¤cy=0&customer_id=string&gateway=ActiveMerchant%3A%3ABilling%3A%3AAdyenGateway&integration=Affirm&order_id=0&order_source=string&page%5Bcursor%5D=eyJpZCI6MX0&page%5Blimit%5D=20&payment_action=show&sorted_by=string&status=unsent&transaction_id=string&type=test' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "transactions": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": { … } } }
curl -i -X GET \ https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/transactions/filter_options \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "integrations": [ { … } ], "payment_statuses": [ { … } ], "payment_actions": [ "capture" ], "gateways": [ { … } ], "order_sources": [ { … } ], "types": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X PATCH \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/payments/{payment_uuid}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "description": "some description", "metadata": {} }'
{ "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", "order_source": "web", "test_transaction": false, "payment_account": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/payments/{payment_uuid}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "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", "order_source": "web", "test_transaction": false, "payment_account": { … }, "request": {}, "response": {}, "related_transactions": [] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/payments/settle \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "order_token": "fo_19dskrgidi2agx2glqpmks", "order_id": "123", "amount": 5.5, "currency_code": "USD" }'
{ "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", "order_source": "web", "test_transaction": false, "payment_account": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X PATCH \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/payments/cancel/{order_token}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "amount": 10.99, "currency_code": "USD" }'
{ "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", "order_source": "web", "test_transaction": false, "payment_account": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
Social Media