Documentação da API

Bem-vindo à documentação da API NovaPay. Use nossa API para integrar pagamentos Pix em seu site ou aplicação.

Autenticação

Toda requisição à nossa API deve ser autenticada. A autenticação é feita através de um par de chaves (Pública e Secreta) enviadas como HTTP Headers.

Você pode gerar e visualizar suas chaves no seu Dashboard, na seção "Credenciais de API".

Headers de Autenticação

Header	Descrição
X-Api-Key	Sua chave pública (ex: pk_...).
X-Api-Secret	Sua chave secreta (ex: sk_...).
Content-Type	Deve ser sempre application/json.

Endpoints

POST /api/publica/criar_cobranca.php

Cria uma nova cobrança Pix.

Body da Requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
valor	Decimal	Sim	Valor da cobrança em Reais. (Ex: 10.50)
cliente_email	String	Sim	Email do cliente pagador.
correlation_id_externo	String	Não	Um ID de sua escolha para reconciliação (ex: "PEDIDO-12345").

Exemplo de Resposta (Sucesso 201 Created)

{
    "status": "PENDENTE",
    "seu_correlation_id": "PEDIDO-12345",
    "nosso_transaction_id": 15,
    "pixQrCodeImage": "data:image/png;base64,...",
    "pixBrCode": "00020126...BR.COM.WOOVI..."
}

Exemplo de Resposta (Erro 401 Unauthorized)

{
    "error": "Credenciais de API inválidas."
}

Exemplo de Resposta (Erro 400 Bad Request)

{
    "error": "Campo \"valor\" inválido ou ausente. (Ex: 10.50)"
}

Exemplo de Requisição (cURL)

Abaixo um exemplo completo de como chamar a API usando cURL. Lembre-se de substituir as chaves pelas suas.

curl -X POST 'https://speedmob.shop/api/publica/criar_cobranca.php' \
-H 'Content-Type: application/json' \
-H 'X-Api-Key: pk_xxxxxxxxxxxxxx' \
-H 'X-Api-Secret: sk_xxxxxxxxxxxxxx' \
-d '{
    "valor": 10.50,
    "cliente_email": "cliente.final@email.com",
    "correlation_id_externo": "PEDIDO-12345"
}'