1. Vertex - API de Pagamentos
Vertex Pagamentos
  • Vertex - API de Pagamentos
    • Autenticação
    • Webhooks
    • Transações
      • Criar transação
      • Consultar transação
  • Purple WL - API de Transações
    • Se interessou na tecnologia?
  1. Vertex - API de Pagamentos

Autenticação

Para criar e consultar transações na API, é necessário autenticar cada requisição utilizando duas credenciais enviadas através dos headers HTTP:
Essas credenciais identificam sua integração e autorizam o acesso aos endpoints públicos de pagamento.

Headers obrigatórios#

Todas as requisições de criação ou consulta de transações devem incluir:

X-Client-Id#

Você encontra seu X-Client-Id em Integrações > API e Webhooks.

X-Public-Key#

Você encontra seu X-Public-Key em Integrações > API e Webhooks.

Exemplo de requisição autenticada#


Consulta de uma transação#

A mesma autenticação deve ser utilizada ao consultar uma transação existente:

Importante#

As credenciais devem ser enviadas em todas as requisições para os endpoints protegidos.
O nome correto do header é X-Public-Key.
Não utilize Authorization: Bearer para essas rotas públicas de transação.
Não altere os nomes dos headers.
Mantenha suas credenciais protegidas e evite expô-las em repositórios públicos ou códigos acessíveis diretamente pelo usuário.
Atenção: se a integração estiver sendo feita em um frontend público, como HTML ou JavaScript executado diretamente no navegador, as credenciais poderão ser visualizadas pelo usuário. O recomendado é realizar as chamadas à API através do seu backend.
Modificado em 2026-08-21 20:45:35
Próxima página
Webhooks
Built with