Ambientes

Base URL (Produção)

https://receivables-api.zemocapital.com

Atualmente a API expõe apenas o ambiente de Produção. O ambiente de Sandbox (host dedicado) está em preparação e será documentado aqui assim que disponível.

O tipo de credencial é indicado pelo prefixo: zk_live_* (Produção). Credenciais de teste (zk_test_*) serão emitidas para o Sandbox quando ele entrar no ar.

Teste interativo do portal ("Testar no navegador")

A ferramenta interativa em /reference envia requisições diretamente para o ambiente de Produção (sem proxy de terceiros). Como a plataforma emite credenciais distintas para Produção e Homologação, use exclusivamente credenciais de homologação ao testar por aqui — assim você valida integrações sem impactar dados reais.

Identificação de ambiente

Toda resposta inclui o header X-Zemo-Env (prod, sandbox, dev). Em Sandbox, o header X-Zemo-Banner: SANDBOX também é incluído.

Especificação OpenAPI (fonte canônica para ferramentas)

Para Postman, Insomnia, geradores de SDK e agentes de IA, use o spec estático — sempre acessível e estável:

https://docs.zemocapital.com/openapi.json

• Referência técnica interativa (humanos): /reference (Scalar) — parâmetros, schemas e exemplos.
• O endpoint live /v1/openapi.json também existe, mas o caminho recomendado para ferramentas é o spec estático acima.

Postman Collection

Importe a collection para testar os endpoints rapidamente:

• Download: postman_collection.json (gerada automaticamente do OpenAPI)

Variáveis a configurar:

Variável	Valor
base_url	https://receivables-api.zemocapital.com
client_id	Seu X-Client-Id
client_secret	Seu X-Client-Secret

SDK Python

pip install zemo

import zemo

zemo.user = zemo.Originator(
    client_id="zk_live_...",
    client_secret="sk_live_...",
    environment="production",
)

Veja o Quickstart para um exemplo completo (autenticar → simular).

Limitações por ambiente

Feature	Produção
Transações reais PIX	Sim
ZapSign (contratos)	Sim
Rate limiting	120 rpm
SSL/TLS	Obrigatório