Referência

Postman

Baixe a collection oficial da API OnnixPay com todos os endpoints, exemplos de payload e variáveis pré-configuradas. Importe no Postman e comece a chamar a API em segundos.

Baixar collection (.json)

Como importar

Baixe o arquivo onnixpay.postman_collection.json no botão acima.
No Postman: Import → arraste o arquivo (ou File → Import).
Abra a aba Variables da collection e preencha api_key com a sua chave sk_live_….
Rode Criar cobrança ou Criar pagamento. O id retornado fica salvo para os endpoints de consulta.

O que vem incluído

O header x-api-key já vem aplicado na collection inteira, lendo a variável api_key.
Cada POST gera um Idempotency-Key novo. Fixe idempotency_key quando quiser repetir a mesma operação sem duplicar nada.
O id de cobranças e pagamentos criados vai para charge_id e payout_id, então as consultas rodam sem copiar e colar.
Os exemplos cobrem cobrança por PIX e pagamento por chave, copia-e-cola e TED, cada um com resposta de exemplo.

Ambiente LIVE

As chaves sk_live_… operam contra produção: cobranças geram PIX reais e pagamentos movimentam saldo. Use valores baixos durante a integração.

Variáveis

base_url          https://apiv2.onnixpay.com
api_key           sk_live_…        (preencha com a sua chave)
idempotency_key   (opcional — fixe para repetir uma operação)
charge_id         (preenchido após "Criar cobrança")
payout_id         (preenchido após "Criar pagamento")

Automação

// Pre-request (POST): gera Idempotency-Key automático
if (pm.request.method === 'POST') {
  const fixed = pm.variables.get('idempotency_key');
  const key = (fixed && fixed.length >= 8)
    ? fixed
    : 'pm-' + pm.variables.replaceIn('{{$guid}}');
  pm.variables.set('_idempotency_key', key);
}

// Test (Criar cobrança): salva o id para a consulta
const body = pm.response.json();
if (body && body.id) pm.collectionVariables.set('charge_id', body.id);

AnteriorRate limiting