MCPTool reference
Settings tools
Arguments, results, errors, and access, confirmation, and retry policy for each Settings tool in FloPay MCP, from the reviewed API contract.
Settings tools
Generated from the FloPay MCP contract version 1, revision 764b41d5c7205d6df7eeaeac832fafe882247f5526b1d4d6bc6f98e3eaca7784.
Branding_get
Read branding
Returns branding for the active client, including hostedCheckoutTheme used for branding emails and other white-label services.
| Policy | Value |
|---|---|
| Operation | GET /v1/branding |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
This tool takes no arguments.
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | Yes | |
hostedCheckoutTheme | object | Yes | |
hostedCheckoutTheme.appearance | object | No | |
hostedCheckoutTheme.appearance.colorPrimary | string | No | |
hostedCheckoutTheme.appearance.colorText | string | No | |
hostedCheckoutTheme.appearance.container | object | No | |
hostedCheckoutTheme.appearance.container.backgroundColor | string | No | |
hostedCheckoutTheme.appearance.container.borderRadius | string | No | Minimum length: 1. Maximum length: 255. |
hostedCheckoutTheme.appearance.container.maxWidth | string | No | Minimum length: 1. Maximum length: 255. |
hostedCheckoutTheme.appearance.container.shadow | string | No | Minimum length: 1. Maximum length: 1000. |
hostedCheckoutTheme.appearance.footer | object | No | |
hostedCheckoutTheme.appearance.footer.show | boolean | No | |
hostedCheckoutTheme.appearance.footer.text | string | No | Minimum length: 0. Maximum length: 1000. |
hostedCheckoutTheme.appearance.header | object | No | |
hostedCheckoutTheme.appearance.header.backgroundColor | string | No | |
hostedCheckoutTheme.appearance.header.show | boolean | No | |
hostedCheckoutTheme.appearance.pageBackgroundColor | string | No | |
hostedCheckoutTheme.appearance.pageBackgroundImage | string | No | |
hostedCheckoutTheme.appearance.rules | object | No | |
hostedCheckoutTheme.fontFamily | string | No | Minimum length: 1. Maximum length: 1000. |
hostedCheckoutTheme.fontUrl | string | No | |
hostedCheckoutTheme.logo | object | Yes | |
hostedCheckoutTheme.logo.alt | string | No | Minimum length: 0. Maximum length: 255. |
hostedCheckoutTheme.logo.href | string | No | |
hostedCheckoutTheme.logo.size | number | No | Minimum: 1. Maximum: 512. |
hostedCheckoutTheme.logo.src | string | Yes | |
id | string (uuid) | Yes | |
name | string | Yes | |
sdkEmbedTheme | object | Yes | |
sdkEmbedTheme.appearance | object | No | |
sdkEmbedTheme.appearance.rules | object | No | |
sdkEmbedTheme.appearance.theme | string | No | Allowed values: default, flat, night, none. |
sdkEmbedTheme.appearance.variables | object | No | |
sdkEmbedTheme.appearance.variables.borderRadius | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.appearance.variables.colorBackground | string | No | |
sdkEmbedTheme.appearance.variables.colorDanger | string | No | |
sdkEmbedTheme.appearance.variables.colorPrimary | string | No | |
sdkEmbedTheme.appearance.variables.colorPrimaryHover | string | No | |
sdkEmbedTheme.appearance.variables.colorText | string | No | |
sdkEmbedTheme.appearance.variables.fontFamily | string | No | Minimum length: 1. Maximum length: 1000. |
sdkEmbedTheme.appearance.variables.fontSizeBase | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.appearance.variables.spacingUnit | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.buttonsStyles | object | No | |
sdkEmbedTheme.buttonsStyles.addressLine1Input | object | No | |
sdkEmbedTheme.buttonsStyles.addressLine2Input | object | No | |
sdkEmbedTheme.buttonsStyles.backButton | object | No | |
sdkEmbedTheme.buttonsStyles.backButtonFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.backButtonIcon | object | No | |
sdkEmbedTheme.buttonsStyles.cardButton | object | No | |
sdkEmbedTheme.buttonsStyles.cardButtonFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.cardFormContainer | object | No | |
sdkEmbedTheme.buttonsStyles.cardInputBackground | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputBorder | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputColor | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputPlaceholderColor | string | No | |
sdkEmbedTheme.buttonsStyles.cityInput | object | No | |
sdkEmbedTheme.buttonsStyles.countrySelect | object | No | |
sdkEmbedTheme.buttonsStyles.errorBanner | object | No | |
sdkEmbedTheme.buttonsStyles.nameInput | object | No | |
sdkEmbedTheme.buttonsStyles.stateInput | object | No | |
sdkEmbedTheme.buttonsStyles.submitButton | object | No | |
sdkEmbedTheme.buttonsStyles.submitButtonFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.title | object | No | |
sdkEmbedTheme.buttonsStyles.titleFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.vaultCardForm | object | No | |
sdkEmbedTheme.buttonsStyles.zipInput | object | No | |
sdkEmbedTheme.layout | string | Yes | Allowed values: default, buttons. |
sdkEmbedTheme.themePreset | string | Yes | Allowed values: classic, modern-light, modern-dark, bold-light, bold-dark, glass-light, glass-dark. |
updatedAt | string (date-time) | Yes |
Errors
| Status | Description |
|---|---|
401 | Client Basic authentication or OAuth2 bearer authentication is required. |
404 | The client has not configured branding. |
Branding_upsert
Create or replace branding
Creates or wholly replaces branding for the active client. hostedCheckoutTheme is also used for branding emails and other white-label services.
| Policy | Value |
|---|---|
| Operation | PUT /v1/branding |
| Class | mutating |
| Risk | low |
| Confirmation | required |
| Retry | same-idempotency-key |
| Rate-limit tier | mutation |
| Roles | owner, admin |
| Scopes | mcp:write |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
hostedCheckoutTheme | body | object | Yes | |
hostedCheckoutTheme.appearance | body | object | No | |
hostedCheckoutTheme.appearance.colorPrimary | body | string | No | |
hostedCheckoutTheme.appearance.colorText | body | string | No | |
hostedCheckoutTheme.appearance.container | body | object | No | |
hostedCheckoutTheme.appearance.container.backgroundColor | body | string | No | |
hostedCheckoutTheme.appearance.container.borderRadius | body | string | No | Minimum length: 1. Maximum length: 255. |
hostedCheckoutTheme.appearance.container.maxWidth | body | string | No | Minimum length: 1. Maximum length: 255. |
hostedCheckoutTheme.appearance.container.shadow | body | string | No | Minimum length: 1. Maximum length: 1000. |
hostedCheckoutTheme.appearance.footer | body | object | No | |
hostedCheckoutTheme.appearance.footer.show | body | boolean | No | |
hostedCheckoutTheme.appearance.footer.text | body | string | No | Minimum length: 0. Maximum length: 1000. |
hostedCheckoutTheme.appearance.header | body | object | No | |
hostedCheckoutTheme.appearance.header.backgroundColor | body | string | No | |
hostedCheckoutTheme.appearance.header.show | body | boolean | No | |
hostedCheckoutTheme.appearance.pageBackgroundColor | body | string | No | |
hostedCheckoutTheme.appearance.pageBackgroundImage | body | string | No | |
hostedCheckoutTheme.appearance.rules | body | object | No | |
hostedCheckoutTheme.fontFamily | body | string | No | Minimum length: 1. Maximum length: 1000. |
hostedCheckoutTheme.fontUrl | body | string | No | |
hostedCheckoutTheme.logo | body | object | Yes | |
hostedCheckoutTheme.logo.alt | body | string | No | Minimum length: 0. Maximum length: 255. |
hostedCheckoutTheme.logo.href | body | string | No | |
hostedCheckoutTheme.logo.size | body | number | No | Minimum: 1. Maximum: 512. |
hostedCheckoutTheme.logo.src | body | string | Yes | |
name | body | string | Yes | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme | body | object | Yes | |
sdkEmbedTheme.appearance | body | object | No | |
sdkEmbedTheme.appearance.rules | body | object | No | |
sdkEmbedTheme.appearance.theme | body | string | No | Allowed values: default, flat, night, none. |
sdkEmbedTheme.appearance.variables | body | object | No | |
sdkEmbedTheme.appearance.variables.borderRadius | body | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.appearance.variables.colorBackground | body | string | No | |
sdkEmbedTheme.appearance.variables.colorDanger | body | string | No | |
sdkEmbedTheme.appearance.variables.colorPrimary | body | string | No | |
sdkEmbedTheme.appearance.variables.colorPrimaryHover | body | string | No | |
sdkEmbedTheme.appearance.variables.colorText | body | string | No | |
sdkEmbedTheme.appearance.variables.fontFamily | body | string | No | Minimum length: 1. Maximum length: 1000. |
sdkEmbedTheme.appearance.variables.fontSizeBase | body | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.appearance.variables.spacingUnit | body | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.buttonsStyles | body | object | No | |
sdkEmbedTheme.buttonsStyles.addressLine1Input | body | object | No | |
sdkEmbedTheme.buttonsStyles.addressLine2Input | body | object | No | |
sdkEmbedTheme.buttonsStyles.backButton | body | object | No | |
sdkEmbedTheme.buttonsStyles.backButtonFontSize | body | string | No | |
sdkEmbedTheme.buttonsStyles.backButtonIcon | body | object | No | |
sdkEmbedTheme.buttonsStyles.cardButton | body | object | No | |
sdkEmbedTheme.buttonsStyles.cardButtonFontSize | body | string | No | |
sdkEmbedTheme.buttonsStyles.cardFormContainer | body | object | No | |
sdkEmbedTheme.buttonsStyles.cardInputBackground | body | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputBorder | body | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputColor | body | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputFontSize | body | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputPlaceholderColor | body | string | No | |
sdkEmbedTheme.buttonsStyles.cityInput | body | object | No | |
sdkEmbedTheme.buttonsStyles.countrySelect | body | object | No | |
sdkEmbedTheme.buttonsStyles.errorBanner | body | object | No | |
sdkEmbedTheme.buttonsStyles.nameInput | body | object | No | |
sdkEmbedTheme.buttonsStyles.stateInput | body | object | No | |
sdkEmbedTheme.buttonsStyles.submitButton | body | object | No | |
sdkEmbedTheme.buttonsStyles.submitButtonFontSize | body | string | No | |
sdkEmbedTheme.buttonsStyles.title | body | object | No | |
sdkEmbedTheme.buttonsStyles.titleFontSize | body | string | No | |
sdkEmbedTheme.buttonsStyles.vaultCardForm | body | object | No | |
sdkEmbedTheme.buttonsStyles.zipInput | body | object | No | |
sdkEmbedTheme.layout | body | string | Yes | Allowed values: default, buttons. |
sdkEmbedTheme.themePreset | body | string | Yes | Allowed values: classic, modern-light, modern-dark, bold-light, bold-dark, glass-light, glass-dark. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | Yes | |
hostedCheckoutTheme | object | Yes | |
hostedCheckoutTheme.appearance | object | No | |
hostedCheckoutTheme.appearance.colorPrimary | string | No | |
hostedCheckoutTheme.appearance.colorText | string | No | |
hostedCheckoutTheme.appearance.container | object | No | |
hostedCheckoutTheme.appearance.container.backgroundColor | string | No | |
hostedCheckoutTheme.appearance.container.borderRadius | string | No | Minimum length: 1. Maximum length: 255. |
hostedCheckoutTheme.appearance.container.maxWidth | string | No | Minimum length: 1. Maximum length: 255. |
hostedCheckoutTheme.appearance.container.shadow | string | No | Minimum length: 1. Maximum length: 1000. |
hostedCheckoutTheme.appearance.footer | object | No | |
hostedCheckoutTheme.appearance.footer.show | boolean | No | |
hostedCheckoutTheme.appearance.footer.text | string | No | Minimum length: 0. Maximum length: 1000. |
hostedCheckoutTheme.appearance.header | object | No | |
hostedCheckoutTheme.appearance.header.backgroundColor | string | No | |
hostedCheckoutTheme.appearance.header.show | boolean | No | |
hostedCheckoutTheme.appearance.pageBackgroundColor | string | No | |
hostedCheckoutTheme.appearance.pageBackgroundImage | string | No | |
hostedCheckoutTheme.appearance.rules | object | No | |
hostedCheckoutTheme.fontFamily | string | No | Minimum length: 1. Maximum length: 1000. |
hostedCheckoutTheme.fontUrl | string | No | |
hostedCheckoutTheme.logo | object | Yes | |
hostedCheckoutTheme.logo.alt | string | No | Minimum length: 0. Maximum length: 255. |
hostedCheckoutTheme.logo.href | string | No | |
hostedCheckoutTheme.logo.size | number | No | Minimum: 1. Maximum: 512. |
hostedCheckoutTheme.logo.src | string | Yes | |
id | string (uuid) | Yes | |
name | string | Yes | |
sdkEmbedTheme | object | Yes | |
sdkEmbedTheme.appearance | object | No | |
sdkEmbedTheme.appearance.rules | object | No | |
sdkEmbedTheme.appearance.theme | string | No | Allowed values: default, flat, night, none. |
sdkEmbedTheme.appearance.variables | object | No | |
sdkEmbedTheme.appearance.variables.borderRadius | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.appearance.variables.colorBackground | string | No | |
sdkEmbedTheme.appearance.variables.colorDanger | string | No | |
sdkEmbedTheme.appearance.variables.colorPrimary | string | No | |
sdkEmbedTheme.appearance.variables.colorPrimaryHover | string | No | |
sdkEmbedTheme.appearance.variables.colorText | string | No | |
sdkEmbedTheme.appearance.variables.fontFamily | string | No | Minimum length: 1. Maximum length: 1000. |
sdkEmbedTheme.appearance.variables.fontSizeBase | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.appearance.variables.spacingUnit | string | No | Minimum length: 1. Maximum length: 255. |
sdkEmbedTheme.buttonsStyles | object | No | |
sdkEmbedTheme.buttonsStyles.addressLine1Input | object | No | |
sdkEmbedTheme.buttonsStyles.addressLine2Input | object | No | |
sdkEmbedTheme.buttonsStyles.backButton | object | No | |
sdkEmbedTheme.buttonsStyles.backButtonFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.backButtonIcon | object | No | |
sdkEmbedTheme.buttonsStyles.cardButton | object | No | |
sdkEmbedTheme.buttonsStyles.cardButtonFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.cardFormContainer | object | No | |
sdkEmbedTheme.buttonsStyles.cardInputBackground | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputBorder | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputColor | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.cardInputPlaceholderColor | string | No | |
sdkEmbedTheme.buttonsStyles.cityInput | object | No | |
sdkEmbedTheme.buttonsStyles.countrySelect | object | No | |
sdkEmbedTheme.buttonsStyles.errorBanner | object | No | |
sdkEmbedTheme.buttonsStyles.nameInput | object | No | |
sdkEmbedTheme.buttonsStyles.stateInput | object | No | |
sdkEmbedTheme.buttonsStyles.submitButton | object | No | |
sdkEmbedTheme.buttonsStyles.submitButtonFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.title | object | No | |
sdkEmbedTheme.buttonsStyles.titleFontSize | string | No | |
sdkEmbedTheme.buttonsStyles.vaultCardForm | object | No | |
sdkEmbedTheme.buttonsStyles.zipInput | object | No | |
sdkEmbedTheme.layout | string | Yes | Allowed values: default, buttons. |
sdkEmbedTheme.themePreset | string | Yes | Allowed values: classic, modern-light, modern-dark, bold-light, bold-dark, glass-light, glass-dark. |
updatedAt | string (date-time) | Yes |
Errors
| Status | Description |
|---|---|
401 | Client Basic authentication or OAuth2 bearer authentication is required. |
ChargebackSettings_getSetting
Get Chargeback Setting
Deprecated compatibility alias for Pre-Dispute Alert Settings. Use GET /v1/settings/pre-dispute-alerts (PreDisputeAlertSettings_list), GET/PATCH /v1/settings/pre-dispute-alerts/{id} (PreDisputeAlertSettings_get|update), and GET/POST /v1/settings/pre-dispute-alerts/{id}/descriptors (PreDisputeAlertSettings_listDescriptors|enrollDescriptor). Removal is tracked separately; there is no fixed removal date. Returns a single alert-network business-account setting owned by the authenticated client.
| Policy | Value |
|---|---|
| Operation | GET /v1/settings/chargebacks/{id} |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | Yes | The chargeback business-account setting id. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
autoRefundAmount | number or null | Yes | Cap applied to AUTO-REFUND-CAPPED (Phase 2). |
chargebackAction | string | Yes | Deprecated compatibility field for the configured response mode. Prefer responseMode on Pre-Dispute Alert Settings. Removal is tracked separately. Allowed values: AUTO-REFUND, AUTO-REFUND-CAPPED, ALERT. |
chargebackIoId | string or null | Yes | Deprecated compatibility field for the alert-network business-account id used to attribute inbound alerts. Prefer Pre-Dispute Alert Settings. Removal is tracked separately. |
clientId | string | Yes | The owning Flopay client UUID. |
createdAt | string (date-time) | Yes | |
description | string or null | Yes | Optional free-text note describing this business account. Local display value only. |
id | string | Yes | The Flopay chargeback-settings UUID. |
name | string or null | Yes | Human-friendly label for this business account (e.g. "UK Ltd"). Local display value only. |
updatedAt | string (date-time) | Yes |
Errors
| Status | Description |
|---|---|
400 | The supplied request body is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
404 | No such chargeback setting for this client. |
ClientUser_getOne
Get a team member by id
Owner/admin can read any team member; members can read only themselves.
| Policy | Value |
|---|---|
| Operation | GET /v1/client-users/{id} |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | The client_user id. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | Yes | When the client_user identity was created. |
email | string | Yes | The operator email address (always stored and returned lowercase). |
emailVerified | boolean | Yes | Whether the operator has verified their email address. |
id | string | Yes | The client_user identifier. Use this value in /v1/client-users/{id} routes. |
name | string | Yes | The operator display name. |
role | string | Yes | The operator role within this client. Allowed values: owner, admin, member. |
updatedAt | string (date-time) | Yes | When the client_user identity was last updated. |
Errors
| Status | Description |
|---|---|
401 | A valid OAuth client_user access token with the mcp scope is required. |
403 | The caller is authenticated but their membership role does not permit this action. |
ClientUser_list
List team
Returns the team directory for the active client. Available to any role.
| Policy | Value |
|---|---|
| Operation | GET /v1/client-users |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
This tool takes no arguments.
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | |
data[].createdAt | string (date-time) | Yes | When the client_user identity was created. |
data[].email | string | Yes | The operator email address (always stored and returned lowercase). |
data[].emailVerified | boolean | Yes | Whether the operator has verified their email address. |
data[].id | string | Yes | The client_user identifier. Use this value in /v1/client-users/{id} routes. |
data[].name | string | Yes | The operator display name. |
data[].role | string | Yes | The operator role within this client. Allowed values: owner, admin, member. |
data[].updatedAt | string (date-time) | Yes | When the client_user identity was last updated. |
Errors
| Status | Description |
|---|---|
401 | A valid OAuth client_user access token with the mcp scope is required. |
403 | The caller is authenticated but their membership role does not permit this action. |
GatewaySettings_get
Get Gateway
Returns a single gateway owned by the authenticated client.
| Policy | Value |
|---|---|
| Operation | GET /v1/settings/gateways/{id} |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | Yes | The gateway id. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | Yes | The owning client UUID. |
code | string | Yes | Flopay-owned unique gateway code (webhook account-code hint). |
connectionValidatedAt | string (date-time) or null | Yes | When the provider last confirmed the stored credentials. Null for unconnected drafts. |
countries | array of string or null | Yes | ISO 3166-1 alpha-2 countries, or null. |
createdAt | string (date-time) | Yes | |
currency | string | Yes | ISO 4217 currency this gateway serves. |
environment | string | Yes | Allowed values: stage, production. |
id | string | Yes | The gateway UUID. |
name | string | Yes | Display name. |
priority | number | Yes | Routing priority (lower ranks first). |
providerAccountId | string or null | Yes | Canonical provider account identity captured at validation (Stripe acct_…, PayPal REST-app client ID). Null until the connection has been validated. |
providerType | string | Yes | Allowed values: stripe, paypal, worldpay_corporate_gateway. |
publishableKey | string or null | Yes | Provider public identifier (Stripe publishable key / PayPal client ID). |
secretKeyConfigured | boolean | Yes | Whether a provider secret credential is stored. The value is write-only. |
status | string | Yes | Lifecycle state: draft, active, or inactive. Allowed values: draft, active, inactive. |
updatedAt | string (date-time) | Yes | |
webhookSigningSecretConfigured | boolean | Yes | Whether a webhook verification value is stored. The value is write-only. |
worldpayCapabilities | object or null | Yes | Approved Worldpay merchant-code capabilities. |
worldpayCapabilities.approvalReference | string | Yes | Privacy-safe Operations approval reference. Maximum length: 255. |
worldpayCapabilities.approvedAt | string (date-time) | Yes | |
worldpayCapabilities.cardSchemes | array of string | Yes | Explicit Worldpay card-scheme allowlist. Minimum items: 1. |
worldpayCapabilities.countries | array of string | Yes | Explicit ISO 3166-1 alpha-2 country allowlist. Minimum items: 1. |
worldpayCapabilities.currencies | array of string | Yes | Explicit ISO 4217 currency allowlist; empty never means all. Minimum items: 1. |
worldpayCapabilities.expiresAt | string (date-time) | Yes | |
worldpayCapabilities.operations | array of string | Yes | Allowed values: purchase, authorization, capture, void, refund, status, order_inquiry, order_notifications, three_ds, stored_credentials. Minimum items: 1. |
worldpayCapabilities.orderNotificationsCertified | boolean | Yes | |
worldpayCapabilities.pcivaultBinMetadataCertified | boolean | Yes | |
worldpayCapabilities.pcivaultProxyCertified | boolean | Yes | |
worldpayCapabilities.storedCredentialsCertified | boolean | Yes | |
worldpayCapabilities.threeDsCertified | boolean | Yes | |
worldpayCapabilities.version | number | Yes | Capability-record schema version. Allowed values: 1. |
worldpayMerchantCode | string or null | Yes | Worldpay merchant code, or null for other providers. |
worldpayThreeDsApiIdConfigured | boolean | Yes | Whether the Worldpay 3DS API ID is stored. The value is write-only. |
worldpayThreeDsHmacKeyConfigured | boolean | Yes | Whether the Worldpay 3DS HMAC key is stored. The value is write-only. |
worldpayThreeDsOrganizationUnitIdConfigured | boolean | Yes | Whether the Worldpay 3DS organisation unit ID is stored. The value is write-only. |
worldpayXmlPasswordConfigured | boolean | Yes | Whether the Worldpay XML machine password is stored. The value is write-only. |
worldpayXmlUsernameConfigured | boolean | Yes | Whether the Worldpay XML machine username is stored. The value is write-only. |
Errors
| Status | Description |
|---|---|
400 | The supplied request body is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
403 | Members cannot manage gateway settings. |
404 | No such gateway for this client. |
GatewaySettings_list
List Gateways
Returns every payment gateway owned by the authenticated client: drafts, active, and inactive. Secret credentials and webhook verification values are write-only and surface as configuration flags. This response is an unpaginated array; use GET /v2/settings/gateways for the shared paginated list contract with filtering, sorting, and paging.
| Policy | Value |
|---|---|
| Operation | GET /v1/settings/gateways |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin |
| Scopes | mcp:read |
Arguments
This tool takes no arguments.
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
[].clientId | string | Yes | The owning client UUID. |
[].code | string | Yes | Flopay-owned unique gateway code (webhook account-code hint). |
[].connectionValidatedAt | string (date-time) or null | Yes | When the provider last confirmed the stored credentials. Null for unconnected drafts. |
[].countries | array of string or null | Yes | ISO 3166-1 alpha-2 countries, or null. |
[].createdAt | string (date-time) | Yes | |
[].currency | string | Yes | ISO 4217 currency this gateway serves. |
[].environment | string | Yes | Allowed values: stage, production. |
[].id | string | Yes | The gateway UUID. |
[].name | string | Yes | Display name. |
[].priority | number | Yes | Routing priority (lower ranks first). |
[].providerAccountId | string or null | Yes | Canonical provider account identity captured at validation (Stripe acct_…, PayPal REST-app client ID). Null until the connection has been validated. |
[].providerType | string | Yes | Allowed values: stripe, paypal, worldpay_corporate_gateway. |
[].publishableKey | string or null | Yes | Provider public identifier (Stripe publishable key / PayPal client ID). |
[].secretKeyConfigured | boolean | Yes | Whether a provider secret credential is stored. The value is write-only. |
[].status | string | Yes | Lifecycle state: draft, active, or inactive. Allowed values: draft, active, inactive. |
[].updatedAt | string (date-time) | Yes | |
[].webhookSigningSecretConfigured | boolean | Yes | Whether a webhook verification value is stored. The value is write-only. |
[].worldpayCapabilities | object or null | Yes | Approved Worldpay merchant-code capabilities. |
[].worldpayCapabilities.approvalReference | string | Yes | Privacy-safe Operations approval reference. Maximum length: 255. |
[].worldpayCapabilities.approvedAt | string (date-time) | Yes | |
[].worldpayCapabilities.cardSchemes | array of string | Yes | Explicit Worldpay card-scheme allowlist. Minimum items: 1. |
[].worldpayCapabilities.countries | array of string | Yes | Explicit ISO 3166-1 alpha-2 country allowlist. Minimum items: 1. |
[].worldpayCapabilities.currencies | array of string | Yes | Explicit ISO 4217 currency allowlist; empty never means all. Minimum items: 1. |
[].worldpayCapabilities.expiresAt | string (date-time) | Yes | |
[].worldpayCapabilities.operations | array of string | Yes | Allowed values: purchase, authorization, capture, void, refund, status, order_inquiry, order_notifications, three_ds, stored_credentials. Minimum items: 1. |
[].worldpayCapabilities.orderNotificationsCertified | boolean | Yes | |
[].worldpayCapabilities.pcivaultBinMetadataCertified | boolean | Yes | |
[].worldpayCapabilities.pcivaultProxyCertified | boolean | Yes | |
[].worldpayCapabilities.storedCredentialsCertified | boolean | Yes | |
[].worldpayCapabilities.threeDsCertified | boolean | Yes | |
[].worldpayCapabilities.version | number | Yes | Capability-record schema version. Allowed values: 1. |
[].worldpayMerchantCode | string or null | Yes | Worldpay merchant code, or null for other providers. |
[].worldpayThreeDsApiIdConfigured | boolean | Yes | Whether the Worldpay 3DS API ID is stored. The value is write-only. |
[].worldpayThreeDsHmacKeyConfigured | boolean | Yes | Whether the Worldpay 3DS HMAC key is stored. The value is write-only. |
[].worldpayThreeDsOrganizationUnitIdConfigured | boolean | Yes | Whether the Worldpay 3DS organisation unit ID is stored. The value is write-only. |
[].worldpayXmlPasswordConfigured | boolean | Yes | Whether the Worldpay XML machine password is stored. The value is write-only. |
[].worldpayXmlUsernameConfigured | boolean | Yes | Whether the Worldpay XML machine username is stored. The value is write-only. |
Errors
| Status | Description |
|---|---|
400 | The supplied request body is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
403 | Members cannot manage gateway settings. |
GatewaySettings_listPage
List Gateways (paginated)
Returns a page of payment gateways owned by the authenticated client (drafts, active, and inactive) in the shared { data, page, limit, pages, total } list envelope, with the shared filter, sort, and paging parameters. Secret credentials and webhook verification values are write-only and surface as configuration flags. GET /v1/settings/gateways keeps its unpaginated array response unchanged.
| Policy | Value |
|---|---|
| Operation | GET /v2/settings/gateways |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
page | query | integer | No | 1-based page number for paginated list endpoints. Default: 1. Minimum: 1. |
limit | query | integer | No | Maximum number of records to return per page. Default: 20. Minimum: 1. Maximum: 100. |
sort | query | string | No | Sort by one allowed field. Use exactly one of sort[asc] or sort[desc]. Allowed fields: id, code, connectionValidatedAt, createdAt, currency, environment, isActive, name, priority, providerType, status, updatedAt. Default: createdAt ASC. Allowed values: id, code, connectionValidatedAt, createdAt, currency, environment, isActive, name, priority, providerType, status, updatedAt. |
relation | query | string | No | This endpoint does not support relation aliases. Supplying relation returns 400. |
code | query | string | No | Flopay-owned unique gateway code. Equality filter. Pass without operator for exact match or pass any of the following operators: [in] [search]. [in] accepts comma-separated values; blank entries return 400. [search] is case-insensitive text contains matching. |
connectionValidatedAt | query | string (date-time) | No | When the provider last confirmed the stored credentials. Equality filter. Pass without operator for exact match or pass any of the following operators: [gt] [gte] [lt] [lte]. |
createdAt | query | string (date-time) | No | Gateway creation timestamp. Equality filter. Pass without operator for exact match or pass any of the following operators: [gt] [gte] [lt] [lte]. |
currency | query | string | No | Uppercase ISO 4217 currency this gateway serves. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. |
environment | query | string | No | Provider environment the gateway connects to. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. Allowed values: stage, production. |
id | query | string (uuid) | No | Gateway id. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. |
isActive | query | string | No | Whether the gateway is available for runtime routing. Equality filter. Pass without operator for exact match. Allowed values: true, false. |
name | query | string | No | Gateway display name. Equality filter. Pass without operator for exact match or pass any of the following operators: [search]. [search] is case-insensitive text contains matching. |
priority | query | number | No | Routing priority (lower ranks first). Equality filter. Pass without operator for exact match or pass any of the following operators: [gte] [lte]. |
providerAccountId | query | string | No | Canonical provider account identity captured at credential validation. Equality filter. Pass without operator for exact match or pass any of the following operators: [in] [search]. [in] accepts comma-separated values; blank entries return 400. [search] is case-insensitive text contains matching. |
providerType | query | string | No | Payment provider backing the gateway. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. Allowed values: stripe, paypal, worldpay_corporate_gateway. |
status | query | string | No | Gateway lifecycle state: draft, active, or inactive. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. Allowed values: draft, active, inactive. |
updatedAt | query | string (date-time) | No | Gateway update timestamp. Equality filter. Pass without operator for exact match or pass any of the following operators: [gt] [gte] [lt] [lte]. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | |
data[].clientId | string | Yes | The owning client UUID. |
data[].code | string | Yes | Flopay-owned unique gateway code (webhook account-code hint). |
data[].connectionValidatedAt | string (date-time) or null | Yes | When the provider last confirmed the stored credentials. Null for unconnected drafts. |
data[].countries | array of string or null | Yes | ISO 3166-1 alpha-2 countries, or null. |
data[].createdAt | string (date-time) | Yes | |
data[].currency | string | Yes | ISO 4217 currency this gateway serves. |
data[].environment | string | Yes | Allowed values: stage, production. |
data[].id | string | Yes | The gateway UUID. |
data[].name | string | Yes | Display name. |
data[].priority | number | Yes | Routing priority (lower ranks first). |
data[].providerAccountId | string or null | Yes | Canonical provider account identity captured at validation (Stripe acct_…, PayPal REST-app client ID). Null until the connection has been validated. |
data[].providerType | string | Yes | Allowed values: stripe, paypal, worldpay_corporate_gateway. |
data[].publishableKey | string or null | Yes | Provider public identifier (Stripe publishable key / PayPal client ID). |
data[].secretKeyConfigured | boolean | Yes | Whether a provider secret credential is stored. The value is write-only. |
data[].status | string | Yes | Lifecycle state: draft, active, or inactive. Allowed values: draft, active, inactive. |
data[].updatedAt | string (date-time) | Yes | |
data[].webhookSigningSecretConfigured | boolean | Yes | Whether a webhook verification value is stored. The value is write-only. |
data[].worldpayCapabilities | object or null | Yes | Approved Worldpay merchant-code capabilities. |
data[].worldpayCapabilities.approvalReference | string | Yes | Privacy-safe Operations approval reference. Maximum length: 255. |
data[].worldpayCapabilities.approvedAt | string (date-time) | Yes | |
data[].worldpayCapabilities.cardSchemes | array of string | Yes | Explicit Worldpay card-scheme allowlist. Minimum items: 1. |
data[].worldpayCapabilities.countries | array of string | Yes | Explicit ISO 3166-1 alpha-2 country allowlist. Minimum items: 1. |
data[].worldpayCapabilities.currencies | array of string | Yes | Explicit ISO 4217 currency allowlist; empty never means all. Minimum items: 1. |
data[].worldpayCapabilities.expiresAt | string (date-time) | Yes | |
data[].worldpayCapabilities.operations | array of string | Yes | Allowed values: purchase, authorization, capture, void, refund, status, order_inquiry, order_notifications, three_ds, stored_credentials. Minimum items: 1. |
data[].worldpayCapabilities.orderNotificationsCertified | boolean | Yes | |
data[].worldpayCapabilities.pcivaultBinMetadataCertified | boolean | Yes | |
data[].worldpayCapabilities.pcivaultProxyCertified | boolean | Yes | |
data[].worldpayCapabilities.storedCredentialsCertified | boolean | Yes | |
data[].worldpayCapabilities.threeDsCertified | boolean | Yes | |
data[].worldpayCapabilities.version | number | Yes | Capability-record schema version. Allowed values: 1. |
data[].worldpayMerchantCode | string or null | Yes | Worldpay merchant code, or null for other providers. |
data[].worldpayThreeDsApiIdConfigured | boolean | Yes | Whether the Worldpay 3DS API ID is stored. The value is write-only. |
data[].worldpayThreeDsHmacKeyConfigured | boolean | Yes | Whether the Worldpay 3DS HMAC key is stored. The value is write-only. |
data[].worldpayThreeDsOrganizationUnitIdConfigured | boolean | Yes | Whether the Worldpay 3DS organisation unit ID is stored. The value is write-only. |
data[].worldpayXmlPasswordConfigured | boolean | Yes | Whether the Worldpay XML machine password is stored. The value is write-only. |
data[].worldpayXmlUsernameConfigured | boolean | Yes | Whether the Worldpay XML machine username is stored. The value is write-only. |
limit | number | Yes | |
page | number | Yes | |
pages | number | Yes | |
total | number | Yes |
Errors
| Status | Description |
|---|---|
400 | The supplied request body is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
403 | Members cannot manage gateway settings. |
GatewaySettings_test
Test Gateway Connection
Probes the provider with the stored credentials without mutating the gateway. Returns a sanitized success or error result.
| Policy | Value |
|---|---|
| Operation | POST /v1/settings/gateways/{id}/test |
| Class | read-only |
| Risk | medium |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | restricted |
| Roles | owner, admin |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | Yes | The gateway id. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
error | string or null | Yes | Sanitized, actionable failure summary. |
providerAccountId | string or null | Yes | Canonical provider account identity the probe observed (not persisted by the probe). |
success | boolean | Yes | Whether the provider accepted the stored credentials. |
Errors
| Status | Description |
|---|---|
400 | The supplied request body is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
403 | Members cannot manage gateway settings. |
404 | No such gateway for this client. |
PreDisputeAlertSettings_get
Get Pre-Dispute Alert Setting
Returns a single Pre-Dispute Alert Setting owned by the authenticated client.
| Policy | Value |
|---|---|
| Operation | GET /v1/settings/pre-dispute-alerts/{id} |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | Yes | The Pre-Dispute Alert Setting id. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
autoRefundAmount | number or null | No | Cap applied to AUTO-REFUND-CAPPED. |
clientId | string | Yes | The owning Flo client UUID. |
createdAt | string (date-time) | Yes | |
description | string or null | No | Optional free-text note. |
id | string (uuid) | Yes | The Flo Pre-Dispute Alert Setting UUID. |
name | string or null | No | Human-friendly label for this setting. |
preDisputeAlertSettingId | string (uuid) | Yes | Canonical Pre-Dispute Alert Setting ID. Same value as id. |
responseMode | string | Yes | Configured Pre-Dispute Alert response mode. Recorded but never acted on in ALERT mode. Allowed values: AUTO-REFUND, AUTO-REFUND-CAPPED, ALERT. |
updatedAt | string (date-time) | Yes |
Errors
| Status | Description |
|---|---|
400 | The supplied request body or list query is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
404 | No such Pre-Dispute Alert Setting for this client. |
PreDisputeAlertSettings_list
List Pre-Dispute Alert Settings
Returns paginated Pre-Dispute Alert Settings for the authenticated client. Actual Stripe and PayPal chargebacks are Disputes, not Pre-Dispute Alerts.
| Policy | Value |
|---|---|
| Operation | GET /v1/settings/pre-dispute-alerts |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
page | query | integer | No | 1-based page number for paginated list endpoints. Default: 1. Minimum: 1. |
limit | query | integer | No | Maximum number of records to return per page. Default: 20. Minimum: 1. Maximum: 100. |
sort | query | string | No | Sort by one allowed field. Use exactly one of sort[asc] or sort[desc]. Allowed fields: createdAt, name, updatedAt. Default: createdAt DESC. Allowed values: createdAt, name, updatedAt. |
relation | query | string | No | This endpoint does not support relation aliases. Supplying relation returns 400. |
createdAt | query | string (date-time) | No | Setting creation timestamp. Equality filter. Pass without operator for exact match or pass any of the following operators: [gt] [gte] [lt] [lte]. |
name | query | string | No | Local display label for this setting. Equality filter. Pass without operator for exact match or pass any of the following operators: [search]. [search] is case-insensitive text contains matching. |
responseMode | query | string | No | Configured Pre-Dispute Alert response mode. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. Allowed values: AUTO-REFUND, AUTO-REFUND-CAPPED, ALERT. |
updatedAt | query | string (date-time) | No | Setting update timestamp. Equality filter. Pass without operator for exact match or pass any of the following operators: [gt] [gte] [lt] [lte]. |
uuid | query | string | No | Opaque Flo Pre-Dispute Alert Setting ID. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | |
data[].autoRefundAmount | number or null | No | Cap applied to AUTO-REFUND-CAPPED. |
data[].clientId | string | Yes | The owning Flo client UUID. |
data[].createdAt | string (date-time) | Yes | |
data[].description | string or null | No | Optional free-text note. |
data[].id | string (uuid) | Yes | The Flo Pre-Dispute Alert Setting UUID. |
data[].name | string or null | No | Human-friendly label for this setting. |
data[].preDisputeAlertSettingId | string (uuid) | Yes | Canonical Pre-Dispute Alert Setting ID. Same value as id. |
data[].responseMode | string | Yes | Configured Pre-Dispute Alert response mode. Recorded but never acted on in ALERT mode. Allowed values: AUTO-REFUND, AUTO-REFUND-CAPPED, ALERT. |
data[].updatedAt | string (date-time) | Yes | |
limit | number | Yes | |
page | number | Yes | |
pages | number | Yes | |
total | number | Yes |
Errors
| Status | Description |
|---|---|
400 | The supplied request body or list query is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
PreDisputeAlertSettings_listDescriptors
List Pre-Dispute Alert Descriptors
Returns paginated billing-descriptor enrollments for one Pre-Dispute Alert Setting.
| Policy | Value |
|---|---|
| Operation | GET /v1/settings/pre-dispute-alerts/{id}/descriptors |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | Yes | The Pre-Dispute Alert Setting id. |
page | query | integer | No | 1-based page number for paginated list endpoints. Default: 1. Minimum: 1. |
limit | query | integer | No | Maximum number of records to return per page. Default: 20. Minimum: 1. Maximum: 100. |
sort | query | string | No | Sort by one allowed field. Use exactly one of sort[asc] or sort[desc]. Allowed fields: createdAt, descriptor, updatedAt. Default: createdAt DESC. Allowed values: createdAt, descriptor, updatedAt. |
relation | query | string | No | This endpoint does not support relation aliases. Supplying relation returns 400. |
createdAt | query | string (date-time) | No | Descriptor enrollment creation timestamp. Equality filter. Pass without operator for exact match or pass any of the following operators: [gt] [gte] [lt] [lte]. |
descriptor | query | string | No | Merchant billing descriptor text. Equality filter. Pass without operator for exact match or pass any of the following operators: [search]. [search] is case-insensitive text contains matching. |
enrollment | query | string | No | Alert network enrolled for this descriptor. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. Allowed values: ethoca, rdr, cdrn. |
status | query | string | No | Normalized enrollment status. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. Allowed values: pending, live, error. |
updatedAt | query | string (date-time) | No | Descriptor enrollment update timestamp. Equality filter. Pass without operator for exact match or pass any of the following operators: [gt] [gte] [lt] [lte]. |
uuid | query | string | No | Opaque Flo descriptor-enrollment ID. Equality filter. Pass without operator for exact match or pass any of the following operators: [in]. [in] accepts comma-separated values; blank entries return 400. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | |
data[].createdAt | string (date-time) | Yes | |
data[].descriptor | string | Yes | The merchant billing descriptor text. |
data[].enrollment | string | Yes | The alert network enrolled. Allowed values: ethoca, rdr, cdrn. |
data[].id | string | Yes | The Flo descriptor-enrollment UUID. |
data[].preDisputeAlertSettingId | string | Yes | The owning Pre-Dispute Alert Setting UUID. |
data[].status | string | Yes | Normalized enrollment status. Allowed values: pending, live, error. |
data[].updatedAt | string (date-time) | Yes | |
limit | number | Yes | |
page | number | Yes | |
pages | number | Yes | |
total | number | Yes |
Errors
| Status | Description |
|---|---|
400 | The supplied request body or list query is invalid. |
401 | Client Basic authentication or OAuth2 bearer authentication is required. For Basic, use client.uuid as the username and client.api_key as the password; for bearer, send a valid OAuth2 access token with the required scope. |
404 | No such Pre-Dispute Alert Setting for this client. |
Products tools
Arguments, results, errors, and access, confirmation, and retry policy for each Products tool in FloPay MCP, from the reviewed API contract.
Subscriptions tools
Arguments, results, errors, and access, confirmation, and retry policy for each Subscriptions tool in FloPay MCP, from the reviewed API contract.