Skip to main content

​
API Terms

Public identifier for your Owem API access credential. Used with API Secret for authentication.
Secret key used for authentication. Shown only once at creation. Never share or expose in code.
Unique identifier for your Owem bank account. Used in balance and transfer operations.
HTTP authentication method that uses API_KEY:API_SECRET encoded in Base64 in the Authorization header.
Specific API URL that performs an operation. Example: /v4/i/pix/in/dynamic-qrcode.
Unique identifier you provide to correlate transactions with your internal system. Ensures idempotency.
Property that ensures multiple identical requests produce the same result. Implemented via externalId.
Accounting record of all financial movements in your account. Used for reconciliation and auditing.
Limit of requests allowed per period. When exceeded, receives status 429.
Unique UUID generated by the API for each request. Use for tracking and support.
HTTP notification sent by Owem to your URL when important events occur.

​
PIX Terms

Brazil’s instant payment system from the Central Bank. Allows 24/7 transfers in seconds.
PIX payment receipt. In the Owem API, done via dynamic QR Code.
PIX payment sending. Transfer to any PIX key.
Identifier to receive PIX. Can be CPF, CNPJ, email, phone, or random key (EVP).
QR Code with pre-defined value and information. Used for specific charges.
Reusable QR Code without defined value. The payer enters the value.
Unique 32-character identifier generated by the Central Bank for each PIX transaction. Format: `E`.
Owem’s internal identifier for a Ledger entry. Different from End-to-End ID.
Dynamic QR Code transaction identifier. Equivalent to entryId in the Ledger.
PIX QR Code payload standard. String used for “copy and paste”.
Brazilian Payment System Identifier. 8-digit code for each financial institution.
Return of a received PIX to the original payer.

​
Dispute Terms

Special Refund Mechanism (Mecanismo Especial de Devolução). Central Bank process for PIX refunds in fraud or error cases.
MED notification received. May be for suspected fraud, duplication, or operational error.
Formal response to a MED notification, presenting arguments and evidence.
Payment Service Provider. Institution that offers PIX services (like Owem).
Time available to respond to a MED. Varies according to infraction type.

​
Technical Terms

Binary-to-text encoding. Used to encode credentials in the Authorization header.
Authentication token type (not used by Owem, which uses Basic Auth).
Secure HTTP with TLS encryption. Required for all API requests.
JavaScript Object Notation. Data format used in API requests and responses.
Transport Layer Security. Encryption protocol used in HTTPS. Minimum: TLS 1.2.
Universally Unique Identifier. Format used for IDs in the API (e.g., requestId).
Time marking. In the Owem API, usually in milliseconds since epoch (1970-01-01).
International date representation standard. Example: 2025-12-26T15:30:00.000Z.

​
Transaction Status

StatusDescription
processingIn processing
succeededCompleted successfully
failedFailed
refundedRefunded
cancelledCancelled
pendingAwaiting processing

​
Webhook Events

EventDescription
pix_in:qrcode_paidQR Code was paid
pix_in:refund_succeededPIX IN refund completed
pix_in:refund_failedPIX IN refund failed
pix_out:succeededPIX OUT transfer completed
pix_out:failedPIX OUT transfer failed
med:createdNew MED received
med:updatedMED status updated