Documentation
MCPTool reference

Tool reference

Every tool FloPay MCP serves, generated from the reviewed API contract, with its operation, class, risk, and required scopes, grouped by product area.

Tool reference

Every tool FloPay MCP serves, generated from the FloPay MCP contract version 1, revision 764b41d5c7205d6df7eeaeac832fafe882247f5526b1d4d6bc6f98e3eaca7784. An operation appears here only when the FloPay API marks it as reviewed and eligible. Your client sees the tools your role and scopes allow, and sees mutating tools only when it supports form confirmation.

Authentication

ToolOperationClassRiskScopes
ApiToken_getGET /v1/api-tokens/{id}read-onlylowmcp:read
ApiToken_listGET /v1/api-tokensread-onlylowmcp:read

Disputes

ToolOperationClassRiskScopes
Disputes_actPOST /v1/disputes/{id}/actionsmutatingmediummcp:write
Disputes_getGET /v1/disputes/{id}read-onlylowmcp:read
Disputes_listGET /v1/disputesread-onlylowmcp:read
Disputes_listCandidatesGET /v1/disputes/{id}/candidatesread-onlylowmcp:read

Pre-Dispute Alerts

ToolOperationClassRiskScopes
Chargeback_exportAlertsPOST /v1/chargebacks/alerts/exportsread-onlymediummcp:read
Chargeback_findOneGET /v1/chargebacks/alerts/{id}read-onlylowmcp:read
Chargeback_listGET /v1/chargebacks/alertsread-onlylowmcp:read
PreDisputeAlerts_exportPOST /v1/pre-dispute-alerts/exportsread-onlymediummcp:read
PreDisputeAlerts_getGET /v1/pre-dispute-alerts/{id}read-onlylowmcp:read
PreDisputeAlerts_listGET /v1/pre-dispute-alertsread-onlylowmcp:read

Checkouts

ToolOperationClassRiskScopes
CheckoutAnalytics_getGET /v1/checkouts/statsread-onlymediummcp:read
CheckoutLink_createPOST /v1/checkout-linksmutatingmediummcp:write
CheckoutLink_findOneGET /v1/checkout-links/{uuid}read-onlylowmcp:read
CheckoutLink_listGET /v1/checkout-linksread-onlylowmcp:read
getCheckoutDeclineAnalysisGET /v1/checkouts/decline-analysisread-onlymediummcp:read
Session_createSetupPOST /v1/checkouts/sessions/setupmutatingmediummcp:write
Session_exportSessionsPOST /v1/checkouts/sessions/exportsread-onlymediummcp:read
Session_listGET /v1/checkouts/sessionsread-onlylowmcp:read
TransactionAttempts_findOneGET /v1/checkouts/transaction-attempts/{id}read-onlylowmcp:read
TransactionAttempts_listGET /v1/checkouts/transaction-attemptsread-onlylowmcp:read

Products

ToolOperationClassRiskScopes
Collection_createPOST /v1/collectionsmutatingmediummcp:write
Collection_findOneGET /v1/collections/{uuid}read-onlylowmcp:read
Collection_listGET /v1/collectionsread-onlylowmcp:read
Collection_updatePATCH /v1/collections/{uuid}mutatingmediummcp:write
Coupon_createPOST /v1/couponsmutatingmediummcp:write
Coupon_findOneGET /v1/coupons/{uuid}read-onlylowmcp:read
Coupon_listGET /v1/couponsread-onlylowmcp:read
Coupon_reactivatePOST /v1/coupons/{uuid}/reactivatemutatingmediummcp:write
Coupon_updatePATCH /v1/coupons/{uuid}mutatingmediummcp:write
Product_createPOST /v1/productsmutatingmediummcp:write
Product_findOneGET /v1/products/{uuid}read-onlylowmcp:read
Product_listGET /v1/productsread-onlylowmcp:read
Product_reactivatePOST /v1/products/{uuid}/reactivatemutatingmediummcp:write
Product_updatePATCH /v1/products/{uuid}mutatingmediummcp:write
ProductBrand_createPOST /v1/products/brandsmutatinglowmcp:write
ProductBrand_findOneGET /v1/products/brands/{uuid}read-onlylowmcp:read
ProductBrand_listGET /v1/products/brandsread-onlylowmcp:read
ProductBrand_updatePATCH /v1/products/brands/{uuid}mutatinglowmcp:write
ProductCategory_createPOST /v1/products/categoriesmutatinglowmcp:write
ProductCategory_findOneGET /v1/products/categories/{uuid}read-onlylowmcp:read
ProductCategory_listGET /v1/products/categoriesread-onlylowmcp:read
ProductCategory_updatePATCH /v1/products/categories/{uuid}mutatinglowmcp:write
ProductMedia_createPOST /v1/products/{productUuid}/mediamutatinglowmcp:write
ProductMedia_findOneGET /v1/products/{productUuid}/media/{uuid}read-onlylowmcp:read
ProductMedia_updatePATCH /v1/products/{productUuid}/media/{uuid}mutatinglowmcp:write
ProductPrice_createPOST /v1/products/{productUuid}/pricesmutatingmediummcp:write
ProductPrice_findOneGET /v1/products/{productUuid}/prices/{uuid}read-onlylowmcp:read
ProductPrice_reactivatePOST /v1/products/{productUuid}/prices/{uuid}/reactivatemutatingmediummcp:write
ProductPrice_updatePATCH /v1/products/{productUuid}/prices/{uuid}mutatingmediummcp:write
ProductVariant_createPOST /v1/products/{productUuid}/variantsmutatingmediummcp:write
ProductVariant_findOneGET /v1/products/{productUuid}/variants/{uuid}read-onlylowmcp:read
ProductVariant_reactivatePOST /v1/products/{productUuid}/variants/{uuid}/reactivatemutatingmediummcp:write
ProductVariant_updatePATCH /v1/products/{productUuid}/variants/{uuid}mutatingmediummcp:write

Settings

ToolOperationClassRiskScopes
Branding_getGET /v1/brandingread-onlylowmcp:read
Branding_upsertPUT /v1/brandingmutatinglowmcp:write
ChargebackSettings_getSettingGET /v1/settings/chargebacks/{id}read-onlylowmcp:read
ClientUser_getOneGET /v1/client-users/{id}read-onlylowmcp:read
ClientUser_listGET /v1/client-usersread-onlylowmcp:read
GatewaySettings_getGET /v1/settings/gateways/{id}read-onlylowmcp:read
GatewaySettings_listGET /v1/settings/gatewaysread-onlylowmcp:read
GatewaySettings_listPageGET /v2/settings/gatewaysread-onlylowmcp:read
GatewaySettings_testPOST /v1/settings/gateways/{id}/testread-onlymediummcp:read
PreDisputeAlertSettings_getGET /v1/settings/pre-dispute-alerts/{id}read-onlylowmcp:read
PreDisputeAlertSettings_listGET /v1/settings/pre-dispute-alertsread-onlylowmcp:read
PreDisputeAlertSettings_listDescriptorsGET /v1/settings/pre-dispute-alerts/{id}/descriptorsread-onlylowmcp:read

Subscriptions

ToolOperationClassRiskScopes
SubscriptionChange_changePreviewPOST /v1/subscriptions/{id}/change/previewread-onlymediummcp:read
SubscriptionPlan_getAllGET /v1/subscriptions/plansread-onlylowmcp:read
SubscriptionPreview_getAllActiveV2GET /v2/subscriptions/activeread-onlylowmcp:read
SubscriptionRead_exportSubscriptionsPOST /v1/subscriptions/exportsread-onlymediummcp:read
SubscriptionRead_findOneGET /v1/subscriptions/{id}read-onlylowmcp:read
SubscriptionRead_listGET /v1/subscriptionsread-onlylowmcp:read
SubscriptionRecovery_listGET /v1/subscriptions/{id}/recoveryread-onlylowmcp:read
SubscriptionStats_getGET /v1/subscriptions/statsread-onlymediummcp:read

Transactions

ToolOperationClassRiskScopes
Invoice_exportInvoicesPOST /v1/invoices/exportsread-onlymediummcp:read
Invoice_findOneGET /v1/invoices/{id}read-onlylowmcp:read
Invoice_listGET /v1/invoicesread-onlylowmcp:read
Invoice_statsGET /v1/invoices/statsread-onlymediummcp:read
Payments_exportPaymentsPOST /v1/payments/exportsread-onlymediummcp:read
Payments_findOneGET /v1/payments/{id}read-onlylowmcp:read
Payments_listGET /v1/paymentsread-onlylowmcp:read

Users

ToolOperationClassRiskScopes
InvoicePreview_listGET /v1/users/{id}/invoicesread-onlylowmcp:read
PaymentMethods_listGET /v1/payment-methodsread-onlylowmcp:read
Timelines_listGET /v1/timelinesread-onlylowmcp:read
Timelines_recordGET /v1/timelines/recordread-onlylowmcp:read
User_exportUsersPOST /v1/users/exportsread-onlymediummcp:read
User_getUserByIdGET /v1/users/{id}read-onlylowmcp:read
User_getUserPurchasesGET /v1/users/{id}/purchasesread-onlylowmcp:read
User_getUserSubscriptionsGET /v1/users/{id}/subscriptionsread-onlylowmcp:read
User_listUsersGET /v1/usersread-onlylowmcp:read
User_lookupGET /v1/users/lookupread-onlylowmcp:read
User_updateUserPATCH /v1/users/{id}mutatingmediummcp:write
UserPurchaseRecords_listGET /v1/users/{id}/purchase-recordsread-onlylowmcp:read

Webhooks

ToolOperationClassRiskScopes
ClientWebhook_listGET /v1/webhooksread-onlylowmcp:read
ClientWebhookEvent_exportEventsPOST /v1/webhooks/events/exportsread-onlymediummcp:read
ClientWebhookEvent_findOneGET /v1/webhooks/events/{id}read-onlylowmcp:read
ClientWebhookEvent_listGET /v1/webhooks/eventsread-onlylowmcp:read

Other

ToolOperationClassRiskScopes
ClientInvoices_findOneGET /v1/client-invoices/{uuid}read-onlylowmcp:read
ClientInvoices_listGET /v1/client-invoicesread-onlylowmcp:read
Company_getGET /v1/companyread-onlylowmcp:read
Company_updatePATCH /v1/companymutatingmediummcp:write
DunningPolicy_getGET /v1/settings/dunning-policyread-onlylowmcp:read
ProductPrices_listGET /v1/product-pricesread-onlylowmcp:read
SalesWatcherReviewHistory_findOneGET /v1/sales-watcher/reviews/{id}read-onlylowmcp:read
SalesWatcherReviewHistory_listGET /v1/sales-watcher/reviewsread-onlylowmcp:read

Knowledge resources

Search FloPay documentation, REST reference, SDK guidance, and changelog content through FloPay MCP without exact URIs, with a canonical source for each.

Authentication tools

Arguments, results, errors, and access, confirmation, and retry policy for each Authentication tool in FloPay MCP, from the reviewed API contract.

On this page

Tool referenceAuthenticationDisputesPre-Dispute AlertsCheckoutsProductsSettingsSubscriptionsTransactionsUsersWebhooksOther