Welcome to the Ödeal Developer Portal
Your comprehensive integration guide for modern payment solutions
Quick Start
This portal contains everything you need for secure payment integration with the E-FaturaPos and Sadepos services.
Ödeal Services
E-FaturaPos
VUK 507 Compliant E-Document Solution
E-FaturaPos is a next-generation service that operates within the framework of VUK 507 regulation and automatically generates the e-document for transactions carried out on the device.
Key Features
- Automatic e-invoice generation
- E-archive invoice support
- Fully VUK 507 compliant
- Instant document delivery
SadePos
Simple & Secure Payment Solution
An EFT POS service with no cash register function, designed solely for receiving payments and collections.
Key Features
- Fast payment processing
- Easy integration
- Minimal configuration
- No e-document required
API Endpoints
The REST services you will use across all integration scenarios are served via the base URLs below.
https://stage.odealapp.com/api/v1https://api.odeal.com/api/v1Integration Profiles
Integrated Profiles
App2App
An ideal solution for owners of a mobile application
Seamless integration of the Partner and Ödeal applications installed on the device.
How It Works
- The basket is prepared in the partner application
- The payment transaction is transferred to Ödeal
- The payment is completed and the e-document is generated
Who Is It For?
- If you have your own mobile application
Device2Device
A powerful solution for users of external devices
A system in which the partner's device is integrated with the Ödeal POS device.
How It Works
- The basket is created on the partner's device
- It is sent to the Ödeal device
- The payment is completed on the Ödeal side
Who Is It For?
- If you have a web-based or desktop application on an external device such as a tablet or PC
Which Profile Fits You Best?
Use the table below to quickly choose the profile that best suits your needs.
| Criteria | Device2Device | App2App |
|---|---|---|
| 📱 Do you have a mobile application? | ❌ | ✅ |
| 💻 Are you creating baskets from an external device such as a tablet or PC? | ✅ | ❌ |
| 📄 Is e-document integration required? | ✅ | ✅ |
Non-Integrated Profiles
Internal Basket
A fully Ödeal-based solution
A profile in which transactions are received solely through the Ödeal application and the e-document is generated there.
Direct Charge
A simple collection solution
A profile in which only the payment/collection transaction is received through the Ödeal application.
Integration Services
Unit Service
RequiredGET /api/v1/unitsPurpose: Retrieves the list of product units (piece, kg, lt, etc.).
💡 Important Note
Unit codes must always be fetched before adding products. The Ödeal unit format must be used in App2App and Device2Device integrations.
Basket Service
Core ServicePOST /api/v1/basketPurpose: The core service through which basket transfers with partners are carried out.
Different integration models are supported depending on the profile.
Feedback Service
WebhookPOST /callback/payment-resultPurpose: The webhook service through which transaction results (sale, cancellation) and e-invoice notifications are delivered.
Callback Configuration
Don't forget to define your callback URL in the configuration service!
Configuration Service
Initial SetupPOST /api/v1/configurationPurpose: The service where the URLs and settings required for integration are registered.
Information to Be Registered
- Callback URLs
- Webhook secrets
- Endpoint configurations
Report Service
AnalyticsGET /api/v1/report/transactionsPurpose: The service through which transaction details occurring within a given date range are queried.
Available Filters
- Date range
- Transaction type
- Document status
- Amount range
Next Steps
Start Your Integration
1. Profile Selection
Determine the integration profile that suits you
2. API Key
Get your API key from Ödeal
3. Stage Test
Try out your integration in the test environment
4. Prod Deploy
Go live in production
Need help? Check out the API Reference section! 👉