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

# Criar conversão de câmbio em massa

Use a API de Câmbio em Massa para converter fundos com eficiência entre suas próprias contas multimoeda dentro do mesmo país. Isso é ideal para empresas que gerenciam operações internacionais e querem otimizar sua tesouraria interna.

> **Importante**
>
> * `account.debited.amount`: O valor a ser debitado da conta de origem.
> * `account.credited.amount`: O valor a ser creditado na conta de destino.
>   O valor do campo informado deve ser maior que 0.

> [!NOTE]
>
> **Deseja fixar uma taxa de câmbio antes de executar a transação?**
>
> Use a [API de Cotação de Câmbio](https://docs.localpayment.com/pt-br/reference/currency-exchange-quote.md) para gerar uma cotação de taxa para o par de moedas. A resposta inclui um `exchangeRateToken`; informe-o na sua solicitação de conversão de câmbio para fixar essa taxa. A taxa cotada é garantida até o `expirationDate` do token, protegendo você e seu usuário das flutuações do mercado.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/currency-exchange
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/currency-exchange:
    post:
      summary: Criar conversão de câmbio em massa
      operationId: exchange-bulk
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                country:
                  type: string
                  description: O país onde o pagamento será processado.
                externalId:
                  type: string
                  description: >-
                    Um identificador único gerado pelo seu sistema para rastrear
                    a transação (alfanumérico e com hífens). Recomendamos o uso
                    do UUID4 para garantir a unicidade.
                exchangeRateToken:
                  type: string
                  description: >-
                    Token fornecido pelo serviço de câmbio para utilizar uma
                    taxa de câmbio previamente acordada
                account:
                  type: object
                  description: Objeto com os detalhes da conta para a transação.
                  properties:
                    debited:
                      type: object
                      description: Detalhes da conta a ser debitada.
                      properties:
                        currency:
                          type: string
                          description: Moeda da conta debitada.
                        accountNumber:
                          type: string
                          description: Número da conta da qual os fundos serão debitados.
                        amount:
                          type: integer
                          description: >-
                            Valor a ser debitado. Este parâmetro deve ser
                            definido como 0 se o campo `account.credited.amount`
                            for maior que 0.
                      required:
                        - currency
                        - accountNumber
                        - amount
                    credited:
                      type: object
                      description: Detalhes da conta a ser creditada.
                      properties:
                        currency:
                          type: string
                          description: Moeda da conta creditada.
                        accountNumber:
                          type: string
                          description: >-
                            Número da conta para a qual os fundos serão
                            creditados.
                        amount:
                          type: integer
                          description: Valor a ser creditado
                      required:
                        - currency
                        - accountNumber
                  required:
                    - debited
                    - credited
              required:
                - country
                - externalId
                - exchangeRateToken
                - account
              x-examples:
                Example 1:
                  country: ARG
                  currency: EUR
                  externalId: '11112222'
                  exchangeRateToken: ''
                  account:
                    debited:
                      currency: EUR
                      accountNumber: 111.1111.11111111
                      amount: 10
                    credited:
                      currency: USD
                      accountNumber: '{{accountNumber}}'
            examples:
              Without requesting a quote:
                value:
                  country: ARG
                  currency: ARS
                  externalId: 7a9c72a0-7a8e-4f72-b2b3-a04054d3129f
                  account:
                    debited:
                      currency: ARS
                      accountNumber: '{{accountNumber}}'
                      amount: 10000
                    credited:
                      currency: EUR
                      accountNumber: '{{accountNumber}}'
              With quote:
                value:
                  country: ARG
                  externalId: '11112222'
                  exchangeRateToken: af5606b0-1ce7-48f8-ad8a-734934c601ec
                  account:
                    debited:
                      currency: EUR
                      accountNumber: '{{accountNumber}}'
                      amount: 10
                    credited:
                      currency: USD
                      accountNumber: '{{accountNumber}}'
                      amount: 0
              Credited amount set:
                value:
                  country: ARG
                  externalId: '{{externalId}}'
                  exchangeRateToken: ''
                  account:
                    debited:
                      currency: ARS
                      accountNumber: 111.111.1111111
                      amount: 0
                    credited:
                      currency: USD
                      accountNumber: '{{accountNumber}}'
                      amount: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactionType:
                    type: string
                    description: >-
                      Tipo de transação. Para operações de câmbio, este valor é
                      `CurrencyExchange`.
                  externalId:
                    type: string
                    description: >-
                      Um identificador único gerado pelo seu sistema para
                      rastrear a transação (alfanumérico e com hífens).
                      Recomendamos o uso do UUID4 para garantir a unicidade.
                  internalId:
                    type: string
                    description: Identificador de transação da Localpayment.
                  country:
                    type: string
                    description: País onde a transação é processada.
                  currency:
                    type: string
                    description: A moeda original da transação.
                  exchangeRateToken:
                    type: string
                    description: >-
                      Um identificador único usado para rastrear a taxa de
                      câmbio da transação.
                  clientCode:
                    type: string
                    description: >-
                      Um identificador único atribuído ao cliente dentro do
                      sistema Localpayment.
                  creationDate:
                    type: string
                    description: Data e hora em que a transação foi criada.
                  errors:
                    type: array
                    description: >-
                      Uma matriz de objetos de erro, caso tenha ocorrido algum
                      erro durante a transação.
                    items:
                      type: object
                  status:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Um código que representa o status atual da transação.
                      description:
                        type: string
                        description: Uma breve descrição da situação da transação.
                      detail:
                        type: string
                        description: Detalhes adicionais sobre o status da transação.
                  account:
                    type: object
                    properties:
                      debited:
                        type: object
                        properties:
                          currency:
                            type: string
                            description: A moeda da conta debitada.
                          accountNumber:
                            type: string
                            description: O número da conta debitada.
                          amount:
                            type: number
                            description: O valor debitado da conta.
                      credited:
                        type: object
                        properties:
                          currency:
                            type: string
                            description: A moeda da conta creditada.
                          accountNumber:
                            type: string
                            description: O número da conta creditada.
                          amount:
                            type: number
                            description: O valor creditado na conta.
                      appliedFx:
                        type: number
                        description: A taxa de câmbio aplicada à transação.
                x-examples:
                  Example 1:
                    transactionType: CurrencyExchange
                    externalId: ''
                    internalId: X11111XX-11X1-111X-X11X-111111X1X1XX
                    country: ARG
                    currency: ARS
                    exchangeRateToken: ''
                    clientCode: '0005'
                    creationDate: '2023-03-21T21:25:14.533+00:00'
                    errors: []
                    status:
                      code: '200'
                      description: COMPLETED
                      detail: CURRENCY EXCHANGE
                    account:
                      debited:
                        currency: ARS
                        accountNumber: '{{accountNumber}}'
                        amount: 40
                      credited:
                        currency: EUR
                        accountNumber: '{{accountNumber}}'
                        amount: 0.18
                      appliedFx: 224.54
              examples:
                200 - Currency Exchange Bulk:
                  value:
                    transactionType: CurrencyExchange
                    externalId: 7a9c72a0-7a8e-4f72-b2b3-a04054d3129f
                    internalId: 8888ad65-aa6e-4643-b9ba-ff62318fd90b
                    country: ARG
                    currency: ARS
                    exchangeRateToken: ''
                    clientCode: '0005'
                    creationDate: '2023-03-21T21:25:14.533+00:00'
                    errors: []
                    status:
                      code: '200'
                      description: COMPLETED
                      detail: CURRENCY EXCHANGE
                    account:
                      debited:
                        currency: ARS
                        accountNumber: '{{accountNumber}}'
                        amount: 10000
                      credited:
                        currency: EUR
                        accountNumber: '{{accountNumber}}'
                        amount: 44.52
                      appliedFx: 224.54
        '400':
          description: Solicitação inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: >-
                      Um identificador único gerado pelo seu sistema para
                      rastrear a transação (alfanumérico e com hífens).
                      Recomendamos o uso do UUID4 para garantir a unicidade.
                  internalId:
                    type: string
                    description: Identificador de transação da Localpayment.
                  errors:
                    type: array
                    description: >-
                      Uma matriz de objetos de erro, caso tenha ocorrido algum
                      erro durante a transação.
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Código de erro.
                        detail:
                          type: string
                          description: Detalhe do erro.
                  status:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Um código que representa o status atual da transação.
                      description:
                        type: string
                        description: Uma breve descrição da situação da transação.
                      detail:
                        type: string
                        description: |
                          Detalhes adicionais sobre o status da transação.
                x-examples:
                  Example 1:
                    externalId: '11112222'
                    internalId: 6fc7e955-7704-4558-8a05-6f4a2c3d9b45
                    errors:
                      - code: '705'
                        detail: Credited account currency not match
                    status:
                      code: '705'
                      description: REJECTED
                      detail: Credited account currency not match
              examples:
                705 - Credited account currency not match:
                  value:
                    externalId: '11112222'
                    internalId: 6fc7e955-7704-4558-8a05-6f4a2c3d9b45
                    errors:
                      - code: '705'
                        detail: Credited account currency not match
                    status:
                      code: '705'
                      description: REJECTED
                      detail: Credited account currency not match
                707 - Debited and credited amounts are mutually exclusive:
                  value:
                    errors:
                      - code: '707'
                        detail: >-
                          Fields debited.amount and credited.amount are mutually
                          exclusive. Only one of them must be reported
                    status:
                      code: '707'
                      description: REJECTED
                      detail: >-
                        Fields debited.amount and credited.amount are mutually
                        exclusive. Only one of them must be reported
        '401':
          description: Não autorizado
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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