Voay
Primeiros Passos
Botões de PagamentoSDK

Recursos Rápidos

Referência da APICollection APIManipulação de AppsComunidade WhatsApp↗Guia YouTube↗FAQ
Autenticação(Polling) Status do PedidoWebhooks

Collection API

Explore a API Vpay de forma prática com nossa API Collection pronta para Postman e outras ferramentas compatíveis.

Visão Geral

Nós preparamos uma API Collection com todos os endpoints documentados. Com ela, você pode importar toda a estrutura da API, incluindo requisições, parâmetros e exemplos de payloads, eliminando a necessidade de configuração manual.

Além do Postman, também é possível importar esta Collection em Insomnia, Hoppscotch ou Thunder Client (VS Code).

Download da Collection

Autenticação via Client ID e Secret
Collection configurada para uso com Client ID e Client Secret

Ideal para integrações diretas usando as credenciais de API fornecidas pelo dashboard. Esta collection já inclui scripts para gerenciar o token de acesso automaticamente.

Baixar CollectionBaixar Postman

Como importar a Collection no Postman

1

Baixe a Collection

Escolha e baixe o arquivo .json da Collection Vpay

2

Importe no Postman

Clique em Import → File → selecione o arquivo .json baixado

3

Configure as variáveis

Preencha as variáveis da Collection com suas credenciais

4

Teste a integração

Execute uma requisição de teste para validar a configuração

Configuração das variáveis

Após importar a Collection, configure as seguintes variáveis no Postman. Estes valores são obtidos no Dashboard Vpay.

Variáveis da Collection
Autenticação Client Credentials
Configure estas variáveis no Postman para que todas as requisições funcionem
base_url(required)

URL base da API Vpay

https://api.vpay.co.mz
client_id(required)
Disponível no dashboard

Identificador único da sua aplicação. Gerado automaticamente ao criar uma app no dashboard.

seu_client_id_aqui
Exemplo: bf8b1477-c393-4f5e-84a5-167ba74efdf0
client_secret(required)
⚠️ Mostrado apenas uma vez

Chave secreta para autenticação. Gerada no momento da criação da app.

seu_client_secret_aqui

Como obter suas credenciais?

  1. Acesse o Dashboard Vpay
  2. Crie uma nova app ou selecione uma existente
  3. Na navbar vá até Aplicação → Configurações → Credenciais
  4. Copie o Client ID e o Client Secret
  5. Configure as variáveis no Postman com os valores copiados
Saiba mais sobre autenticação

Dica: Teste sua configuração

Após configurar as variáveis, execute a requisição POST /api/auth/token. Se receber um token de acesso, a configuração foi bem-sucedida!

Verificação rápida

Recomendamos testar a requisição POST /api/auth/tokenlogo após configurar as variáveis. Se o retorno for 200 OK com um token de acesso, a configuração foi um sucesso!

Alguns endpoints incluídos na Collection

POST/api/auth/tokenGerar token de acesso
POST/api/ordersCriar um novo pedido
GET/api/orders/{id}Buscar pedido por ID
GET/api/orders/{id}/statusConsultar status do pedido
GET/api/productsListar produtos
Comunidade Vpay Dev
Faça parte da nossa comunidade de desenvolvedores no WhatsApp
Entrar na comunidade

v1.0.0

Suporte