Environments
The Owem API currently operates only in production environment.
| Environment | Base URL | Status |
|---|
| Production | https://api.owem.com.br | ✅ Available |
| Sandbox | - | 🚧 Coming soon |
There is currently no separate sandbox environment. For testing, use the
test: true parameter on supported endpoints.
Test Mode
Some endpoints support the test: true parameter to simulate operations without real effect.
Endpoints with Test Support
| Endpoint | Supports test |
|---|
POST /v4/i/pix/in/dynamic-qrcode | ✅ |
POST /v4/i/bank-accounts/{id}/transfer/external | ✅ |
Usage Example
{
"amount": 100.0,
"pixKey": "[email protected]",
"description": "Integration test",
"test": true
}
Transactions with test: true do not move real balance and do not appear in
the production Ledger.
Environment Variables
We recommend configuring the following variables in your environment:
Required Variables
| Variable | Description |
|---|
OWEM_API_KEY | Your credential’s API Key |
OWEM_API_SECRET | API Secret (never expose) |
OWEM_ACCOUNT_ID | Your Owem bank account ID |
Optional Variables
| Variable | Description | Default |
|---|
OWEM_BASE_URL | API base URL | https://api.owem.com.br |
OWEM_TIMEOUT | Timeout in ms | 30000 |
OWEM_WEBHOOK_SECRET | Secret for webhook validation | - |
Configuration Examples
# Owem Credentials
OWEM_API_KEY=01ade144-6970-47d0-989d-3d90beed0ed3
OWEM_API_SECRET=7a0bf60a025796674df3b81852ec2e96...
OWEM_ACCOUNT_ID=572471114780
# Settings
OWEM_BASE_URL=https://api.owem.com.br
OWEM_TIMEOUT=30000
ENV OWEM_API_KEY=your_api_key
ENV OWEM_API_SECRET=your_api_secret
ENV OWEM_ACCOUNT_ID=your_account_id
ENV OWEM_BASE_URL=https://api.owem.com.br
apiVersion: v1
kind: Secret
metadata:
name: owem-credentials
type: Opaque
stringData:
OWEM_API_KEY: your_api_key
OWEM_API_SECRET: your_api_secret
OWEM_ACCOUNT_ID: your_account_id
| Header | Value | Description |
|---|
Authorization | Basic {token} | Base64 authentication token |
Content-Type | application/json | Content type |
| Header | Value | Description |
|---|
X-Idempotency-Key | UUID | Idempotency key |
X-Request-Id | UUID | Custom tracking ID |
The API returns useful headers for monitoring:
| Header | Description |
|---|
X-RateLimit-Limit | Request limit per period |
X-RateLimit-Remaining | Remaining requests |
X-RateLimit-Reset | Reset timestamp (epoch) |
X-Request-Id | Unique request ID |
Use the X-Request-Id when opening support tickets to speed up investigation.
Recommended Timeouts
| Operation | Suggested Timeout |
|---|
| Ping / Health check | 5s |
| Queries (GET) | 15s |
| QR Code generation | 30s |
| PIX transfers | 60s |
| Webhooks (response) | 3s |
Webhooks that don’t respond within 3 seconds are considered failed and
enter retry.
