Pular para o conteúdo principal
Explore o objeto Fields para criar formulários de pagamento. Esta referência detalha os métodos fields.create(), field.mount() e o tratamento de eventos. Depois de criar um campo com localpayment.create(), você pode usar os seguintes métodos no objeto retornado.

Tipos de Campo

Os seguintes tipos de campo estão disponíveis para criação usando o método create().

Eventos

Escute eventos em uma instância de campo usando o método .on() para reagir a mudanças de estado.

Evento 'change'

Acionado quando o valor do campo ou o estado de validação é alterado. O callback recebe: state (Object)
  • state.isEmpty (Boolean): true se o campo não tiver valor.
  • state.isValid (Boolean): true se o valor atual for válido.
  • state.isFocused (Boolean): true se o campo estiver com foco no momento.
  • state.error (String | undefined): Uma string descrevendo o erro de validação, se houver.
Exemplo:

Evento 'tokenized'

Acionado quando o valor do campo é tokenizado com sucesso pelo backend da Localpayment. Isso geralmente ocorre após a inserção de um valor válido e o campo perder o foco. Exemplo:

Evento 'error'

Acionado quando ocorre um erro irrecuperável, como uma falha de tokenização. O callback recebe: error (Object)
  • error.error (String): Uma mensagem de erro genérica.
  • error.metadata (Object | undefined): Metadados adicionais sobre o erro.
Exemplo:

Tratamento de erros

O SDK fornece erros por meio do evento error e de promises rejeitadas. Os cenários de erro comuns incluem:
  • Erros de rede: createSession() falhará se não for possível fazer uma requisição de rede.
  • Credenciais inválidas: createSession() falhará se o clientCode ou a apiKey estiver incorreto.
  • Erros de tokenização: O `error event será acionado se o valor de um campo não puder ser tokenizado (por exemplo, um número de cartão inválido que passa na validação básica, mas é rejeitado pelo processador).
  • Expiração da sessão: as operações falharão se a sessão expirar. Você deve detectar esse problema e, normalmente, recriar a sessão.
Exemplo de tratamento de erros abrangente:

Última modificação em 10 de novembro de 2026