Balance and transfers

Composition of the balance, reconciliation and transfer of the amounts received.

The amounts of confirmed transactions are credited to the account balance and may be transferred to the payee. This page describes the composition of the balance, the reconciliation instruments and the transfer operation.

​

Composition of the balance

The GET /balance operation returns the account balance, broken down into three components, all in cents.

Field	Description
available	Amount available for transfer.
receivable	Amount in the holding period, to be released in the following days.
reserved	Amount held as reserve.

Amounts blocked as a result of an infraction are not part of the available balance and are listed by the GET /blocked-amounts operation, described in Infractions and MED.

​

Fees and settlement periods

The GET /fees operation returns the terms contracted by the account for each payment method.

Field	Description
receiveDays	Period, in days, between confirmation of the payment and the credit to the balance.
feeFixed	Fixed fee per transaction, in cents.
feePercentage	Percentage fee, in hundredths of a percent. The value 299 corresponds to 2.99%.
reserve	Terms of the reserve: percentage held and release period.

​

Statement and reconciliation

The GET /balance-operations operation lists the entries that changed the balance, including transactions, fees, reserves, refunds and transfers. The operation accepts the following filters.

Parameter	Description
from, to	Period, in ISO 8601.
type	Entry type.
direction	Nature of the entry: credit or debit.

Periodic reconciliation of the statement against the integrator’s records, based on the transaction identifiers, is recommended.

​

Transfer

The POST /transfers operation requests the transfer of the available balance to the bank account registered for the account.

curl -X POST https://api.fincle.com.br/transfers \
  -H "Authorization: Bearer $FINCLE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1500000,
    "idempotencyKey": "b3d2f6a1-8c47-4e59-a1d0-6f7e2c9b4a35",
    "description": "Weekly settlement transfer"
  }'

The idempotencyKey field is required. Repeating the request with the same key returns the transfer already recorded, without a new movement of funds.

The transfer is always credited to the registered bank account. The pixKey field of the request does not define the destination.

The transfer may be settled in more than one part when the balance has distinct origins, which is why the response contains a list of transfers in the transfers field. A 403 response indicates that the account is not enabled to transfer.

​

Monitoring

The GET /transfers/{transferId} operation returns the current status of the transfer, the fee, the net amount and, after settlement, the Pix end-to-end identifier. Status changes are communicated by the transfer_created, transfer_updated, transfer_completed and transfer_canceled events.

Status	Description
pending, queued, processing	Transfer recorded, being processed.
pending_analysis, manual_analysis	Transfer submitted for analysis.
completed	Transfer settled.
refused, banking_refused	Transfer refused. The message field states the reason.
canceled	Transfer canceled.
error, banking_error, failed	Processing failure.