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).
Redirecionamentos após o pagamento
Depois que o cliente conclui ou cancela o pagamento, use as URLs de sucesso e cancelamento para encaminhá-lo de volta ao seu site.
Pela API
Nas chamadas da API para pedidos, assinaturas, faturas e links de pagamento, configure os campos successUrl e cancelUrl:
{
"successUrl": "https://sua-loja.co.mz/pagamento/sucesso",
"cancelUrl": "https://sua-loja.co.mz/pagamento/cancelado"
}Pelo Dashboard
Abra a aplicação no Dashboard e configure as URLs de sucesso e cancelamento nas configurações da aplicação.
Cada aplicação tem uma configuração de redirecionamento compartilhada pelos seus pagamentos; as URLs não são configuradas individualmente para cada pagamento.
Download da Collection
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.
Como importar a Collection no Postman
Baixe a Collection
Escolha e baixe o arquivo .json da Collection Vpay
Importe no Postman
Clique em Import → File → selecione o arquivo .json baixado
Configure as variáveis
Preencha as variáveis da Collection com suas credenciais
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.
base_url(required)URL base da API Vpay
client_id(required)Identificador único da sua aplicação. Gerado automaticamente ao criar uma app no dashboard.
bf8b1477-c393-4f5e-84a5-167ba74efdf0client_secret(required)Chave secreta para autenticação. Gerada no momento da criação da app.
Como obter suas credenciais?
- Acesse o Dashboard Vpay
- Crie uma nova app ou selecione uma existente
- Na navbar vá até Aplicação → Configurações → Credenciais
- Copie o Client ID e o Client Secret
- Configure as variáveis no Postman com os valores copiados
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
/api/auth/tokenGerar token de acesso/api/ordersCriar um novo pedido/api/orders/{id}Buscar pedido por ID/api/orders/{id}/statusConsultar status do pedido/api/productsListar produtosv1.0.0