> ## 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 Wire In

Receba fundos de uma conta bancária externa diretamente na sua conta Localpayment por meio de transferência bancária. Este endpoint é ideal para aceitar pagamentos de clientes ou parceiros que utilizam o sistema bancário tradicional.

Após o envio, você receberá um `internalId` único para acompanhar a transação. Use esse identificador para monitorar a transferência até que os fundos sejam creditados com sucesso na sua conta.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/account/wire-in
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/account/wire-in:
    post:
      summary: Criar Wire In
      operationId: wire-in
      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:
          multipart/form-data:
            schema:
              type: object
              properties:
                request:
                  type: string
                  description: "| Nome                      | Tipo   | Obrigatório | Descrição                                                                                                                                            |\r\n| ------------------------- | ------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| transactionType           | String | Obrigatório | Tipo de transação (WireIn).                                                                                                                          |\r\n| currency                  | String | Obrigatório | [Códigos de moeda.](https://docs.localpayment.com/docs/global-coverage)                                                                              |\r\n| country                   | String | Obrigatório | [País do documento.](https://docs.localpayment.com/docs/global-coverage) ISO 3166-1 alfa-3.                                                          |\r\n| amount                    | String | Obrigatório | Valor da transação.                                                                                                                                  |\r\n| comment                   | String | Opcional    | Um comentário ou descrição adicional associado à transação.                                                                                          |\r\n| externalId                | String | Obrigatório | Um identificador único gerado pelo seu sistema para rastrear a transação (alfanumérico e hifens). Recomendamos usar UUID4 para garantir a unicidade. |\r\n| accountNumber             | String | Obrigatório | Número da conta Localpayment.                                                                                                                        |\r\n| to                        | Object | Obrigatório | Dados do beneficiário.                                                                                                                               |\r\n| to.name                   | String | Obrigatório | Nome do beneficiário.                                                                                                                                |\r\n| to.swift                  | String | Obrigatório | Código de identificação bancária mais utilizado para realizar transferências internacionais de dinheiro.                                             |\r\n| to.address                | String | Obrigatório | Endereço do banco.                                                                                                                                   |\r\n| to.accountNumber          | String | Obrigatório | Número da conta Localpayment.                                                                                                                        |\r\n| to.accountName            | String | Obrigatório | Nome do titular beneficiário.                                                                                                                        |\r\n| to.beneficiaryAddress     | String | Obrigatório | Endereço do titular da conta.                                                                                                                        |\r\n| from                      | Object | Obrigatório | Dados do banco ordenante.                                                                                                                            |\r\n| from.name                 | String | Obrigatório | Nome do banco ordenante.                                                                                                                             |\r\n| from.swift                | String | Obrigatório | Código de identificação do banco ordenante para realizar transferências internacionais de dinheiro.                                                  |\r\n| from.address              | String | Obrigatório | Endereço do banco ordenante.                                                                                                                         |\r\n| from.accountNumber        | String | Obrigatório | Número da conta Localpayment.                                                                                                                        |\r\n| from.routingNumber        | String | Opcional    | Código identificador da transação para indicar as instituições bancárias de origem e destino das transferências nos Estados Unidos.                  |\r\n| from.accountName          | String | Obrigatório | O nome associado à conta bancária ordenante.                                                                                                         |\r\n| from.beneficiaryAddress   | String | Obrigatório | O endereço da parte ordenante.                                                                                                                       |\r\n| intermediaryAccountNumber | String | Opcional    | O número da conta no banco intermediário (se houver)                                                                                                 |\r\n| intermediaryBankSwift     | String | Opcional    | O código SWIFT do banco intermediário (se houver).                                                                                                   |\r\n| intermediaryBankName      | String | Opcional    | O nome do banco intermediário (se houver).                                                                                                           |\r\n\r\n"
                  examples:
                    - >-
                      {"transactionType":"WireIn","currency":"BOB","country":"BOL","amount":100,"comment":"Comment","externalId":"a11h7890-78ju-098j-hu78-124ftn8lo0io","accountNumber":"{{accountNumber}}","to":{"name":"Bankname","swift":"BCBHDOSD","address":"BankAddress","accountNumber":"1310825187","accountName":"BeneficiaryBankName","beneficiaryAddress":"BeneficiaryAddress"},"from":{"name":"OrderingBankName","swift":"BICAARBS","address":"OrderingBankAddress","accountNumber":"123456789","routingNumber":null,"accountName":"accountName","beneficiaryAddress":"BeneficiaryAddress","intermediaryBankName":null,"intermediaryBankSwift":null,"intermediaryAccountNumer":null}}
                filecontent:
                  type: string
                  description: "Comprovante da transação\r\n"
                  contentMediaType: application/octet-stream
              required:
                - request
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactionType:
                    type: string
                    description: O tipo de transação que está sendo processada.
                  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
                    enum:
                      - ARG
                      - BOL
                      - BRA
                      - CHL
                      - COL
                      - CRI
                      - DOM
                      - ECU
                      - SLV
                      - GTM
                      - HND
                      - MEX
                      - PAN
                      - PRY
                      - PER
                      - URY
                    description: >-
                      [País do documento](/pt-br/reference/country-codes). ISO
                      3166-1 alfa-3.
                  currency:
                    type: string
                    enum:
                      - ARS
                      - BOB
                      - BRL
                      - CLP
                      - COP
                      - CRC
                      - DOP
                      - USD
                      - GTQ
                      - MXN
                      - PYG
                      - PEN
                      - UYU
                    description: '[Códigos de moeda](/pt-br/reference/currency-codes).'
                  clientCode:
                    type: string
                    description: >-
                      Um identificador único atribuído ao cliente dentro do
                      sistema Localpayment.
                  creationDate:
                    type: string
                    description: >-
                      A data e a hora em que a transação foi criada, no formato
                      ISO 8601.
                  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
                    description: Objeto que fornece o status atual da transação.
                    properties:
                      code:
                        type: string
                        description: >-
                          Um código que representa o [status atual da
                          transação](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          Uma breve descrição da [situação da
                          transação](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Detalhes adicionais sobre o status da transação.
                  accountNumber:
                    type: string
                    description: Número da conta Localpayment.
                  amount:
                    type: number
                    description: Valor da transação.
                  fees:
                    type: object
                    description: Detalhes sobre quaisquer taxas cobradas.
                    properties:
                      description:
                        type: string
                        description: Descrição da taxa aplicada à transação.
                      currency:
                        type: string
                        description: '[Códigos de moeda](/pt-br/reference/currency-codes).'
                      amount:
                        type: number
                        description: O valor da taxa aplicada à transação.
                      account:
                        type: string
                        description: O número da conta à qual a taxa será aplicada.
                  localTaxes:
                    type: array
                    description: >-
                      Uma lista de impostos locais aplicados à transação. Se
                      estiver vazia, nenhum imposto foi aplicado.
                    items:
                      type: object
                  withHoldings:
                    type: array
                    description: >-
                      Uma lista de retenções aplicadas à transação. Se estiver
                      vazia, nenhuma retenção foi aplicada.
                    items:
                      type: object
                  comment:
                    type: string
                    description: Um comentário ou nota relacionada à transação.
                x-examples:
                  Example 1:
                    transactionType: WireIn
                    externalId: External15
                    internalId: 0f1d47dc-e9c6-4fdf-8ba1-c9b29916574d
                    country: ARG
                    currency: ARS
                    clientCode: '0001'
                    creationDate: '2024-02-28T13:47:58.808+00:00'
                    errors: []
                    status:
                      code: '100'
                      description: PENDING_CREDIT
                      detail: WIRE IN
                    accountNumber: '{{accountNumber}}'
                    amount: 49500
                    fees:
                      description: Fee
                      currency: ARS
                      amount: 500
                      account: '{{accountNumber}}'
                    localTaxes: []
                    withHoldings: []
                    comment: Ducupublica
              examples:
                101 - Wire In Example Response:
                  value:
                    transactionType: WireIn
                    transactionFlow: wireInAutomatic
                    externalId: a11h7890-78ju-098j-hu78-124ftn8lo0io
                    internalId: b97fe1cd-50d3-4ee2-8a6e-34ee6d7e4f4e
                    country: BOL
                    currency: BOB
                    clientCode: '0001'
                    creationDate: '2025-12-04T21:07:41.689+00:00'
                    errors: []
                    status:
                      code: '101'
                      description: PENDING_AUTH
                      detail: Pending Auth
                    accountNumber: '{{accountNumber}}'
                    amount: 97.32
                    fees:
                      description: Fee
                      currency: BOB
                      amount: 0.5
                      account: '{{accountNumber}}'
                    localTaxes:
                      - code: '0016'
                        percentage: 2.18
                        description: FNA
                        currency: BOB
                        fxSource: 6.911493
                        fxQuote: 0
                        amount: 2.18
                        account: '{{accountNumber}}'
                    withHoldings: []
                    comment: Comment
                    code: '101'
        '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.
                  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: Detalhes do erro.
                  status:
                    type: object
                    description: Objeto que fornece o status atual da transação.
                    properties:
                      code:
                        type: string
                        description: >-
                          Um código que representa o [status atual da
                          transação.](/pt-br/reference/transaction-status-error-codes)
                      description:
                        type: string
                        description: >-
                          Uma breve descrição da [situação da
                          transação](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Detalhes adicionais sobre o status da transação.
                x-examples:
                  Example 1:
                    externalId: e84657e9-65d8-4de5-afbb-f62cc14f30b7
                    errors:
                      - code: '812'
                        detail: External Id already used - duplication
                    status:
                      code: '812'
                      description: REJECTED
                      detail: External Id already used - duplication
              examples:
                500 - Error master service.:
                  value:
                    status:
                      code: '500'
                    timestamp: '2025-01-10 16:22:20.569138644'
                    code: '500'
                    description: Error master service
                812 - External Id already used - duplication.:
                  value:
                    externalId: e84657e9-65d8-4de5-afbb-f62cc14f30b7
                    errors:
                      - code: '812'
                        detail: External Id already used - duplication
                    status:
                      code: '812'
                      description: REJECTED
                      detail: External Id already used - duplication
                404 - This beneficiary account is invalid.:
                  value:
                    externalId: 089c81c6-7be2-4798-8e53-d4bfff61f852
                    errors:
                      - code: '404'
                        detail: This beneficiary account is invalid
                    status:
                      code: '404'
                      description: REJECTED
                      detail: This beneficiary account is invalid
        '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.