Skip to main content

​
Owem API

Welcome to the Owem API documentation. Our API allows you to integrate PIX payments, transfers and financial services into your application.

​
Base URL

https://api.owem.com.br

​
Authentication

All API requests require Basic Auth authentication. 
Authorization: Basic {Base64(API_KEY:API_SECRET)}

​
How to generate your token

1

Get your credentials

In the Owem dashboard, go to Settings > Credentials:
  1. Click + New Credential
  2. Choose the environment: Sandbox or Production
  3. Define the permission Scopes
  4. Enter a Name to identify the credential
  5. Add the Allowed IPs (static IP required)
  6. Click Continue
You will receive:
  • API_KEY - Your API key
  • API_SECRET - Your secret key
Keep your credentials secure! The API_SECRET is shown only once and cannot be recovered.
2

Generate the Base64 token

Concatenate your credentials in the format API_KEY:API_SECRET and convert to Base64.
const API_KEY = "your-api-key";
const API_SECRET = "your-api-secret";

const token = btoa(`${API_KEY}:${API_SECRET}`);
console.log(token);
// Result: eW91ci1hcGkta2V5OnlvdXItYXBpLXNlY3JldA==
3

Use the token in requests

Add the Authorization header with the Basic prefix:
curl -X GET "https://api.owem.com.br/v4/i/ping" \
  -H "Authorization: Basic eW91ci1hcGkta2V5OnlvdXItYXBpLXNlY3JldA=="
Security requirements: - In production, your STATIC IP must be in the allowlist - Never expose credentials in client-side code - Contact support to add your STATIC IP in production
Using the Playground: Enter the Base64 credential (with Basic prefix) in the authentication field. e.g.: Basic eW91ci1hcGkta2V5OnlvdXItYXBpLXNlY3JldA==

​
Response Structure

All responses follow this pattern: 
{
  "requestId": "uuid-for-tracking",
  "success": true,
  "size": 1,
  "data": { ... }
}
FieldTypeDescription
requestIdstringUnique UUID for tracking and audit
successbooleanIndicates operation success
sizenumberNumber of items returned
dataobject/arrayResponse data

​
Rate Limits

LimitValue
Requests per minute1000
Requests per second100
The x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset headers indicate rate limit status.

​
Environments

EnvironmentURLNotes
Productionhttps://api.owem.com.brIn production, your static IP must be allowlisted
Sandboxhttps://sandbox.api.owem.com.brNot yet available for client use

Get Started

Test your connection with the Ping endpoint