Visão geral da API

Ambiente	URL
Produção	`https://v4pay-api.vercel.app`
Local	`http://localhost:3000`

Ambiente

URL

Produção

https://v4pay-api.vercel.app

Local

http://localhost:3000

Formato das respostas

{ "data": { } }                            // sucesso
{ "error": { "message": "…", "codigo": "…" } }     // erro das rotas
{ "error": "Token JWT ou chave de API ausente" }   // erro do middleware de autenticação

O terceiro formato é uma exceção real, não erro de digitação desta página: quando a credencial falha, error vem como string. Trate os dois. Os codigo de negócio estão todos em Erros e códigos.

Mapa

Grupo	O que cobre
Pix	emitir (manual ou por produto), listar, consultar status, cancelar, devolver, simular pagamento (teste)
Cobranças e Clientes	registro direto de cobranças e o cadastro de pagadores
Links de pagamento e Checkout (público)	as URLs reutilizáveis e as rotas sem credencial que a página de pagamento usa
Produtos e Cupons	catálogo e descontos
Assinaturas	recorrência — o cron diário emite as cobranças
Webhooks (endpoints) e Chaves de API	as URLs de notificação da loja e as credenciais de integração
Conta de recebimento	cadastro da empresa e a subconta — vale no modo subconta (ver Modo de recebimento)
Aprovação de produção	o fluxo que libera a operação em produção
Saques	pedidos de saque — suspensos no modo conta única (`REPASSE_MANUAL`)
Membros da loja	quem pode operar a loja junto com o dono
Conta (auth), Auditoria e Sistema	sessão, trilha de ações e saúde
Interno	rotas do painel (Roadmap, aprovações da equipe, cron…) — documentadas por transparência, não para integração

As páginas são geradas do openapi.yaml e têm playground interativo: informe a sua chave e chame a API dali mesmo.

POST /pix/cancel e POST /pix/refund existem, mas ainda não executam o cancelamento nem a devolução na origem — respondem 502 explicando. Está dito na página de cada um.

Referência da API

Visão geral da API

Base URL

Autenticação

Formato das respostas

Mapa

​Base URL

​Autenticação

​Formato das respostas

​Mapa

Base URL

Autenticação

Formato das respostas

Mapa