Introdução
A EvoPay API permite criar cobranças Pix (cash-in) e saques (cash-out) diretamente no seu sistema, além de consultar transações e configurar sua conta.
Base URL
https://pix.evopay.cash/v1
Autenticação
Todas as requisições (exceto rotas públicas) exigem o header:
API-Key: SEU_TOKEN
Veja Autenticação para detalhes sobre como obter o token.
Formato de valores
Valores monetários são sempre em reais decimais. R$ 10,50 = 10.50 — nunca em centavos.
IDs de transações
Transações são identificadas por CUIDs: strings alfanuméricas de 25 caracteres em minúsculas.
cmq47c6un0c05ufvvo58ohpqk
Taxas
Cada conta tem regras de taxa configuradas separadamente para DEPOSIT e WITHDRAW. Cada regra define:
| Campo | Descrição |
|---|---|
taxValue | Valor da taxa |
taxType | FIXED — valor fixo em reais / PERCENTAGE — percentual sobre o valor |
minAmount | Valor mínimo aceito por transação — transações abaixo deste valor são rejeitadas |
maxAmount | Valor máximo aceito por transação (null = sem limite) — transações acima são rejeitadas |
A regra com o range correspondente ao valor da transação é aplicada. Transações fora do range minAmount–maxAmount são rejeitadas.
O campo taxAmount na transação é o valor de taxa efetivamente cobrado. O campo amountWithTax é o valor líquido da operação:
- Depósito:
amountWithTax = amount − taxAmount(valor creditado ao saldo) - Saque:
amountWithTax = amount + taxAmount(total debitado do saldo)
As regras são configuradas pelo gerente de contas.
Formato de erro
{
"success": false,
"message": "Descrição do erro"
}
Alguns endpoints retornam o formato alternativo:
{
"error": "Descrição do erro"
}