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 cc71a476426ea531d369de5441cde85ab81ab52c9764406e5f09501857d7ed32. 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
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
ApiToken_create | POST /v1/api-tokens | mutating | critical | mcp:write |
ApiToken_get | GET /v1/api-tokens/{id} | read-only | low | mcp:read |
ApiToken_list | GET /v1/api-tokens | read-only | low | mcp:read |
ApiToken_revoke | DELETE /v1/api-tokens/{id} | mutating | high | mcp:write |
Disputes
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
Disputes_act | POST /v1/disputes/{id}/actions | mutating | medium | mcp:write |
Disputes_get | GET /v1/disputes/{id} | read-only | low | mcp:read |
Disputes_list | GET /v1/disputes | read-only | low | mcp:read |
Disputes_listCandidates | GET /v1/disputes/{id}/candidates | read-only | low | mcp:read |
Pre-Dispute Alerts
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
Chargeback_exportAlerts | POST /v1/chargebacks/alerts/exports | read-only | medium | mcp:read |
Chargeback_findOne | GET /v1/chargebacks/alerts/{id} | read-only | low | mcp:read |
Chargeback_list | GET /v1/chargebacks/alerts | read-only | low | mcp:read |
PreDisputeAlerts_export | POST /v1/pre-dispute-alerts/exports | read-only | medium | mcp:read |
PreDisputeAlerts_get | GET /v1/pre-dispute-alerts/{id} | read-only | low | mcp:read |
PreDisputeAlerts_list | GET /v1/pre-dispute-alerts | read-only | low | mcp:read |
Checkouts
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
CheckoutAnalytics_get | GET /v1/checkouts/stats | read-only | medium | mcp:read |
CheckoutLink_create | POST /v1/checkout-links | mutating | medium | mcp:write |
CheckoutLink_deactivate | DELETE /v1/checkout-links/{uuid} | mutating | high | mcp:write |
CheckoutLink_findOne | GET /v1/checkout-links/{uuid} | read-only | low | mcp:read |
CheckoutLink_list | GET /v1/checkout-links | read-only | low | mcp:read |
CheckoutLink_update | PATCH /v1/checkout-links/{uuid} | mutating | high | mcp:write |
getCheckoutDeclineAnalysis | GET /v1/checkouts/decline-analysis | read-only | medium | mcp:read |
Session_create | POST /v1/checkouts/sessions | mutating | critical | mcp:write |
Session_createSetup | POST /v1/checkouts/sessions/setup | mutating | medium | mcp:write |
Session_exportSessions | POST /v1/checkouts/sessions/exports | read-only | medium | mcp:read |
Session_list | GET /v1/checkouts/sessions | read-only | low | mcp:read |
TransactionAttempts_findOne | GET /v1/checkouts/transaction-attempts/{id} | read-only | low | mcp:read |
TransactionAttempts_list | GET /v1/checkouts/transaction-attempts | read-only | low | mcp:read |
Products
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
Collection_create | POST /v1/collections | mutating | medium | mcp:write |
Collection_delete | DELETE /v1/collections/{uuid} | mutating | high | mcp:write |
Collection_findOne | GET /v1/collections/{uuid} | read-only | low | mcp:read |
Collection_list | GET /v1/collections | read-only | low | mcp:read |
Collection_update | PATCH /v1/collections/{uuid} | mutating | medium | mcp:write |
Coupon_create | POST /v1/coupons | mutating | medium | mcp:write |
Coupon_delete | DELETE /v1/coupons/{uuid} | mutating | high | mcp:write |
Coupon_findOne | GET /v1/coupons/{uuid} | read-only | low | mcp:read |
Coupon_list | GET /v1/coupons | read-only | low | mcp:read |
Coupon_reactivate | POST /v1/coupons/{uuid}/reactivate | mutating | medium | mcp:write |
Coupon_update | PATCH /v1/coupons/{uuid} | mutating | medium | mcp:write |
Product_create | POST /v1/products | mutating | medium | mcp:write |
Product_delete | DELETE /v1/products/{uuid} | mutating | high | mcp:write |
Product_findOne | GET /v1/products/{uuid} | read-only | low | mcp:read |
Product_list | GET /v1/products | read-only | low | mcp:read |
Product_reactivate | POST /v1/products/{uuid}/reactivate | mutating | medium | mcp:write |
Product_update | PATCH /v1/products/{uuid} | mutating | medium | mcp:write |
ProductBrand_create | POST /v1/products/brands | mutating | low | mcp:write |
ProductBrand_delete | DELETE /v1/products/brands/{uuid} | mutating | high | mcp:write |
ProductBrand_findOne | GET /v1/products/brands/{uuid} | read-only | low | mcp:read |
ProductBrand_hardDelete | POST /v1/products/brands/{uuid}/lifecycle/delete | mutating | high | mcp:write |
ProductBrand_list | GET /v1/products/brands | read-only | low | mcp:read |
ProductBrand_update | PATCH /v1/products/brands/{uuid} | mutating | low | mcp:write |
ProductCategory_create | POST /v1/products/categories | mutating | low | mcp:write |
ProductCategory_delete | DELETE /v1/products/categories/{uuid} | mutating | high | mcp:write |
ProductCategory_findOne | GET /v1/products/categories/{uuid} | read-only | low | mcp:read |
ProductCategory_hardDelete | POST /v1/products/categories/{uuid}/lifecycle/delete | mutating | high | mcp:write |
ProductCategory_list | GET /v1/products/categories | read-only | low | mcp:read |
ProductCategory_update | PATCH /v1/products/categories/{uuid} | mutating | low | mcp:write |
ProductMedia_create | POST /v1/products/{productUuid}/media | mutating | low | mcp:write |
ProductMedia_delete | DELETE /v1/products/{productUuid}/media/{uuid} | mutating | high | mcp:write |
ProductMedia_findOne | GET /v1/products/{productUuid}/media/{uuid} | read-only | low | mcp:read |
ProductMedia_hardDelete | POST /v1/products/{productUuid}/media/{uuid}/lifecycle/delete | mutating | high | mcp:write |
ProductMedia_update | PATCH /v1/products/{productUuid}/media/{uuid} | mutating | low | mcp:write |
ProductPrice_conditionalDelete | POST /v1/products/{productUuid}/prices/{uuid}/lifecycle/delete | mutating | high | mcp:write |
ProductPrice_create | POST /v1/products/{productUuid}/prices | mutating | medium | mcp:write |
ProductPrice_delete | DELETE /v1/products/{productUuid}/prices/{uuid} | mutating | high | mcp:write |
ProductPrice_findOne | GET /v1/products/{productUuid}/prices/{uuid} | read-only | low | mcp:read |
ProductPrice_reactivate | POST /v1/products/{productUuid}/prices/{uuid}/reactivate | mutating | medium | mcp:write |
ProductPrice_update | PATCH /v1/products/{productUuid}/prices/{uuid} | mutating | medium | mcp:write |
ProductVariant_conditionalDelete | POST /v1/products/{productUuid}/variants/{uuid}/lifecycle/delete | mutating | high | mcp:write |
ProductVariant_create | POST /v1/products/{productUuid}/variants | mutating | medium | mcp:write |
ProductVariant_delete | DELETE /v1/products/{productUuid}/variants/{uuid} | mutating | high | mcp:write |
ProductVariant_findOne | GET /v1/products/{productUuid}/variants/{uuid} | read-only | low | mcp:read |
ProductVariant_reactivate | POST /v1/products/{productUuid}/variants/{uuid}/reactivate | mutating | medium | mcp:write |
ProductVariant_update | PATCH /v1/products/{productUuid}/variants/{uuid} | mutating | medium | mcp:write |
Settings
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
Branding_clear | DELETE /v1/branding | mutating | high | mcp:write |
Branding_get | GET /v1/branding | read-only | low | mcp:read |
Branding_upsert | PUT /v1/branding | mutating | low | mcp:write |
ChargebackSettings_createDescriptor | POST /v1/settings/chargebacks/{id}/descriptors | mutating | high | mcp:write |
ChargebackSettings_getSetting | GET /v1/settings/chargebacks/{id} | read-only | low | mcp:read |
ChargebackSettings_updateSetting | PATCH /v1/settings/chargebacks/{id} | mutating | high | mcp:write |
ClientUser_create | POST /v1/client-users | mutating | high | mcp:write |
ClientUser_getOne | GET /v1/client-users/{id} | read-only | low | mcp:read |
ClientUser_list | GET /v1/client-users | read-only | low | mcp:read |
ClientUser_remove | DELETE /v1/client-users/{id} | mutating | critical | mcp:write |
ClientUser_transferOwnership | POST /v1/client-users/ownership/transfer | mutating | critical | mcp:write |
ClientUser_update | PATCH /v1/client-users/{id} | mutating | critical | mcp:write |
GatewaySettings_activate | POST /v1/settings/gateways/{id}/activate | mutating | critical | mcp:write |
GatewaySettings_create | POST /v1/settings/gateways | mutating | critical | mcp:write |
GatewaySettings_deactivate | POST /v1/settings/gateways/{id}/deactivate | mutating | critical | mcp:write |
GatewaySettings_get | GET /v1/settings/gateways/{id} | read-only | low | mcp:read |
GatewaySettings_list | GET /v1/settings/gateways | read-only | low | mcp:read |
GatewaySettings_test | POST /v1/settings/gateways/{id}/test | read-only | medium | mcp:read |
GatewaySettings_update | PATCH /v1/settings/gateways/{id} | mutating | critical | mcp:write |
PreDisputeAlertSettings_enrollDescriptor | POST /v1/settings/pre-dispute-alerts/{id}/descriptors | mutating | high | mcp:write |
PreDisputeAlertSettings_get | GET /v1/settings/pre-dispute-alerts/{id} | read-only | low | mcp:read |
PreDisputeAlertSettings_list | GET /v1/settings/pre-dispute-alerts | read-only | low | mcp:read |
PreDisputeAlertSettings_listDescriptors | GET /v1/settings/pre-dispute-alerts/{id}/descriptors | read-only | low | mcp:read |
PreDisputeAlertSettings_update | PATCH /v1/settings/pre-dispute-alerts/{id} | mutating | high | mcp:write |
Subscriptions
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
SubscriptionChange_change | POST /v1/subscriptions/{id}/change | mutating | high | mcp:write |
SubscriptionChange_changePreview | POST /v1/subscriptions/{id}/change/preview | read-only | medium | mcp:read |
SubscriptionChange_withdrawChange | POST /v1/subscriptions/{id}/change/withdraw | mutating | high | mcp:write |
SubscriptionControl_cancel | PUT /v1/subscriptions/{id}/cancel | mutating | critical | mcp:write |
SubscriptionControl_extend | PUT /v1/subscriptions/{id}/extend | mutating | high | mcp:write |
SubscriptionControl_pause | PUT /v1/subscriptions/{id}/pause | mutating | high | mcp:write |
SubscriptionControl_reactivate | PUT /v1/subscriptions/{id}/reactivate | mutating | high | mcp:write |
SubscriptionControl_resume | PUT /v1/subscriptions/{id}/resume | mutating | high | mcp:write |
SubscriptionCreate_create | POST /v1/subscriptions | mutating | critical | mcp:write |
SubscriptionPlan_getAll | GET /v1/subscriptions/plans | read-only | low | mcp:read |
SubscriptionPreview_getAllActiveV2 | GET /v2/subscriptions/active | read-only | low | mcp:read |
SubscriptionRead_exportSubscriptions | POST /v1/subscriptions/exports | read-only | medium | mcp:read |
SubscriptionRead_findOne | GET /v1/subscriptions/{id} | read-only | low | mcp:read |
SubscriptionRead_list | GET /v1/subscriptions | read-only | low | mcp:read |
SubscriptionRecovery_list | GET /v1/subscriptions/{id}/recovery | read-only | low | mcp:read |
SubscriptionStats_get | GET /v1/subscriptions/stats | read-only | medium | mcp:read |
Transactions
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
CreatePayment_create | POST /v1/payments | mutating | critical | mcp:write |
Invoice_exportInvoices | POST /v1/invoices/exports | read-only | medium | mcp:read |
Invoice_findOne | GET /v1/invoices/{id} | read-only | low | mcp:read |
Invoice_list | GET /v1/invoices | read-only | low | mcp:read |
Invoice_stats | GET /v1/invoices/stats | read-only | medium | mcp:read |
Payments_cancelAuthorization | PUT /v1/payments/{id}/cancel | mutating | critical | mcp:write |
Payments_captureAuthorization | PUT /v1/payments/{id}/capture | mutating | critical | mcp:write |
Payments_exportPayments | POST /v1/payments/exports | read-only | medium | mcp:read |
Payments_findOne | GET /v1/payments/{id} | read-only | low | mcp:read |
Payments_list | GET /v1/payments | read-only | low | mcp:read |
Payments_refund | POST /v1/payments/{id}/refund | mutating | critical | mcp:write |
Users
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
InvoicePreview_list | GET /v1/users/{id}/invoices | read-only | low | mcp:read |
PaymentMethods_delete | DELETE /v1/payment-methods/{id} | mutating | critical | mcp:write |
PaymentMethods_list | GET /v1/payment-methods | read-only | low | mcp:read |
Timelines_list | GET /v1/timelines | read-only | low | mcp:read |
Timelines_record | GET /v1/timelines/record | read-only | low | mcp:read |
User_exportUsers | POST /v1/users/exports | read-only | medium | mcp:read |
User_getUserById | GET /v1/users/{id} | read-only | low | mcp:read |
User_getUserPurchases | GET /v1/users/{id}/purchases | read-only | low | mcp:read |
User_getUserSubscriptions | GET /v1/users/{id}/subscriptions | read-only | low | mcp:read |
User_listUsers | GET /v1/users | read-only | low | mcp:read |
User_lookup | GET /v1/users/lookup | read-only | low | mcp:read |
User_merge | POST /v1/users/{id}/merge | mutating | critical | mcp:write |
User_updateUser | PATCH /v1/users/{id} | mutating | medium | mcp:write |
UserPurchaseRecords_list | GET /v1/users/{id}/purchase-records | read-only | low | mcp:read |
Webhooks
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
ClientWebhook_create | POST /v1/webhooks | mutating | high | mcp:write |
ClientWebhook_delete | DELETE /v1/webhooks/{id} | mutating | critical | mcp:write |
ClientWebhook_list | GET /v1/webhooks | read-only | low | mcp:read |
ClientWebhook_update | PATCH /v1/webhooks/{id} | mutating | high | mcp:write |
ClientWebhookEvent_exportEvents | POST /v1/webhooks/events/exports | read-only | medium | mcp:read |
ClientWebhookEvent_findOne | GET /v1/webhooks/events/{id} | read-only | low | mcp:read |
ClientWebhookEvent_list | GET /v1/webhooks/events | read-only | low | mcp:read |
ClientWebhookEvent_resend | PUT /v1/webhooks/events/{id}/resend | mutating | high | mcp:write |
ClientWebhookEvent_resendMany | POST /v1/webhooks/events/resend | mutating | high | mcp:write |
Other
| Tool | Operation | Class | Risk | Scopes |
|---|---|---|---|---|
ClientInvoices_findOne | GET /v1/client-invoices/{uuid} | read-only | low | mcp:read |
ClientInvoices_list | GET /v1/client-invoices | read-only | low | mcp:read |
Company_get | GET /v1/company | read-only | low | mcp:read |
Company_update | PATCH /v1/company | mutating | medium | mcp:write |
DunningPolicy_clear | DELETE /v1/settings/dunning-policy | mutating | high | mcp:write |
DunningPolicy_get | GET /v1/settings/dunning-policy | read-only | low | mcp:read |
DunningPolicy_update | PATCH /v1/settings/dunning-policy | mutating | high | mcp:write |
ProductPrices_list | GET /v1/product-prices | read-only | low | mcp: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.