ApplePay

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://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Agreements

Operations

ApplePay

Operations

Creates an Apple Pay session

Request

Initialize an Apple Pay session for client-side Apple Pay integration

Bodyapplication/json

Session parameters

company_idintegerrequired

Company ID

Example: 123
country_idintegerrequired

Country ID

Example: 1
apple_session_urlstringrequired

Apple Pay session URL

Example: "https://apple-pay-gateway.apple.com/paymentservices/startSession"
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/payments/apple_pay_session \
  -H 'Content-Type: application/json' \
  -d '{
    "company_id": 123,
    "country_id": 1,
    "apple_session_url": "https://apple-pay-gateway.apple.com/paymentservices/startSession"
  }'

Responses

Apple Pay session created

Bodyapplication/json
apple_payobject

Apple Pay session data

Example: {"epochTimestamp":1742464455114,"expiresAt":1742468055114,"merchantSessionIdentifier":"SSHB9FDFEBF1A5C40C598D66F4E81C36136_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24","nonce":"649819fa","merchantIdentifier":"997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924","domainName":"www.example.com","displayName":"Example Merchant","signature":"308006092a864886f70d010702a0803080020101310d300b0609608648016503040201308006092a864886f70d0107010000a080308203e43082038ba003020102020859d8a1bcaaf4e3cd300a06082a8648ce3d040302307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553301e170d3231303432303139333730305a170d3236303431393139333635395a30623128302606035504030c1f6563632d736d702d62726f6b65722d7369676e5f5543342d53414e44424f5831143012060355040b0c0b694f532053797374656d7331133011060355040a0c0a4170706c6520496e632e310b30090603550406130255533059301306072a8648ce3d020106082a8648ce3d030107034200048230fdabc39cf75e202c50d99b4512e637e2a901dd6cb3e0b1cd4b526798f8cf4ebde81a25a8c21e4c33ddce8e2a96c2f6afa1930345c4e87a4426ce951b1295a38202113082020d300c0603551d130101ff04023000301f0603551d2304183016801423f249c44f93e4ef27e6c4f6286c3fa2bbfd2e4b304506082b0601050507010104393037303506082b060105050730018629687474703a2f2f6f6373702e6170706c652e636f6d2f6f63737030342d6170706c65616963613330323082011d0603551d2004820114308201103082010c06092a864886f7636405013081fe3081c306082b060105050702023081b60c81b352656c69616e6365206f6e207468697320636572746966696361746520627920616e7920706172747920617373756d657320616363657074616e6365206f6620746865207468656e206170706c696361626c65207374616e64617264207465726d7320616e6420636f6e646974696f6e73206f66207573652c20636572746966696361746520706f6c69637920616e642063657274696669636174696f6e2070726163746963652073746174656d656e74732e303606082b06010505070201162a687474703a2f2f7777772e6170706c652e636f6d2f6365727469666963617465617574686f726974792f30340603551d1f042d302b3029a027a0258623687474703a2f2f63726c2e6170706c652e636f6d2f6170706c6561696361332e63726c301d0603551d0e041604140224300b9aeeed463197a4a65a299e4271821c45300e0603551d0f0101ff040403020780300f06092a864886f76364061d04020500300a06082a8648ce3d0403020347003044022074a1b324db4249430dd3274c5074c4808d9a1f480e3a85c5c1362566325fbca3022069369053abf50b5a52f9f6004dc58aad6c50a7d608683790e0a73ad01e4ad981308202ee30820275a0030201020208496d2fbf3a98da97300a06082a8648ce3d0403023067311b301906035504030c124170706c6520526f6f74204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553301e170d3134303530363233343633305a170d3239303530363233343633305a307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b30090603550406130255533059301306072a8648ce3d020106082a8648ce3d03010703420004f017118419d76485d51a5e25810776e880a2efde7bae4de08dfc4b93e13356d5665b35ae22d097760d224e7bba08fd7617ce88cb76bb6670bec8e82984ff5445a381f73081f4304606082b06010505070101043a3038303606082b06010505073001862a687474703a2f2f6f6373702e6170706c652e636f6d2f6f63737030342d6170706c65726f6f7463616733301d0603551d0e0416041423f249c44f93e4ef27e6c4f6286c3fa2bbfd2e4b300f0603551d130101ff040530030101ff301f0603551d23041830168014bbb0dea15833889aa48a99debebdebafdacb24ab30370603551d1f0430302e302ca02aa0288626687474703a2f2f63726c2e6170706c652e636f6d2f6170706c65726f6f74636167332e63726c300e0603551d0f0101ff0404030201063010060a2a864886f7636406020e04020500300a06082a8648ce3d040302036700306402303acf7283511699b186fb35c356ca62bff417edd90f754da28ebef19c815e42b789f898f79b599f98d5410d8f9de9c2fe0230322dd54421b0a305776c5df3383b9067fd177c2c216d964fc6726982126f54f87a7d1b99cb9b0989216106990f09921d00003182018730820183020101308186307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553020859d8a1bcaaf4e3cd300b0609608648016503040201a08193301806092a864886f70d010903310b06092a864886f70d010701301c06092a864886f70d010905310f170d3235303332303039353431355a302806092a864886f70d010934311b3019300b0609608648016503040201a10a06082a8648ce3d040302302f06092a864886f70d0109043122042058f90b3d8336b18d344ef98894765a47d2680e8e442c67b816100121b36598a7300a06082a8648ce3d04030204463044022018afc2313938becc90964454c5787ee61769c905721e9f68942f5f7a9b633e9702201dd385fd2c9c8a5ae3a44fdd82948a6a5ad63094af2755c9516824afaba3cf48000000000000","operationalAnalyticsIdentifier":"Example Merchant:997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924","retries":0,"pspId":"997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924"}
metaobject
Response
application/json
{
  "apple_pay": {
    "epochTimestamp": 1742464455114,
    "expiresAt": 1742468055114,
    "merchantSessionIdentifier": "SSHB9FDFEBF1A5C40C598D66F4E81C36136_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24",
    "nonce": "649819fa",
    "merchantIdentifier": "997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924",
    "domainName": "www.example.com",
    "displayName": "Example Merchant",
    "signature": "308006092a864886f70d010702a0803080020101310d300b0609608648016503040201308006092a864886f70d0107010000a080308203e43082038ba003020102020859d8a1bcaaf4e3cd300a06082a8648ce3d040302307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553301e170d3231303432303139333730305a170d3236303431393139333635395a30623128302606035504030c1f6563632d736d702d62726f6b65722d7369676e5f5543342d53414e44424f5831143012060355040b0c0b694f532053797374656d7331133011060355040a0c0a4170706c6520496e632e310b30090603550406130255533059301306072a8648ce3d020106082a8648ce3d030107034200048230fdabc39cf75e202c50d99b4512e637e2a901dd6cb3e0b1cd4b526798f8cf4ebde81a25a8c21e4c33ddce8e2a96c2f6afa1930345c4e87a4426ce951b1295a38202113082020d300c0603551d130101ff04023000301f0603551d2304183016801423f249c44f93e4ef27e6c4f6286c3fa2bbfd2e4b304506082b0601050507010104393037303506082b060105050730018629687474703a2f2f6f6373702e6170706c652e636f6d2f6f63737030342d6170706c65616963613330323082011d0603551d2004820114308201103082010c06092a864886f7636405013081fe3081c306082b060105050702023081b60c81b352656c69616e6365206f6e207468697320636572746966696361746520627920616e7920706172747920617373756d657320616363657074616e6365206f6620746865207468656e206170706c696361626c65207374616e64617264207465726d7320616e6420636f6e646974696f6e73206f66207573652c20636572746966696361746520706f6c69637920616e642063657274696669636174696f6e2070726163746963652073746174656d656e74732e303606082b06010505070201162a687474703a2f2f7777772e6170706c652e636f6d2f6365727469666963617465617574686f726974792f30340603551d1f042d302b3029a027a0258623687474703a2f2f63726c2e6170706c652e636f6d2f6170706c6561696361332e63726c301d0603551d0e041604140224300b9aeeed463197a4a65a299e4271821c45300e0603551d0f0101ff040403020780300f06092a864886f76364061d04020500300a06082a8648ce3d0403020347003044022074a1b324db4249430dd3274c5074c4808d9a1f480e3a85c5c1362566325fbca3022069369053abf50b5a52f9f6004dc58aad6c50a7d608683790e0a73ad01e4ad981308202ee30820275a0030201020208496d2fbf3a98da97300a06082a8648ce3d0403023067311b301906035504030c124170706c6520526f6f74204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553301e170d3134303530363233343633305a170d3239303530363233343633305a307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b30090603550406130255533059301306072a8648ce3d020106082a8648ce3d03010703420004f017118419d76485d51a5e25810776e880a2efde7bae4de08dfc4b93e13356d5665b35ae22d097760d224e7bba08fd7617ce88cb76bb6670bec8e82984ff5445a381f73081f4304606082b06010505070101043a3038303606082b06010505073001862a687474703a2f2f6f6373702e6170706c652e636f6d2f6f63737030342d6170706c65726f6f7463616733301d0603551d0e0416041423f249c44f93e4ef27e6c4f6286c3fa2bbfd2e4b300f0603551d130101ff040530030101ff301f0603551d23041830168014bbb0dea15833889aa48a99debebdebafdacb24ab30370603551d1f0430302e302ca02aa0288626687474703a2f2f63726c2e6170706c652e636f6d2f6170706c65726f6f74636167332e63726c300e0603551d0f0101ff0404030201063010060a2a864886f7636406020e04020500300a06082a8648ce3d040302036700306402303acf7283511699b186fb35c356ca62bff417edd90f754da28ebef19c815e42b789f898f79b599f98d5410d8f9de9c2fe0230322dd54421b0a305776c5df3383b9067fd177c2c216d964fc6726982126f54f87a7d1b99cb9b0989216106990f09921d00003182018730820183020101308186307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553020859d8a1bcaaf4e3cd300b0609608648016503040201a08193301806092a864886f70d010903310b06092a864886f70d010701301c06092a864886f70d010905310f170d3235303332303039353431355a302806092a864886f70d010934311b3019300b0609608648016503040201a10a06082a8648ce3d040302302f06092a864886f70d0109043122042058f90b3d8336b18d344ef98894765a47d2680e8e442c67b816100121b36598a7300a06082a8648ce3d04030204463044022018afc2313938becc90964454c5787ee61769c905721e9f68942f5f7a9b633e9702201dd385fd2c9c8a5ae3a44fdd82948a6a5ad63094af2755c9516824afaba3cf48000000000000",
    "operationalAnalyticsIdentifier": "Example Merchant:997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924",
    "retries": 0,
    "pspId": "997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Processes an Apple Pay payment

Request

Process an Apple Pay payment for a cart

Bodyapplication/json

Payment parameters

cart_tokenstringrequired

Cart token

Example: "ct_7UUUXZP7QLl1NRZZuHQN3"
apple_pay_payloadobjectrequired

Apple Pay payment payload, which can be derived from Apple Pay payment response; https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment

apple_pay_payload.​tokenobjectrequired
apple_pay_payload.​token.​paymentDataobjectrequired
apple_pay_payload.​token.​paymentData.​datastringrequired
Example: "G4kP5IrX+PZLAZUOPWbve3XXrsqdfMWkRSnRAfxVpXIpOZCQEJ"
apple_pay_payload.​token.​paymentData.​signaturestringrequired
Example: "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJK"
apple_pay_payload.​token.​paymentData.​versionstringrequired
Example: "EC_v1"
apple_pay_payload.​token.​paymentData.​headerobjectrequired
apple_pay_payload.​token.​paymentData.​header.​publicKeyHashstringrequired
Example: "ufHTw1HBjGwgkC023My0DcsTyZxXJT0sA2VnmSwe4ss="
apple_pay_payload.​token.​paymentData.​header.​ephemeralPublicKeystringrequired
Example: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEGQpUf5fW7pvUKQmw+"
apple_pay_payload.​token.​paymentData.​header.​transactionIdstringrequired
Example: "3d688a5c36e35abccdf21ed124fad00426abc4e49b1f0cf95701400717408122"
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/payments/apple_pay_authorize \
  -H 'Content-Type: application/json' \
  -d '{
    "cart_token": "ct_7UUUXZP7QLl1NRZZuHQN3",
    "apple_pay_payload": {
      "token": {
        "paymentData": {
          "data": "G4kP5IrX+PZLAZUOPWbve3XXrsqdfMWkRSnRAfxVpXIpOZCQEJ",
          "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJK",
          "version": "EC_v1",
          "header": {
            "publicKeyHash": "ufHTw1HBjGwgkC023My0DcsTyZxXJT0sA2VnmSwe4ss=",
            "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEGQpUf5fW7pvUKQmw+",
            "transactionId": "3d688a5c36e35abccdf21ed124fad00426abc4e49b1f0cf95701400717408122"
          }
        }
      }
    }
  }'

Responses

Payment processed successfully

Bodyapplication/json
statusstring
Example: "Approved"
metaobject
Response
application/json
{
  "status": "Approved",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieves an Apple Pay domain verification file

Request

Fetches the Apple Pay domain verification file for the given hostname

Path
hostnamestringrequired

The hostname for which to retrieve the verification file

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/public/v2025-06/apple_pay_domain/{hostname}'

Responses

Apple Pay domain verification file found

Bodyapplication/json
domain_verification_filestring

Apple Pay Domain Verification File content

metaobject
Response
application/json
{
  "domain_verification_file": "string",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company 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

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

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