# Fluveo ## Docs - [API Keys](https://docs.fluveo.com/api-reference/api-keys.md): Programmatically manage API keys - [Create an API Key](https://docs.fluveo.com/api-reference/apikeys/create-an-api-key.md): Creates a new API key. The full key is returned only once in the response. - [List API Keys](https://docs.fluveo.com/api-reference/apikeys/list-api-keys.md) - [Retrieve an API Key](https://docs.fluveo.com/api-reference/apikeys/retrieve-an-api-key.md) - [Revoke an API Key](https://docs.fluveo.com/api-reference/apikeys/revoke-an-api-key.md) - [Roll (rotate) an API Key](https://docs.fluveo.com/api-reference/apikeys/roll-rotate-an-api-key.md): Revokes the current key and creates a new one with the same name and type. The new full key is returned only once. - [Apps](https://docs.fluveo.com/api-reference/apps.md): Register and manage marketplace apps - [Delete a draft App](https://docs.fluveo.com/api-reference/apps/delete-a-draft-app.md): Deletes an app. Only apps in 'draft' status can be deleted. - [Generate OAuth client credentials](https://docs.fluveo.com/api-reference/apps/generate-oauth-client-credentials.md): Creates a new OAuth client for the app. The client_secret is returned only once. - [List OAuth clients for an App](https://docs.fluveo.com/api-reference/apps/list-oauth-clients-for-an-app.md) - [List your Apps](https://docs.fluveo.com/api-reference/apps/list-your-apps.md) - [Register a new App](https://docs.fluveo.com/api-reference/apps/register-a-new-app.md) - [Retrieve an App](https://docs.fluveo.com/api-reference/apps/retrieve-an-app.md) - [Submit an App for marketplace review](https://docs.fluveo.com/api-reference/apps/submit-an-app-for-marketplace-review.md): Submits a draft or rejected app for review. Requires name, description, at least one redirect URI, and at least one requested scope. - [Update an App](https://docs.fluveo.com/api-reference/apps/update-an-app.md) - [Balance](https://docs.fluveo.com/api-reference/balance.md): Retrieve your merchant balance - [Balance Transactions](https://docs.fluveo.com/api-reference/balance-transactions.md): View the history of funds flowing through your account - [List balance transactions](https://docs.fluveo.com/api-reference/balance/list-balance-transactions.md): Returns a list of transactions that have contributed to the merchant balance. - [Retrieve a balance transaction](https://docs.fluveo.com/api-reference/balance/retrieve-a-balance-transaction.md): Retrieves a single balance transaction by ID. - [Retrieve balance](https://docs.fluveo.com/api-reference/balance/retrieve-balance.md): Returns the current balance for your merchant account, broken into available and pending amounts. - [List balance transactions](https://docs.fluveo.com/api-reference/balancetransactions/list-balance-transactions.md): Returns a list of transactions that have contributed to the merchant balance. Alias for /v1/balance/transactions. - [Retrieve a balance transaction](https://docs.fluveo.com/api-reference/balancetransactions/retrieve-a-balance-transaction.md): Retrieves a single balance transaction by ID. - [Billing Portal](https://docs.fluveo.com/api-reference/billing-portal.md): Create customer portal sessions for billing self-service. - [Create a billing portal session](https://docs.fluveo.com/api-reference/billingportal/create-a-billing-portal-session.md) - [Checkout Links](https://docs.fluveo.com/api-reference/checkout-links.md): Create and manage reusable checkout links - [Checkout Sessions](https://docs.fluveo.com/api-reference/checkout-sessions.md): Create and manage checkout sessions - [Create a Checkout Link](https://docs.fluveo.com/api-reference/checkoutlinks/create-a-checkout-link.md) - [List Checkout Links](https://docs.fluveo.com/api-reference/checkoutlinks/list-checkout-links.md) - [List line items for a Checkout Link](https://docs.fluveo.com/api-reference/checkoutlinks/list-line-items-for-a-checkout-link.md) - [Retrieve a Checkout Link](https://docs.fluveo.com/api-reference/checkoutlinks/retrieve-a-checkout-link.md) - [Update a Checkout Link](https://docs.fluveo.com/api-reference/checkoutlinks/update-a-checkout-link.md) - [Create a Checkout Session](https://docs.fluveo.com/api-reference/checkoutsessions/create-a-checkout-session.md) - [Expire a Checkout Session](https://docs.fluveo.com/api-reference/checkoutsessions/expire-a-checkout-session.md): Expires an open checkout session and cancels the associated PaymentIntent. - [List Checkout Sessions](https://docs.fluveo.com/api-reference/checkoutsessions/list-checkout-sessions.md) - [List line items for a Checkout Session](https://docs.fluveo.com/api-reference/checkoutsessions/list-line-items-for-a-checkout-session.md) - [Retrieve a Checkout Session](https://docs.fluveo.com/api-reference/checkoutsessions/retrieve-a-checkout-session.md) - [Customers](https://docs.fluveo.com/api-reference/customers.md): Create and manage customers - [Create a Customer](https://docs.fluveo.com/api-reference/customers/create-a-customer.md) - [List Customers](https://docs.fluveo.com/api-reference/customers/list-customers.md) - [Retrieve a Customer](https://docs.fluveo.com/api-reference/customers/retrieve-a-customer.md) - [Update a Customer](https://docs.fluveo.com/api-reference/customers/update-a-customer.md) - [Disputes](https://docs.fluveo.com/api-reference/disputes.md): Read and manage disputes for payment charges. - [Close a Dispute](https://docs.fluveo.com/api-reference/disputes/close-a-dispute.md) - [List Disputes](https://docs.fluveo.com/api-reference/disputes/list-disputes.md) - [Retrieve a Dispute](https://docs.fluveo.com/api-reference/disputes/retrieve-a-dispute.md) - [Submit Dispute evidence](https://docs.fluveo.com/api-reference/disputes/submit-dispute-evidence.md) - [Events](https://docs.fluveo.com/api-reference/events.md): List and retrieve events - [List Events](https://docs.fluveo.com/api-reference/events/list-events.md) - [Retrieve an Event](https://docs.fluveo.com/api-reference/events/retrieve-an-event.md) - [External Accounts](https://docs.fluveo.com/api-reference/external-accounts.md): Manage bank accounts linked to your merchant account - [Create an external account](https://docs.fluveo.com/api-reference/externalaccounts/create-an-external-account.md): Links a bank account to your merchant account for payouts. - [Delete an external account](https://docs.fluveo.com/api-reference/externalaccounts/delete-an-external-account.md): Removes a bank account from your merchant account. - [List external accounts](https://docs.fluveo.com/api-reference/externalaccounts/list-external-accounts.md): Returns a list of bank accounts linked to your merchant account. - [Retrieve an external account](https://docs.fluveo.com/api-reference/externalaccounts/retrieve-an-external-account.md): Retrieves a bank account linked to your merchant account. - [Invoice Items](https://docs.fluveo.com/api-reference/invoice-items.md): Create and manage line items that make up invoices. - [Create an InvoiceItem](https://docs.fluveo.com/api-reference/invoiceitems/create-an-invoiceitem.md) - [Delete an InvoiceItem](https://docs.fluveo.com/api-reference/invoiceitems/delete-an-invoiceitem.md) - [List InvoiceItems](https://docs.fluveo.com/api-reference/invoiceitems/list-invoiceitems.md) - [Retrieve an InvoiceItem](https://docs.fluveo.com/api-reference/invoiceitems/retrieve-an-invoiceitem.md) - [Update an InvoiceItem](https://docs.fluveo.com/api-reference/invoiceitems/update-an-invoiceitem.md) - [Invoices](https://docs.fluveo.com/api-reference/invoices.md): Create, finalize, and collect payment on invoices. - [Create an Invoice](https://docs.fluveo.com/api-reference/invoices/create-an-invoice.md) - [Delete a draft Invoice](https://docs.fluveo.com/api-reference/invoices/delete-a-draft-invoice.md) - [Finalize an Invoice](https://docs.fluveo.com/api-reference/invoices/finalize-an-invoice.md) - [List Invoices](https://docs.fluveo.com/api-reference/invoices/list-invoices.md) - [Mark an Invoice uncollectible](https://docs.fluveo.com/api-reference/invoices/mark-an-invoice-uncollectible.md) - [Pay an Invoice](https://docs.fluveo.com/api-reference/invoices/pay-an-invoice.md) - [Retrieve an Invoice](https://docs.fluveo.com/api-reference/invoices/retrieve-an-invoice.md) - [Retrieve an upcoming Invoice preview](https://docs.fluveo.com/api-reference/invoices/retrieve-an-upcoming-invoice-preview.md) - [Send a hosted Invoice link](https://docs.fluveo.com/api-reference/invoices/send-a-hosted-invoice-link.md) - [Update a draft Invoice](https://docs.fluveo.com/api-reference/invoices/update-a-draft-invoice.md) - [Void an Invoice](https://docs.fluveo.com/api-reference/invoices/void-an-invoice.md) - [Marketplace](https://docs.fluveo.com/api-reference/marketplace.md): Browse and install marketplace apps - [Browse published apps](https://docs.fluveo.com/api-reference/marketplace/browse-published-apps.md) - [List installed apps](https://docs.fluveo.com/api-reference/marketplace/list-installed-apps.md) - [Retrieve a marketplace app](https://docs.fluveo.com/api-reference/marketplace/retrieve-a-marketplace-app.md) - [Retrieve an installation](https://docs.fluveo.com/api-reference/marketplace/retrieve-an-installation.md) - [Uninstall an app](https://docs.fluveo.com/api-reference/marketplace/uninstall-an-app.md): Uninstalls an app and revokes all associated tokens. - [OAuth](https://docs.fluveo.com/api-reference/oauth.md): OAuth 2.0 token exchange and authorization - [Approve an OAuth authorization request](https://docs.fluveo.com/api-reference/oauth/approve-an-oauth-authorization-request.md): Called by the merchant dashboard when the merchant approves an app. Returns an authorization code. - [Deny an OAuth authorization request](https://docs.fluveo.com/api-reference/oauth/deny-an-oauth-authorization-request.md) - [Exchange an authorization code or refresh token](https://docs.fluveo.com/api-reference/oauth/exchange-an-authorization-code-or-refresh-token.md): Supports grant_type: authorization_code, refresh_token. Authenticate with Basic auth (client_id:client_secret) or pass credentials in the body. - [Revoke an OAuth token](https://docs.fluveo.com/api-reference/oauth/revoke-an-oauth-token.md) - [Payment Intents](https://docs.fluveo.com/api-reference/payment-intents.md): Create and manage payment intents - [Payment Methods](https://docs.fluveo.com/api-reference/payment-methods.md): Attach, list, retrieve, update, and detach saved payment methods. - [Cancel a PaymentIntent](https://docs.fluveo.com/api-reference/paymentintents/cancel-a-paymentintent.md) - [Capture a PaymentIntent](https://docs.fluveo.com/api-reference/paymentintents/capture-a-paymentintent.md) - [Confirm a PaymentIntent](https://docs.fluveo.com/api-reference/paymentintents/confirm-a-paymentintent.md) - [Create a PaymentIntent](https://docs.fluveo.com/api-reference/paymentintents/create-a-paymentintent.md) - [List PaymentIntents](https://docs.fluveo.com/api-reference/paymentintents/list-paymentintents.md) - [Refund a PaymentIntent](https://docs.fluveo.com/api-reference/paymentintents/refund-a-paymentintent.md): Creates a refund for a PaymentIntent. If no amount is specified, the full amount is refunded. - [Retrieve a PaymentIntent](https://docs.fluveo.com/api-reference/paymentintents/retrieve-a-paymentintent.md) - [Attach a PaymentMethod](https://docs.fluveo.com/api-reference/paymentmethods/attach-a-paymentmethod.md) - [Detach a PaymentMethod](https://docs.fluveo.com/api-reference/paymentmethods/detach-a-paymentmethod.md) - [List PaymentMethods](https://docs.fluveo.com/api-reference/paymentmethods/list-paymentmethods.md) - [Retrieve a PaymentMethod](https://docs.fluveo.com/api-reference/paymentmethods/retrieve-a-paymentmethod.md) - [Update a PaymentMethod](https://docs.fluveo.com/api-reference/paymentmethods/update-a-paymentmethod.md) - [Payouts](https://docs.fluveo.com/api-reference/payouts.md): Send funds from your balance to your bank account - [Cancel a payout](https://docs.fluveo.com/api-reference/payouts/cancel-a-payout.md): Cancels a payout. Only payouts with a status of pending can be canceled. - [Create a payout](https://docs.fluveo.com/api-reference/payouts/create-a-payout.md): Sends funds from your balance to your linked bank account. - [List payouts](https://docs.fluveo.com/api-reference/payouts/list-payouts.md): Returns a list of payouts for your merchant account. - [Retrieve a payout](https://docs.fluveo.com/api-reference/payouts/retrieve-a-payout.md): Retrieves the details of an existing payout. - [Retrieve payout schedule](https://docs.fluveo.com/api-reference/payouts/retrieve-payout-schedule.md) - [Update payout schedule](https://docs.fluveo.com/api-reference/payouts/update-payout-schedule.md) - [Prices](https://docs.fluveo.com/api-reference/prices.md): Create and manage prices - [Create a Price](https://docs.fluveo.com/api-reference/prices/create-a-price.md) - [List Prices](https://docs.fluveo.com/api-reference/prices/list-prices.md) - [Retrieve a Price](https://docs.fluveo.com/api-reference/prices/retrieve-a-price.md) - [Update a Price](https://docs.fluveo.com/api-reference/prices/update-a-price.md): Updates the specified price. Only certain fields are modifiable after creation. - [Products](https://docs.fluveo.com/api-reference/products.md): Create and manage products - [Create a Product](https://docs.fluveo.com/api-reference/products/create-a-product.md) - [Delete a Product](https://docs.fluveo.com/api-reference/products/delete-a-product.md): Soft-deletes a product. It will no longer appear in list results. - [List Products](https://docs.fluveo.com/api-reference/products/list-products.md) - [Retrieve a Product](https://docs.fluveo.com/api-reference/products/retrieve-a-product.md) - [Update a Product](https://docs.fluveo.com/api-reference/products/update-a-product.md) - [Refunds](https://docs.fluveo.com/api-reference/refunds.md): Create and manage refunds - [Create a Refund](https://docs.fluveo.com/api-reference/refunds/create-a-refund.md) - [List Refunds](https://docs.fluveo.com/api-reference/refunds/list-refunds.md) - [Retrieve a Refund](https://docs.fluveo.com/api-reference/refunds/retrieve-a-refund.md) - [Reports](https://docs.fluveo.com/api-reference/reports.md): Retrieve financial reports for reconciliation. - [Retrieve balance reconciliation report](https://docs.fluveo.com/api-reference/reports/retrieve-balance-reconciliation-report.md) - [Reserves](https://docs.fluveo.com/api-reference/reserves.md): View held funds and request early reserve release. - [List reserves](https://docs.fluveo.com/api-reference/reserves/list-reserves.md) - [Request reserve release](https://docs.fluveo.com/api-reference/reserves/request-reserve-release.md) - [Settlement](https://docs.fluveo.com/api-reference/settlement.md): View settlement configuration and batch history - [List settlement batches](https://docs.fluveo.com/api-reference/settlement/list-settlement-batches.md): Returns a list of settlement batches for your merchant account. - [Retrieve a settlement batch](https://docs.fluveo.com/api-reference/settlement/retrieve-a-settlement-batch.md): Retrieves the details of a settlement batch. - [Retrieve settlement config](https://docs.fluveo.com/api-reference/settlement/retrieve-settlement-config.md): Returns the settlement configuration for your merchant account, including fee model, payout schedule, and reserve settings. - [Setup Intents](https://docs.fluveo.com/api-reference/setup-intents.md): Save a customer's card for future subscription or invoice payments. - [Cancel a SetupIntent](https://docs.fluveo.com/api-reference/setupintents/cancel-a-setupintent.md) - [Confirm a SetupIntent](https://docs.fluveo.com/api-reference/setupintents/confirm-a-setupintent.md) - [Create a SetupIntent](https://docs.fluveo.com/api-reference/setupintents/create-a-setupintent.md) - [List SetupIntents](https://docs.fluveo.com/api-reference/setupintents/list-setupintents.md) - [Retrieve a SetupIntent](https://docs.fluveo.com/api-reference/setupintents/retrieve-a-setupintent.md) - [Subscription Items](https://docs.fluveo.com/api-reference/subscription-items.md): Manage the prices and quantities attached to a subscription. - [Create a SubscriptionItem](https://docs.fluveo.com/api-reference/subscriptionitems/create-a-subscriptionitem.md) - [Delete a SubscriptionItem](https://docs.fluveo.com/api-reference/subscriptionitems/delete-a-subscriptionitem.md) - [List SubscriptionItems](https://docs.fluveo.com/api-reference/subscriptionitems/list-subscriptionitems.md) - [Retrieve a SubscriptionItem](https://docs.fluveo.com/api-reference/subscriptionitems/retrieve-a-subscriptionitem.md) - [Update a SubscriptionItem](https://docs.fluveo.com/api-reference/subscriptionitems/update-a-subscriptionitem.md) - [Subscriptions](https://docs.fluveo.com/api-reference/subscriptions.md): Create and manage recurring billing subscriptions. - [Cancel a Subscription](https://docs.fluveo.com/api-reference/subscriptions/cancel-a-subscription.md) - [Create a Subscription](https://docs.fluveo.com/api-reference/subscriptions/create-a-subscription.md) - [List Subscriptions](https://docs.fluveo.com/api-reference/subscriptions/list-subscriptions.md) - [Pause a Subscription](https://docs.fluveo.com/api-reference/subscriptions/pause-a-subscription.md) - [Resume a Subscription](https://docs.fluveo.com/api-reference/subscriptions/resume-a-subscription.md) - [Retrieve a Subscription](https://docs.fluveo.com/api-reference/subscriptions/retrieve-a-subscription.md) - [Update a Subscription](https://docs.fluveo.com/api-reference/subscriptions/update-a-subscription.md) - [Transfers](https://docs.fluveo.com/api-reference/transfers.md): View platform transfers between accounts - [List transfers](https://docs.fluveo.com/api-reference/transfers/list-transfers.md): Returns a list of platform transfers for your merchant account. - [Retrieve a transfer](https://docs.fluveo.com/api-reference/transfers/retrieve-a-transfer.md): Retrieves the details of an existing transfer. - [Create a WebhookEndpoint](https://docs.fluveo.com/api-reference/webhookendpoints/create-a-webhookendpoint.md) - [Delete a WebhookEndpoint](https://docs.fluveo.com/api-reference/webhookendpoints/delete-a-webhookendpoint.md) - [List WebhookEndpoints](https://docs.fluveo.com/api-reference/webhookendpoints/list-webhookendpoints.md) - [Retrieve a WebhookEndpoint](https://docs.fluveo.com/api-reference/webhookendpoints/retrieve-a-webhookendpoint.md): Retrieves the webhook endpoint. The secret is masked in the response. - [Update a WebhookEndpoint](https://docs.fluveo.com/api-reference/webhookendpoints/update-a-webhookendpoint.md) - [Webhook Endpoints](https://docs.fluveo.com/api-reference/webhooks.md): Create and manage webhook endpoints - [Authentication](https://docs.fluveo.com/authentication.md): Learn how API key types work, how to authenticate requests using HTTP Basic Auth, and the difference between test and live mode. - [Changelog](https://docs.fluveo.com/changelog.md): API changes, new features, and deprecation notices. - [Card Decline Codes](https://docs.fluveo.com/errors/decline-codes.md): Reference for card decline codes returned when a payment fails. - [Error Codes](https://docs.fluveo.com/errors/error-codes.md): Complete reference of API error codes - [Accept a Payment](https://docs.fluveo.com/guides/accept-a-payment.md): Create a PaymentIntent, confirm it with a payment method, and handle the result. Covers automatic and manual capture. - [Checkout Links](https://docs.fluveo.com/guides/checkout-links.md): Create shareable, no-code payment links. Customize after-completion behavior, set restrictions, enable promo codes, and deactivate links. - [Checkout Sessions](https://docs.fluveo.com/guides/checkout-sessions.md): Deep dive into Checkout Sessions — payment vs order mode, UI modes, line items, customer handling, and session expiration. - [Error Handling](https://docs.fluveo.com/guides/error-handling.md): Understand the API error response format, error types, common error codes, and how to handle them in your integration. - [Expanding Objects](https://docs.fluveo.com/guides/expand.md): Use the expand parameter to include full nested objects in API responses instead of just their IDs. - [Idempotency](https://docs.fluveo.com/guides/idempotency.md): Use idempotency keys to safely retry API requests without accidentally duplicating operations like charges or refunds. - [Live Mode & Test Mode](https://docs.fluveo.com/guides/livemode.md): Understand how test and live environments are fully isolated, and how the livemode field helps you distinguish between them. - [Metadata](https://docs.fluveo.com/guides/metadata.md): Attach custom key-value data to API objects using metadata. Useful for storing external IDs, internal references, and other structured information. - [Pagination](https://docs.fluveo.com/guides/pagination.md): Navigate large result sets using cursor-based pagination with limit, starting_after, and ending_before parameters. - [Payouts & Settlement](https://docs.fluveo.com/guides/payouts.md): How funds flow from your balance to your bank account - [One-time PIX payments (BRL)](https://docs.fluveo.com/guides/pix-one-time.md): Accept a single PIX payment via Fluveo's StarkBank PSP routing. - [Rate Limiting](https://docs.fluveo.com/guides/rate-limiting.md): Understand API rate limits, response headers, and how to handle 429 responses. - [Recurring billing](https://docs.fluveo.com/guides/recurring-billing.md): End-to-end recipe for card-recurring subscriptions on Fluveo. - [Sell Products Online](https://docs.fluveo.com/guides/sell-products.md): Set up your product catalog, create prices, and start accepting payments with Checkout Sessions or Checkout Links. - [Testing](https://docs.fluveo.com/guides/testing.md): Test your integration using test mode API keys and simulated payment methods. - [API Versioning](https://docs.fluveo.com/guides/versioning.md): Control which version of the API your requests use via the X-API-Version header. Understand how version defaults work and how to handle breaking changes. - [Webhooks](https://docs.fluveo.com/guides/webhooks.md): Receive real-time notifications when events happen in your account. - [Fluveo Documentation](https://docs.fluveo.com/index.md): Payments and commerce APIs for the modern internet. - [App Review Guidelines](https://docs.fluveo.com/marketplace/app-review.md): Understand the review process, required fields, common rejection reasons, and how to update published apps. - [Build an App](https://docs.fluveo.com/marketplace/build-an-app.md): Register your app, configure OAuth credentials, set scopes and redirect URIs, and submit for marketplace review. - [OAuth Flow](https://docs.fluveo.com/marketplace/oauth-flow.md): Implement the full OAuth 2.0 authorization code flow: redirect, grant, code exchange, token refresh, and revocation. - [Marketplace Overview](https://docs.fluveo.com/marketplace/overview.md): Build and distribute apps that extend Fluveo for merchants. - [OAuth Scopes](https://docs.fluveo.com/marketplace/scopes.md): Complete reference of all OAuth scopes available for marketplace apps. - [Quickstart](https://docs.fluveo.com/quickstart.md): Accept your first payment in under 10 minutes. This guide walks you through creating a PaymentIntent, confirming it, and checking its status. - [Webhook Event Types](https://docs.fluveo.com/webhooks/event-types.md): All webhook event types with example payloads ## OpenAPI Specs - [openapi](https://docs.fluveo.com/openapi.json)