> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fincle.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Request transfer

> Requests the transfer of the available balance to the bank account registered for the account. The `idempotencyKey` field is required.



## OpenAPI

````yaml /openapi.yaml post /transfers
openapi: 3.0.3
info:
  title: Fincle API
  version: 1.0.0
  description: >-
    Fincle payments API: charges by Pix, credit card and boleto, subscriptions,
    transactions, refunds, infractions, notifications and transfers.
servers:
  - url: https://api.fincle.com.br
    description: Production server
security: []
tags:
  - name: Authentication
    description: Issuance of the access token from the API key.
  - name: Charges
    description: Creation of charges by Pix, credit card and boleto.
  - name: Subscriptions
    description: Recurring billing on credit card.
  - name: Transactions
    description: Retrieval and refund of transactions.
  - name: Refunds
    description: Refund requests submitted by payers.
  - name: Infractions and MED
    description: Pix infraction reports and the amounts blocked as a result.
  - name: Webhooks
    description: Registration of notification endpoints and tracking of deliveries.
  - name: Balance and transfers
    description: Balance, statement, fees and transfer of the amounts received.
paths:
  /transfers:
    post:
      tags:
        - Balance and transfers
      summary: Request transfer
      description: >-
        Requests the transfer of the available balance to the bank account
        registered for the account. The `idempotencyKey` field is required.
      operationId: createTransfer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  exclusiveMinimum: true
                  minimum: 0
                  description: Gross amount of the transfer, in cents (R$ 500.00 = 50000).
                idempotencyKey:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: >-
                    Unique key of this request. Resending with the same key
                    returns the transfer already created, without duplication.
                pixKey:
                  type: string
                  minLength: 1
                  description: >-
                    Does not define the destination. The transfer is always
                    credited to the bank account registered for the account.
                description:
                  type: string
                  maxLength: 255
                  description: Free-text description recorded on the transfer.
              required:
                - amount
                - idempotencyKey
              additionalProperties: false
            example:
              amount: 50000
              idempotencyKey: b3d2f6a1-8c47-4e59-a1d0-6f7e2c9b4a35
              pixKey: '27481396000192'
              description: Weekly settlement transfer
      responses:
        '201':
          description: Transfer requested.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `true` in a successful response.
                  data:
                    type: object
                    properties:
                      requestedAmount:
                        type: integer
                        description: Total amount requested in this call, in cents.
                      transfers:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Transfer identifier.
                            status:
                              type: string
                              enum:
                                - pending
                                - queued
                                - processing
                                - pending_analysis
                                - banking_processing
                                - banking_refused
                                - banking_error
                                - manual_analysis
                                - canceled
                                - refused
                                - completed
                                - error
                                - reserved
                                - dispatched
                                - failed
                              description: >-
                                Current status of the transfer in the payment
                                workflow.
                            amount:
                              type: integer
                              description: Gross amount requested, in cents.
                            fees:
                              type: integer
                              description: Fee charged for the transfer, in cents.
                            netAmount:
                              type: integer
                              description: >-
                                Amount credited to the destination account, in
                                cents (gross minus fee).
                            pixKey:
                              type: string
                              description: >-
                                Destination Pix key, or `TED` when settlement is
                                by bank transfer.
                            method:
                              type: string
                              enum:
                                - manual
                                - baas
                              description: >-
                                How the transfer is settled: automatic (`baas`)
                                or `manual`.
                            type:
                              type: string
                              enum:
                                - send_analysis
                                - automatic
                              description: >-
                                Whether the transfer is approved automatically
                                or sent for analysis.
                            requestSource:
                              type: string
                              enum:
                                - api
                                - app
                              description: 'Source of the request: `api` or `app`.'
                            source:
                              type: string
                              enum:
                                - internal
                                - fastpay
                                - pagarme
                                - uvvipay
                              description: Balance from which the funds were drawn.
                            externalId:
                              type: string
                              nullable: true
                              description: >-
                                Transfer identifier at the banking partner, once
                                available.
                            endToEndId:
                              type: string
                              nullable: true
                              description: >-
                                Pix end-to-end identifier, available after
                                settlement.
                            description:
                              type: string
                              nullable: true
                              description: Description of the transfer.
                            message:
                              type: string
                              nullable: true
                              description: >-
                                Reason for the refusal or latest processing
                                notice.
                            createdAt:
                              type: string
                              format: date-time
                              description: Time at which the transfer was requested.
                            updatedAt:
                              type: string
                              description: Time of the last change.
                              format: date-time
                            processedAt:
                              type: string
                              format: date-time
                              nullable: true
                              description: Time at which the transfer was processed.
                          required:
                            - id
                            - status
                            - amount
                            - fees
                            - netAmount
                            - pixKey
                            - method
                            - type
                            - requestSource
                            - source
                            - externalId
                            - endToEndId
                            - description
                            - message
                            - createdAt
                            - updatedAt
                            - processedAt
                          additionalProperties: false
                        description: Transfers created by this request.
                    required:
                      - requestedAmount
                      - transfers
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Transfer requested.
              example:
                success: true
                data:
                  requestedAmount: 50000
                  transfers:
                    - id: clx9k1p7t0002qz0a5c6d7e8f
                      status: pending_analysis
                      amount: 50000
                      fees: 350
                      netAmount: 49650
                      pixKey: '27481396000192'
                      method: manual
                      type: send_analysis
                      requestSource: api
                      source: internal
                      externalId: null
                      endToEndId: null
                      description: Weekly settlement transfer
                      message: null
                      createdAt: '2026-09-11T18:05:12.000Z'
                      updatedAt: '2026-09-11T18:05:12.000Z'
                      processedAt: null
        '400':
          description: The request is well formed, but a business rule rejected it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: The request is well formed, but a business rule rejected it.
              example:
                success: false
                message: >-
                  Não foi possível concluir: uma regra de negócio recusou os
                  dados enviados.
        '401':
          description: Token missing, invalid, expired or belonging to a blocked account.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Token missing, invalid, expired or belonging to a blocked
                  account.
              example:
                success: false
                message: Token inválido ou expirado
        '403':
          description: The account is not enabled to transfer under its current settings.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  The account is not enabled to transfer under its current
                  settings.
              example:
                success: false
                message: Acesso negado para esta empresa.
        '422':
          description: The request did not pass schema validation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: The request did not pass schema validation.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Too many requests: the limit is 1000 requests per minute per source
            IP. Wait the number of seconds given in the `retry-after` header and
            retry with exponential backoff.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Too many requests: the limit is 1000 requests per minute per
                  source IP. Wait the number of seconds given in the
                  `retry-after` header and retry with exponential backoff.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Internal failure while processing the request. Retry; if it
            persists, open a support ticket stating the time and the route.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Internal failure while processing the request. Retry; if it
                  persists, open a support ticket stating the time and the
                  route.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Seconds to wait before repeating the request.
      schema:
        type: integer
    x-ratelimit-limit:
      description: >-
        Maximum number of requests in the window (1000). Present in every
        response.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Number of requests still available in the current window. Present in
        every response.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Seconds until the window counter resets. Present in every response.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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