# Fincle

- [Overview](https://fincle.mintlify.app/index.md): Scope, architecture and conventions of the Fincle payments API.
- [Quickstart](https://fincle.mintlify.app/quickstart.md): Minimum sequence to create a Pix charge and confirm the payment.
- [Authentication](https://fincle.mintlify.app/guides/authentication.md): Issuance and use of the access token.
- [API conventions](https://fincle.mintlify.app/guides/conventions.md): Message format, idempotency, pagination, limits and error handling.
- [Security and data protection](https://fincle.mintlify.app/guides/security.md): Security requirements of the integration and processing of personal data.
- [Transaction lifecycle](https://fincle.mintlify.app/guides/transaction-lifecycle.md): Statuses of a transaction, permitted transitions and associated events.
- [Pix](https://fincle.mintlify.app/guides/pix.md): Creation of immediate and due-date Pix charges.
- [Credit card](https://fincle.mintlify.app/guides/card.md): Tokenization, creation of the charge and handling of declines.
- [Boleto](https://fincle.mintlify.app/guides/boleto.md): Issuance of boletos and tracking of clearing.
- [Subscriptions](https://fincle.mintlify.app/guides/subscriptions.md): Recurring billing on credit card, with renewal managed by the platform.
- [Webhooks](https://fincle.mintlify.app/guides/webhooks.md): Asynchronous notification of events to the integrator's system.
- [Refunds](https://fincle.mintlify.app/guides/refunds.md): Return of amounts to the payer and handling of refund requests.
- [Infractions and MED](https://fincle.mintlify.app/guides/infractions-and-med.md): Effects of Pix infraction reports on the transaction and the balance.
- [Balance and transfers](https://fincle.mintlify.app/guides/balance-and-transfers.md): Composition of the balance, reconciliation and transfer of the amounts received.
- [Regulatory references](https://fincle.mintlify.app/guides/regulatory-references.md): Laws, regulations and technical standards relating to the documented operations.
- [Glossary](https://fincle.mintlify.app/guides/glossary.md): Definitions of the terms used in this documentation.
- [Issue access token](https://fincle.mintlify.app/api-reference/authentication/issue-access-token.md): Issues the access token from the API key, using HTTP Basic authentication. The token lifetime is given in `expiresIn`, in milliseconds.
- [Create immediate Pix charge](https://fincle.mintlify.app/api-reference/charges/create-immediate-pix-charge.md): Creates an immediate Pix charge and returns the BR Code as text (`pix.emv`) and as an image (`pix.qrCode`).
- [Create Pix charge with due date](https://fincle.mintlify.app/api-reference/charges/create-pix-charge-with-due-date.md): Creates a Pix charge with a due date, with optional fine, interest, discount and rebate.
- [Tokenize card](https://fincle.mintlify.app/api-reference/charges/tokenize-card.md): Converts card data into a token, to be sent in `card.cardToken` when creating the charge.
- [Create card charge](https://fincle.mintlify.app/api-reference/charges/create-card-charge.md): Creates a credit card charge. The response is `200` for both authorized and declined charges, and the outcome is given in `data.status`.
- [Issue boleto](https://fincle.mintlify.app/api-reference/charges/issue-boleto.md): Issues a boleto and returns its viewing URL, barcode, digitable line and due date.
- [List subscriptions](https://fincle.mintlify.app/api-reference/subscriptions/list-subscriptions.md): Lists the subscriptions of the account, with consolidated indicators in `stats`.
- [Start subscription](https://fincle.mintlify.app/api-reference/subscriptions/start-subscription.md): Starts a credit card subscription from a plan configured on the account. The subscription is created only if the first charge is authorized.
- [Retrieve subscription](https://fincle.mintlify.app/api-reference/subscriptions/retrieve-subscription.md): Returns a subscription of the account, with its status and next charge date.
- [Cancel subscription](https://fincle.mintlify.app/api-reference/subscriptions/cancel-subscription.md): Cancels a subscription. No further charge is made, and amounts already paid are not refunded.
- [List transactions](https://fincle.mintlify.app/api-reference/transactions/list-transactions.md): Lists the transactions of the account, filtered by status, payment method, period and payer. Pagination is offset-based (`offset`).
- [Retrieve transaction](https://fincle.mintlify.app/api-reference/transactions/retrieve-transaction.md): Returns a transaction of the account. The `data` field is `null` when the transaction does not exist or belongs to another account.
- [Refund transaction](https://fincle.mintlify.app/api-reference/transactions/refund-transaction.md): Refunds in full a transaction in the `paid` status. Transactions paid by boleto cannot be refunded.
- [List refund requests](https://fincle.mintlify.app/api-reference/refunds/list-refund-requests.md): Lists the refund requests submitted by payers.
- [Approve refund request](https://fincle.mintlify.app/api-reference/refunds/approve-refund-request.md): Approves a pending refund request. The `refundChannel` field states how the refund is executed.
- [Reject refund request](https://fincle.mintlify.app/api-reference/refunds/reject-refund-request.md): Rejects a pending refund request, recording the justification.
- [List infractions](https://fincle.mintlify.app/api-reference/infractions-and-med/list-infractions.md): Lists the infractions filed against transactions of the account, with the disputed amount and the outcome of the analysis.
- [List blocked amounts](https://fincle.mintlify.app/api-reference/infractions-and-med/list-blocked-amounts.md): Lists the amounts blocked on the account, with the reason and the originating infraction.
- [List webhooks](https://fincle.mintlify.app/api-reference/webhooks/list-webhooks.md): Lists the notification endpoints registered on the account.
- [Register webhook](https://fincle.mintlify.app/api-reference/webhooks/register-webhook.md): Registers a notification endpoint for the selected events. The URL is verified at registration.
- [Retrieve webhook](https://fincle.mintlify.app/api-reference/webhooks/retrieve-webhook.md): Returns a notification endpoint of the account.
- [Update webhook](https://fincle.mintlify.app/api-reference/webhooks/update-webhook.md): Replaces the configuration of a notification endpoint.
- [Delete webhook](https://fincle.mintlify.app/api-reference/webhooks/delete-webhook.md): Deletes a notification endpoint.
- [Test webhook](https://fincle.mintlify.app/api-reference/webhooks/test-webhook.md): Sends test notifications, with fictitious data, and returns the HTTP status returned by the endpoint.
- [List notification deliveries](https://fincle.mintlify.app/api-reference/webhooks/list-notification-deliveries.md): Lists notification delivery attempts, with the event, status and destination.
- [Retrieve notification delivery](https://fincle.mintlify.app/api-reference/webhooks/retrieve-notification-delivery.md): Returns the body sent and the endpoint's response for each delivery attempt.
- [Resend notification](https://fincle.mintlify.app/api-reference/webhooks/resend-notification.md): Requests redelivery of a notification whose delivery failed.
- [Retrieve balance](https://fincle.mintlify.app/api-reference/balance-and-transfers/retrieve-balance.md): Returns the account balance, broken down into available, receivable and reserved, in cents.
- [List statement entries](https://fincle.mintlify.app/api-reference/balance-and-transfers/list-statement-entries.md): Lists the entries that changed the balance, for reconciliation purposes.
- [Retrieve account fees](https://fincle.mintlify.app/api-reference/balance-and-transfers/retrieve-account-fees.md): Returns the fees and settlement periods contracted for each payment method.
- [List transfers](https://fincle.mintlify.app/api-reference/balance-and-transfers/list-transfers.md): Lists the transfers requested by the account.
- [Request transfer](https://fincle.mintlify.app/api-reference/balance-and-transfers/request-transfer.md): Requests the transfer of the available balance to the bank account registered for the account. The `idempotencyKey` field is required.
- [Retrieve transfer](https://fincle.mintlify.app/api-reference/balance-and-transfers/retrieve-transfer.md): Returns a transfer of the account, with its status, fee and net amount.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.