Developer Portal

API V2 Active,
7 Resources

API REST com 7 modules (accounts, payments PIX, invoices, customers, statements, login, notification), widget JS para integration client-side e docs white-label. Tudo para que seus developers integrem sem saber que a Ezcale existe.

first-transaction.sh
# Crie uma cobrança em 3 linhas
curl https://plataforma.ezcale.com/p/api/v2/payments \
  -H "Authorization: Bearer sk_test_..." \
  -d amount=15000 \
  -d currency="BRL" \
  -d payment_method="pix"

# Response
{
  "id": "ch_1a2b3c4d",
  "status": "pending",
  "amount": 15000,
  "pix_qr_code": "00020126..."
}
Quick Start

Integration em 3 Passos

Da chave de API à first cobrança PIX em produção.

1

Receba suas API keys

The tenant recebe credenciais de API via onboarding. Autenticação via Bearer token em all as chamadas.

Authorization: Bearer sk_live_...
2

Crie um pagamento PIX

Use a API V2 para create uma cobrança PIX. A engine config-driven trata roteamento e normalização automaticamente.

POST /api/v2/payments { method: "pix" }
3

Integre o Widget JS

Adicione o widget JS ao frontend of the tenant para checkout client-side. White-label com a tenant's brand.

<script src="ezcale-widget.js"></script>
Developer Tools

Tudo que o Dev Precisa, Nada que Atrapalha

Ferramentas de integration que seus developers vão querer usar.

API V2 — 7 Módulos

Accounts, Payments (PIX), Invoices, Customers, Statements, Login e Notification. Arquitetura config-driven: no code required custom por endpoint.

REST / JSON / Config-driven

Widget JS Client-Side

Componente JavaScript para integration direta no frontend of the tenant. Checkout, payment link e captura de dados — white-label, sem iframe.

Vanilla JS / Embed

Docs White-Label (Slate)

Documentation estilo Slate, white-labeled com a tenant's brand. Exemplos de request/response for each endpoint. Copie, cole, funciona.

Slate / White-label

Webhooks Integrados

Receba eventos de transação, transfer e credenciamento in real time. 5 handlers especializados com pipeline OOP.

5 handlers / OOP pipeline

API Config-Driven

Engine extensível para new endpoints: defina rota, validação e handler via configuration — no code required boilerplate. News recursos sem breaking changes.

Config-driven / Extensível

Auth & Multi-Tenant

Autenticação Bearer token com isolamento per tenant. Cada chamada é roteada ao contexto correto automaticamente. Sem leak cross-tenant.

Bearer / Tenant isolation
Code Samples

Copie, Cole, Funciona

Exemplos reais for each endpoint. Sem abstrações desnecessarys.

create-charge.sh
# Criar cobrança PIX com split
curl -X POST https://plataforma.ezcale.com/p/api/v2/payments \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 25000,
    "currency": "BRL",
    "payment_method": "pix",
    "customer": {
      "name": "Maria Silva",
      "tax_id": "123.456.789-00"
    },
    "split": [
      { "account": "acc_platform", "percentage": 10 },
      { "account": "acc_merchant", "percentage": 90 }
    ]
  }'

# Response 201 Created
{
  "id": "ch_9x8w7v6u",
  "status": "pending",
  "amount": 25000,
  "pix_qr_code": "00020126580014br.gov.bcb...",
  "pix_qr_code_url": "https://api.ezcale.com/qr/ch_9x8w7v6u.png",
  "expires_at": "2026-03-31T23:59:59Z"
}
create-charge.js
// Exemplo ilustrativo — SDK em desenvolvimento
// Hoje, use cURL ou fetch direto na API REST

const response = await fetch('https://plataforma.ezcale.com/p/api/v2/payments', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 25000,
    currency: 'BRL',
    payment_method: 'pix',
    customer: {
      name: 'Maria Silva',
      tax_id: '123.456.789-00'
    }
  })
});

const charge = await response.json();
console.log(charge.pix_qr_code);
create-charge.php
<?php
// Exemplo ilustrativo — SDK em desenvolvimento
// Hoje, use cURL direto na API REST

$ch = curl_init('https://plataforma.ezcale.com/p/api/v2/payments');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc',
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'amount'         => 25000,
        'currency'       => 'BRL',
        'payment_method' => 'pix',
        'customer'       => [
            'name'   => 'Maria Silva',
            'tax_id' => '123.456.789-00',
        ],
    ])
]);

$response = curl_exec($ch);
$charge   = json_decode($response);
echo $charge->pix_qr_code;

Cada Dev Convencido = Pipeline de 5 a 50 Merchants

Quando um developer integra a Ezcale na plataforma of the tenant, all os merchants daquele tenant transacionam por nós. Developer experience excepcional not é custo — é o better canal de aquisição B2B2B que existe. No Brasil, a barra é baixa: docs mediocres e sandboxes que not funcionam. Nós somos a exceção.

FAQ

Perguntas Frequentes

A API tem sandbox para testes?

A API V2 opera direto em produção com credenciais of the tenant. Not há ambiente sandbox separado — o onboarding é feito junto ao time de integration para garantir que tudo funcione before do go-live.

Quais modules a API V2 cobre?

7 modules ativos: Accounts (contas), Payments (PIX), Invoices (charges), Customers (cadastro), Statements (extrato), Login (autenticação) e Notification (alerts). All config-driven.

How it works o white-label for the tenant?

A Ezcale opera como infraestrutura invisível. Docs estilo Slate, widget JS e emails transacionais exibem a tenant's brand. Merchants never veem "Ezcale" — only a marca do cliente.

Existe portal self-service para developers?

Not há portal self-service público. O acesso às docs e credenciais é provisionado pelthe tenant durante o onboarding. A documentation Slate é white-labeled e acessível via domínio of the tenant.

Ready to Integrar?

API V2 com 7 modules, widget JS e docs white-label. Our team de integration acompanha do onboarding ao go-live.