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

# Aprovações e dupla assinatura

Algumas transações de pagamento exigem autorização adicional antes de serem processadas. Este guia explica quando a autorização é necessária e como aprovar pagamentos por meio de diferentes métodos.

## Quando a autorização é necessária

É necessária autorização adicional para pagamentos realizados nessas condições:

* **Payouts via API**: criados via API com o parâmetro `requireAuth` definido como `true`.
* **Payouts no Business Portal**: criados diretamente no Business Portal do Localpayment.

### Métodos de autorização

O método para autorizar pagamentos depende de como eles foram criados originalmente:

**Pagamentos criados no Business Portal**

Para payouts criados no [Business Portal](https://docs.localpayment.com/pt-br/docs/dashboard-review-payout.md), um segundo usuário com permissões de autorização deve autorizar.

**Pagamentos criados por API**

Para pagamentos criados via API, use o endpoint [Authorize Payout](https://docs.localpayment.com/pt-br/reference/authorize-payout.md) para aprovar transações programaticamente.

***

## Pré-requisitos

Antes de autorizar pagamentos, certifique-se de que você tem:

* Uma **transação de payout inicializada** com status `PendingAuth`
* Credenciais de API válidas com permissões de autorização
* O identificador da transação (`internalId` ou `externalId`) ou o intervalo de datas para autorização em lote

***

## Autorização de pagamentos via API

### Endpoint

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

### Autenticação

Inclua seu token de acesso nos cabeçalhos da solicitação:

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

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

Você pode autorizar pagamentos usando um dos três métodos a seguir:

| Parâmetro | Tipo | Descrição | Obrigatório |
| - | - | - | - |
| `internalId` | string | Identificador de transação exclusivo da Localpayment | ✅ (Opção 1) |
| `externalId` | string | Identificador de transação exclusivo do seu sistema | ✅ (Opção 2) |
| `dateFrom` | string | Data de início para autorização em massa (AAAA-MM-DD) | ✅ (Opção 3) |
| `dateTo` | string | Data final para autorização em lote (AAAA-MM-DD) | ✅ (Opção 3) |

> [!NOTE]
>
> **Escolha um método de autorização**
>
> Use um ID de transação específico (`internalId` ou `externalId`) para transações individuais, ou um intervalo de datas (`dateFrom` e `dateTo`) para autorização em lote.

### Exemplos de solicitações

> [tab] Transação única (ID externo)
>
> ```curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> curl --request POST \
>      --url https://api.stage.localpayment.com/api/payout/authorize \
>      --header 'Authorization: Bearer <your_access_token>' \
>      --header 'Content-Type: application/json' \
>      --data '{
>        "externalId": "1939b376-2aed-4c7a-bc2b-1157702f00b0"
>      }'
> ```

> [tab] Transação única (ID interno)
>
> ```curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> curl --request POST \
>      --url https://api.stage.localpayment.com/api/payout/authorize \
>      --header 'Authorization: Bearer <your_access_token>' \
>      --header 'Content-Type: application/json' \
>      --data '{
>        "internalId": "7d7f7fca-e411-4ba6-b4f5-b9fed4d5f3d2"
>      }'
> ```

> [tab] Autorização em lote (intervalo de datas)
>
> ```curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> curl --request POST \
>      --url https://api.stage.localpayment.com/api/payout/authorize \
>      --header 'Authorization: Bearer <your_access_token>' \
>      --header 'Content-Type: application/json' \
>      --data '{
>        "dateFrom": "2024-01-01",
>        "dateTo": "2024-01-31"
>      }'
> ```

***

## Tratamento de Respostas

### Resposta bem-sucedida

Quando a autorização for bem-sucedida, você receberá:

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "status": 200,
  "message": "The request will be processed."
}
```

#### Campos de resposta principais

| Campo | Tipo | Descrição |
| - | - | - |
| `status` | integer | Código de status HTTP (200 para sucesso) |
| `message` | string | Mensagem de confirmação indicando que a solicitação está sendo processada. |

### Respostas de erro

#### Erros de validação

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "errors": {
    "externalId": [
      "The externalId field is required."
    ]
  },
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-6af59d173e66ad4eb215987cd15d57af-bea3981476c0f347-00"
}
```

## Melhores práticas

* Sempre verifique os detalhes da transação antes da autorização.
* Use HTTPS para todas as requisições de API
* Armazene os tokens de acesso com segurança.
* Implemente um tratamento de erros e um registro de logs adequados

### Fluxo de trabalho recomendado

1. **Criar Payout**: Gere o payout com `requireAuth=true`
2. **Verificar status**: Confirme que o status da transação é `PendingAuth`
3. **Detalhes da revisão**: Validar informações da transação
4. **Autorizar**: Chame o endpoint de autorização.
5. **Lidar com a resposta**: Processar as respostas de sucesso/erro adequadamente.
6. **Monitorar**: Rastrear alterações no status das transações via webhooks

***

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