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

# O objeto Localpayment

O objeto Localpayment é o seu ponto de entrada para o SDK Smart Fields. Ele fornece métodos para criar campos de pagamento, manipular tokens e gerenciar o fluxo de pagamento. Este objeto é criado chamando o construtor `LP` com sua chave pública.

## Inicialização

Para começar a usar o Smart Fields da Localpayment, você deve primeiro inicializar o objeto `LP` com sua chave de API pública. Isso cria a interface principal para todas as operações do Smart Fields.

```javascript theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
const localpayment = LP({
    clientCode: 'your_client_code', // Your client code here 
    apiKey: 'your_api_key' // Your secret API key for authentication
});
```

### Opções de configuração

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `clientCode` | string | Sim | Seu identificador de comerciante exclusivo fornecido pela Localpayment. |
| `apiKey` | string | Sim | Sua chave de API secreta para solicitações de autenticação. |

***

## Métodos

### `createSession()`

Cria uma nova sessão com o backend da Localpayment. Esta sessão é válida por um tempo limitado (10 minutos) e deve ser criada antes de configurar quaisquer campos de pagamento.

* **Retorna**: `Promise<void>`
* **Lança**: Um erro se a solicitação de rede falhar ou se as credenciais forem inválidas.

#### Exemplo

### `create(fieldType)`

Cria uma instância de um campo de pagamento seguro. O campo não fica visível até ser montado.

* **Retorna**: instância de `LPField`.

#### Parâmetros

| Parâmetro | Tipo | Obrigatório | Descrição |
| :- | :- | :- | :- |
| `fieldType` | String | Sim | O tipo de campo a ser criado. Valores aceitos: `pan`, `cvv`, `expiration`. |

#### Exemplo

```javascript theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
// Create field instances
const panField = localpayment.create('pan');
const cvvField = localpayment.create('cvv');
const expirationField = localpayment.create('expiration');
```

### `getSessionData()`

Recupera os dados da sessão ativa atual, incluindo o ID da sessão e o token de acesso. Isso é essencial para a etapa de consolidação de tokens no seu backend.

* Retorna: `Object` contendo os dados da sessão.
  * `sessionId` (String): O identificador único da sessão atual.
  * `accessToken` (String): O token de curta duração usado para autenticar a solicitação de consolidação.
  * `clientCode` (String): O código do cliente usado para inicializar o SDK.
  * `apiKey` (String): A chave de API usada para inicializar o SDK.

#### Exemplo

```javascript theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
const sessionData = localpayment.getSessionData();
// Example response: { sessionId: 'd069f375-c07c-4ac8-9f8a-6abbeb31f459', accessToken: 'eyJhbGci...', clientCode: '0001', apiKey: 'IIBCgKCAQEAtI...' }
```


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