Skip to main content

​
Prerequisites

Before you begin, you need:
1

Approved Owem account

Account with completed onboarding approved by the Compliance team.
2

API credentials

API Key and Secret generated at Owem › Settings › Credentials.
3

IP in allowlist

Your static public IP must be registered in the allowlist.
The API Secret is displayed only once at creation time. Store it in a secure location (e.g., Secret Manager, environment variables).

​
Step 1: Test Authentication

Make a request to the /ping endpoint to validate your credentials: 
# Replace API_KEY and API_SECRET with your credentials
curl -X GET "https://api.owem.com.br/v4/i/ping" \
  -u "API_KEY:API_SECRET" \
  -H "Content-Type: application/json"
Expected response: 
{
  "requestId": "abc123...",
  "success": true,
  "size": 1,
  "message": "Ping OK",
  "data": "pong"
}
If you receive 401, check your credentials. If you receive 403, your IP is not in the allowlist.

​
Step 2: Check Balance

Verify your account balance: 
curl -X GET "https://api.owem.com.br/v4/i/bank-accounts/{ACCOUNT_ID}/balance" \
  -u "API_KEY:API_SECRET" \
  -H "Content-Type: application/json"

​
Step 3: Generate Your First QR Code

Create a PIX charge: 
curl -X POST "https://api.owem.com.br/v4/i/pix/in/dynamic-qrcode" \
  -u "API_KEY:API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "YOUR_ACCOUNT_ID",
    "userId": "YOUR_USER_ID",
    "amount": 10.00,
    "description": "Integration test"
  }'
Response: 
{
  "requestId": "...",
  "success": true,
  "size": 1,
  "data": {
    "txId": "abc123def456...",
    "dueDate": "2025-12-26T18:00:00.000Z",
    "emv": "00020101021226840014br.gov.bcb.pix..."
  }
}
The emv field is the PIX copy-and-paste. Use it to visually generate the QR Code.

​
Next Steps

Receive Payments

Complete PIX IN flow

Send Payments

Complete PIX OUT flow

Configure Webhooks

Receive real-time notifications

API Reference

Complete endpoint documentation