# FastPay

## Docs

- [Início Rápido](https://fastpay-mintlify-9618a7a2.mintlify.site/index.md): Primeiros passos para integrar a solução de pagamentos da FastPay.
- [Autenticação](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/autenticacao.md): Como obter e usar suas credenciais (Basic Auth) na FastPay API.
- [Assinaturas](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/assinaturas.md): Planos e cobrança recorrente com a FastPay API.
- [Fast Connect](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/fast-connect.md): Onboarding e gestão de submerchants via Fast Connect.
- [Cálculo de split com taxa do subadquirente](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/fast-connect/calculo-split.md): Como calcular o percentual de split a informar à Fastpay quando o cliente cobra uma taxa própria sobre o valor bruto da venda.
- [Apple Pay](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/apple-pay.md): Integração de pagamentos com Apple Pay na FastPay.
- [3D Secure SDK](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/three-ds-sdk.md): Autenticação 3DS para transações com cartão de crédito.
- [Estorno (Refund)](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/estorno.md): Como solicitar o estorno total de uma cobrança via API.
- [Bloqueio de Transação](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/bloqueio-de-transacao.md): Fluxo de bloqueio por chargeback ou MED (Medida Cautelar) e processo de disputa.
- [Melhor Envio](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/melhor-envio.md): Cálculo de frete ao vivo no checkout de links de pagamento via Melhor Envio.
- [Webhooks](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/webhooks/index.md): Receba notificações em tempo real sobre mudanças de status das transações.
- [Webhooks de Cobrança](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/webhooks/charge.md): Eventos de charge: created, pending, paid, refunded e updated.
- [Webhooks de Payout](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/webhooks/payout.md): Eventos de saque/payout enviados pela FastPay.
- [Webhooks de Assinatura](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/webhooks/subscription.md): Eventos de assinatura recorrente enviados pela FastPay.
- [Webhooks de Aprovação de Conta](https://fastpay-mintlify-9618a7a2.mintlify.site/guias/webhooks/conta.md): Notificações de mudança de status de aprovação de subconta/submerchant.
- [Get all charges](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/charges/get-all-charges.md): Returns a paginated list of charges filtered by the provided criteria.
- [Create a new charge](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/charges/create-a-new-charge.md): Creates a payment charge for a merchant with the specified amount, currency, and payment method.
- [Request a refund](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/charges/request-a-refund.md): Requests a **full refund** (estorno) for a charge that has `paid` status. Partial refunds are not supported — the entire charge amount is reversed.
- [Resend webhook for a test charge (sandbox)](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/charges/resend-webhook-for-a-test-charge-sandbox.md): Resends a webhook for a **test charge** with a simulated status. Use this in sandbox to test your webhook handler without waiting for real payment events.
- [Get merchant wallets](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/wallets/get-merchant-wallets.md): Returns a list of wallets with balances for the specified merchant, optionally filtered by currency.
- [Get available payment methods](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/payment-methods/get-available-payment-methods.md): Returns a list of payment methods available for the merchant, optionally filtered by currency.
- [Get all submerchants](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/get-all-submerchants.md): Get all submerchants related to MerchantMaster
- [Create a new Submerchant](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/create-a-new-submerchant.md): Creates a submerchant FastPay account linked to the MerchantMaster.
- [Get one submerchant](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/get-one-submerchant.md): Get one specific submerchant related to MerchantMaster
- [Upload submerchant documents](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/upload-submerchant-documents.md): Upload submerchant documents to approval
- [Get submerchant's API Keys](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/get-submerchants-api-keys.md): Get API keys from specified SubMerchant
- [Get sub-account fees and registration info](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/get-sub-account-fees-and-registration-info.md): Retorna as taxas (transacionais `tx_spread` e de antecipação `anticipation`), a razão social e o CNPJ de uma subconta do Fast Connect.
- [Create payout request](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/create-payout-request.md): Creates a payout request for a submerchant in the Fast Connect context.
- [Get payout request by ID](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/get-payout-request-by-id.md): Returns the complete details of a specific payout request.
- [List payout requests](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/fastconnect/list-payout-requests.md): Lists all payout requests with support for filters and pagination.
- [List customers](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/customers/list-customers.md): Returns a paginated list of customers filtered by the provided criteria.
- [Create a new customer](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/customers/create-a-new-customer.md): Creates a new customer in the system.
- [Get customer by ID](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/customers/get-customer-by-id.md): Returns details of a specific customer.
- [Update customer](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/customers/update-customer.md): Updates an existing customer. Document ID and type cannot be changed after creation.
- [Delete customer](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/customers/delete-customer.md): Removes a customer from the system (soft delete).
- [List subscription plans](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscription-plans/list-subscription-plans.md): Returns a paginated list of subscription plans.
- [Create a subscription plan](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscription-plans/create-a-subscription-plan.md): Creates a new recurring subscription plan.
- [Get subscription plan by ID](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscription-plans/get-subscription-plan-by-id.md): Returns details of a specific subscription plan.
- [Update subscription plan](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscription-plans/update-subscription-plan.md): Updates an existing subscription plan. Changes do NOT affect existing subscriptions, only new subscriptions will use the updated values.
- [Upload plan image](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscription-plans/upload-plan-image.md): Uploads an image for the subscription plan.
- [Update plan status](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscription-plans/update-plan-status.md): Activates or deactivates a subscription plan. If the plan has active subscriptions and is being deactivated, a confirmation token will be returned.
- [Confirm plan deactivation](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscription-plans/confirm-plan-deactivation.md): Confirms the deactivation of a plan that has active subscriptions.
- [List subscriptions](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscriptions/list-subscriptions.md): Returns a paginated list of subscriptions.
- [Create a subscription (Checkout)](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscriptions/create-a-subscription-checkout.md): Creates a new subscription linked to a plan.
- [Get subscription by ID](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscriptions/get-subscription-by-id.md): Returns complete details of a subscription, including charge history.
- [Update subscription](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscriptions/update-subscription.md): Updates data of an active subscription.
- [Cancel subscription](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/subscriptions/cancel-subscription.md): Cancels a subscription. Has regret period logic (up to 7 days after creation).
- [List cards](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/cards/list-cards.md): Returns a list of registered cards for the authenticated merchant/customer.
- [Register a card](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/cards/register-a-card.md): Registers a new credit card for a customer. The card is stored securely in the token vault and can be used for recurring charges.
- [Get card by ID](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/cards/get-card-by-id.md): Returns details of a specific card.
- [Delete a card](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/cards/delete-a-card.md): Deletes a registered card. The card is removed from the PSP and the token is revoked from the vault.
- [Activate a card](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/cards/activate-a-card.md): Activates a card that is in `pending_validation` status.
- [Initiate 3DS authentication](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/3d-secure/initiate-3ds-authentication.md): Creates a 3D Secure authentication object. The response may include `fingerprintingUrl` (render in a hidden iframe and listen for postMessage) or `challengeUrl` (render in a visible iframe for user challenge).
- [Submit 3DS authentication](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/3d-secure/submit-3ds-authentication.md): Submits a 3DS authentication after optional fingerprinting. Pass `fingerprintingResult` if you received it from the iframe postMessage. Returns updated status and may include `challengeUrl` if a challenge is required.
- [Cancel 3DS authentication](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/3d-secure/cancel-3ds-authentication.md): Cancels a 3DS authentication that is in `requires_submission` or `requires_challenge` status.
- [Get 3DS challenge result](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/3d-secure/get-3ds-challenge-result.md): Retrieves the final result of a 3DS challenge, including the cryptogram and transaction IDs needed to complete the charge via POST /v1/charges with the `threeDS` payment method field.
- [Resume charge after managed 3DS authentication](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/3d-secure/resume-charge-after-managed-3ds-authentication.md): Called by the 3DS micro-frontend (or your own integration) after the buyer completes the managed 3DS authentication. Processes the charge using the provided 3DS result and fires postback/webhook events.
- [Save Melhor Envio OAuth credentials](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/melhor-envio/save-melhor-envio-oauth-credentials.md): Stores the Client ID and Client Secret of the merchant's own Melhor Envio app. The Client Secret is encrypted at rest and never returned in API responses.
- [Build Melhor Envio OAuth authorize URL](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/melhor-envio/build-melhor-envio-oauth-authorize-url.md): Returns the URL the merchant must be redirected to in order to authorize the FastPay integration on Melhor Envio. The merchant must have already saved credentials via `POST /v1/melhor-envio/credentials`.
- [Melhor Envio OAuth callback](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/melhor-envio/melhor-envio-oauth-callback.md): Endpoint Melhor Envio redirects to after the merchant authorizes the integration. Exchanges the `code` for access/refresh tokens, persists them encrypted, and redirects back to the merchant dashboard.
- [Get Melhor Envio integration status](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/melhor-envio/get-melhor-envio-integration-status.md)
- [List available Melhor Envio services](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/melhor-envio/list-available-melhor-envio-services.md): Returns all shipping services (carriers) available for the connected Melhor Envio account. Use the returned IDs to populate `enabledServices` via `PUT /v1/melhor-envio/settings`.
- [Update Melhor Envio settings](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/melhor-envio/update-melhor-envio-settings.md): Saves the origin postal code and the list of enabled service IDs. Only services in `enabledServices` are offered to buyers at checkout, even if Melhor Envio returns additional options.
- [Disconnect Melhor Envio](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/melhor-envio/disconnect-melhor-envio.md): Marks the merchant's Melhor Envio integration as `inactive`. Existing payment links keep working until they are edited, but new freight quotes will fail until a fresh connection is established.
- [Quote live freight for a payment link checkout](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/payment-links/quote-live-freight-for-a-payment-link-checkout.md): Public endpoint called by the payment link checkout to compute live freight options for a destination postal code. Requires the link to be configured with freight mode `checkout`, currency `BRL`, and at least one physical product with dimensions and weight.
- [Check freight tool availability for a merchant](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/payment-links/check-freight-tool-availability-for-a-merchant.md): Indicates whether the merchant has any active freight integration (currently Melhor Envio). Used by the dashboard to enable the "Cálculo no checkout" freight mode when creating payment links.

## OpenAPI Specs

- [openapi](https://fastpay-mintlify-9618a7a2.mintlify.site/api-reference/openapi.yaml)