> ## 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.

# Notificação de Wire In

Notifique a Localpayment sobre uma transferência bancária recebida usando nossa API para liquidar o saldo da sua conta. Este guia orienta você no envio de uma notificação, no tratamento das respostas da API e no acompanhamento do status da transação.

Para transações em moeda fiduciária (ex.: USD, ARS, MXN), é necessário nos notificar sobre a transferência recebida. Isso pode ser feito através de:

* **[Integração de API](https://docs.localpayment.com/pt-br/reference/wire-in.md)**: Recomendada para notificações automatizadas e programáticas.
* **[Business Portal Localpayment](https://docs.localpayment.com/pt-br/docs/dashboard-create-a-wire-in.md)**: Utilize a interface web para notificação manual de transações individuais.

> [!WARNING]
>
> **Importante**
>
> O processo de notificação de Wire In não é utilizado para **Stablecoins**. Em vez disso, siga o [fluxo de Wire In de Stablecoin](https://docs.localpayment.com/pt-br/docs/wire-in-overview).

Este guia cobre o fluxo de trabalho da API de ponta a ponta, da notificação à liquidação final.

***

## Antes de começar

Antes de notificar um Wire In, certifique-se de ter:

* **Comprovante da transferência bancária**: Prova da transferência externa.
* **Credenciais de API válidas**: Com permissões de autorização adequadas.
* **Detalhes completos da transação**: Todas as informações necessárias da transação.

***

## Endpoint da API

Para notificar uma liquidação, envie uma requisição `POST `para o endpoint [Criar Wire In](https://docs.localpayment.com/reference/wire-in.md).

### Endpoint

```http theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
POST https://api.stage.localpayment.com/api/account/wire-in
```

### Autenticação

Inclua seu token de acesso no cabeçalho Authorization:

```http theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
Authorization: Bearer <your_access_token>
```

### Parâmetros-chave da solicitação

A solicitação requer vários parâmetros-chave:

| Parâmetro | Tipo | Descrição | Obrigatório |
| - | - | - | - |
| `transactionType` | string | Deve ser definido como "WireIn" | ✅ |
| `currency` | string | Código da moeda (ex.: "ARS", "USD") | ✅ |
| `country` | string | Código do país (ex.: "ARG", "USA") | ✅ |
| `amount` | number | Valor da transferência | ✅ |
| `accountNumber` | string | Seu número de conta Localpayment | ✅ |
| `to` | object | Dados bancários do destinatário | ✅ |
| `from` | object | Dados bancários do remetente | ✅ |

### Exemplo de solicitação (Argentina)

```bash curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
curl --request POST \
  --url https://api.stage.localpayment.com/api/account/wire-in \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: multipart/form-data' \
  --form 'request={\"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}}' \
  --form filecontent=@CO.png
```

***

## Tratamento de Respostas

### Resposta bem-sucedida

Quando sua solicitação de Wire In for aceita, você receberá uma resposta detalhada:

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
    "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.0,
            "amount": 2.18,
            "account": "{{accountNumber}}"
        }
    ],
    "withHoldings": [],
    "comment": "Comment",
    "code": "101"
}
```

#### Campos de resposta principais

| Campo | Tipo | Descrição |
| - | - | - |
| `externalId` | string | Seu identificador único da transação |
| `internalId` | string | ID interno da transação da Localpayment |
| `creationDate` | string | Timestamp de criação da transação (ISO 8601) |
| `amount` | number | Valor líquido após taxas |
| `fees` | object | Taxas de processamento aplicadas |
| `status` | object | Informações sobre o status atual da transação |

### Resposta de erro

#### Exemplo de erro de validação

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "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"
  }
}
```

***

## Acompanhar o status da transação

Após enviar um Wire In, acompanhe o seu progresso através destes métodos:

> [card] [Webhooks (Recomendado)](https://docs.localpayment.com/pt-br/docs/webhooks.md)
>
> Receba notificações em tempo real quando o status da transação mudar. Ideal para ambientes de produção.

> [card] [Endpoint da API de Status](https://docs.localpayment.com/pt-br/reference/get-transaction-status.md)
>
> Consultar o status da transação programaticamente. Útil para consultar ou recuperar notificações de webhook perdidas.

> [card] [Visualização do Business Portal](https://docs.localpayment.com/pt-br/docs/dashboard-overview.md)
>
> Interface visual para monitoramento de transações. Ideal para supervisão manual e análise detalhada de transações.

### Códigos de status comuns

| Código | Status | Descrição |
| :- | :- | :- |
| `100` | `PendingCredit` | Crédito pendente |
| `200` | `Completed` | Concluído |
| `717` | `RejectedByBank` | Rejeitado |

> [!NOTE]
>
> **Referência completa**
>
> Consulte todos os códigos de status em nossa [Documentação de Status da Transação](https://docs.localpayment.com/pt-br/reference/transaction-status-error-codes).

### Recomendações de segurança

* Utilize sempre HTTPS para solicitações de API
* Armazene os tokens de acesso com segurança (nunca em código do lado do cliente)
* Implemente tratamento de erros e registro de logs adequados
* Valide todos os dados de entrada antes de enviar as solicitações

***

## Recursos e próximos passos

Maximize o sucesso da sua integração com estes recursos essenciais.

> [card] [Integração de Webhook](https://docs.localpayment.com/pt-br/docs/webhooks.md)
>
> Configure notificações em tempo real para atualizações do status das transações.

> [card] [Relatórios do Business Portal](https://docs.localpayment.com/pt-br/docs/balance-report.md)
>
> Acesse análises detalhadas, ferramentas de geração de relatórios e recursos de conciliação.

> [card] [Monitoramento de transações](https://docs.localpayment.com/pt-br/reference/transaction-status-error-codes)
>
> Aprenda a consultar o status das transações e a implementar um rastreamento abrangente.

> [card] [Referência da API](https://docs.localpayment.com/pt-br/reference/exchange-bulk.md)
>
> Documentação completa dos endpoints com exemplos interativos.

> [!NOTE]
>
> **Dica profissional**
>
> Sempre teste seu fluxo de trabalho em nosso ambiente de sandbox antes de implantá-lo em produção. Isso garante que o tratamento de erros, o processamento de webhooks e o rastreamento de status funcionem corretamente em todos os cenários.

***

> [!NOTE]
>
> **Precisa de ajuda?**
>
> Entre em contato com nossa [equipe de suporte](mailto:support@localpayment.com) caso encontre algum problema ou precise de ajuda com a integração.


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