Postman Collection

Ready-to-import collection for Postman, Insomnia, or any compatible HTTP client.

Download

Download Postman Collection (JSON)

What's included

Category	Endpoints
PIX Cash-Out	Send by key, email, copy-paste, approve
PIX Cash-In	Generate QR Code
Queries	By ID, E2E, tag, external_id, receipt
Statement	Statement with filters and pagination
Balance	Account balance
PIX Keys	List keys
Refund	Request refund
Webhooks	Register, list, remove
MED	List and detail
Validation	CPF

Total: 22 endpoints

Setup

1. Import in Postman

1. Open Postman
2. Click Import (top left corner)
3. Drag the JSON file or click Upload Files
4. The "Owem Pay - API Externa" collection appears in the left panel

2. Configure variables

Click the collection > Variables tab and fill in:

Variable	Value	Description
base_url	https://api.owem.com.br/api/external	API base URL (production)
client_id	Your cli_...	API key Client ID
client_secret	Your sk_...	API key Client Secret

For staging, use https://api-hml.owem.com.br/api/external.

3. Automatic HMAC

The collection has a global pre-request script that automatically generates the hmac header (HMAC-SHA512) for all POST requests. No manual calculation needed.

4. Automatic variables

Test scripts automatically capture:

• last_transaction_id — from cash-out response
• last_e2e_id — from cash-out response
• last_qr_tx_id — from cash-in response

These variables are reused in subsequent queries.

Monetary values

Attention

Request: values in centavos (R$ 1.00 = 100)

Response: values in base units / subcentavos (R$ 1.00 = 10000)

To convert response to BRL: divide by 10,000.

Suggested workflow

1. Balance — GET /balance to check available balance
2. Cash-In — POST /pix/cash-in to generate QR Code
3. Cash-Out — POST /pix/cash-out to send PIX
4. Query — GET /transactions/:id to track status
5. Receipt — GET /transactions/:id/receipt for completed transactions

Import in Insomnia

1. Open Insomnia
2. Application > Preferences > Data > Import Data
3. Select From File and choose the JSON
4. Set up environment variables with the same values above