Pular para o conteúdo
Vmix Pay — Documentação

Postman

Disponibilizamos uma collection do Postman com os endpoints da API pública do Vmix Pay — a mesma superfície que os integradores usam. Ela já traz os scripts de teste que capturam o access_token e os ids (charge_id, refund_id) nas variáveis, então basta importar, preencher as credenciais e rodar na ordem.

A collection cobre: OAuth2 (POST /v1/oauth/token), identidade (GET /v1/me), cobranças PIX, boleto (emissão + PDF), consultas e refunds, wallet (saldo e extrato) e dois health checks de conectividade.

Download

Seção intitulada “Download”
Collectionvmixpay.postman_collection.json — importe no Postman (Import → arraste o arquivo).
Environmentvmixpay.postman_environment.json — variáveis (client_id, client_secret, base_url) com placeholders vazios.

Como usar

Seção intitulada “Como usar”

Antes de começar você precisa de uma credencial de API (client_id + client_secret), criada no painel. O client_secret é exibido uma única vez — guarde-o ao criar a credencial. Veja Autenticação para o passo a passo da criação.

  1. Importe os dois arquivos no Postman. File → Import (ou arraste) a collection e o environment. No seletor de environment (canto superior direito), selecione “Vmix Pay — API Pública”.

  2. Preencha as credenciais no environment. Abra o environment e cole o seu client_id e client_secret nas variáveis de mesmo nome. Mantenha base_url como https://api.vmixpay.com.br (ou aponte para o seu ambiente). Deixe api_access_token vazio — ele é preenchido sozinho.

  3. Rode “Obter token” (OAuth). Em API Pública (integrador) → POST /v1/oauth/token, clique em Send. A request usa HTTP Basic com client_id/client_secret e grant_type=client_credentials. O script de teste salva o access_token da resposta na variável api_access_token automaticamente.

  4. Confirme a identidade (opcional). Rode GET /v1/me para ver { clientId, merchantId, scopes } — a prova de que o Bearer está valendo.

  5. Rode as demais requests. Todas as outras pastas (Charges PIX, Boleto, Consultas & Refunds, Wallet) já herdam o Authorization: Bearer {{api_access_token}}. Defina account_id no environment quando precisar (ou deixe a API usar a conta do token) e dispare as chamadas. Os scripts capturam charge_id/refund_id para encadear as consultas.