Skip to main content
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 /v1/balance operation returns the account balance, broken down into three components, all in cents. Amounts blocked as a result of an infraction are not part of the available balance and are listed by the GET /v1/blocked-amounts operation, described in Infractions and MED.

Fees and settlement periods

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

Statement and reconciliation

The GET /v1/balance-operations operation lists the entries that changed the balance, including transactions, fees, reserves, refunds and transfers. The operation accepts the following filters. Periodic reconciliation of the statement against the integrator’s records, based on the transaction identifiers, is recommended.

Transfer

The POST /v1/transfers operation requests the transfer of the available balance to the bank account registered for the account.
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 /v1/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.