Pular para o conteúdo principal
GET
Obter esquema de campos personalizados
Retorna o esquema de campos personalizados publicado do seu comerciante, como JSON Schema (padrão) ou como a definição de campos nativa da Localpayment (?format=definition). Use-o para criar formulários e validar attributes antes de chamar a API.
  • Os esquemas são definidos e publicados pela Localpayment para o seu comerciante durante o onboarding; solicite alterações por meio do seu gerente de conta.
  • Quando nenhum esquema está publicado, attributes é aceito sem validação e este endpoint retorna 404.
  • O esquema se aplica a entidades INDIVIDUAL e COMPANY.
Erros usam application/problem+json com um code estável. Catálogo completo: Status de Entidades e Códigos de Erro.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso. Sua conta de comerciante e o usuário que realiza a ação são identificados a partir dele.

Exemplo:

"Bearer <your_access_token>"

X-Correlation-ID
string

Identificador de rastreamento (UUID). Exibido na resposta; gerado pelo Localpayment se ausente.

Exemplo:

"0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10"

Parâmetros de consulta

format
enum<string>

Definição para receber a lista de campos nativos. Padrão: JSON Schema 2020-12.

Opções disponíveis:
definition

Resposta

OK.

$schema
string
Exemplo:

"https://json-schema.org/draft/2020-12/schema"

type
string
Exemplo:

"object"

properties
object
additionalProperties
boolean
Exemplo:

false

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