The smarter way
  • Getting Started
  • USER GUIDE
    • Payment Gateway
    • Currencies
    • Apple Pay
      • Setup MPGS
      • Setup Cybersource
    • Payment Tracking
      • Payment Transactions Insights
      • Payment Transactions States
      • Notifications, URLs & Timing
    • Plugins
      • Payment Request
      • E-Commerce
      • Bulk payment request
    • Features
      • Refund & Void Access Control
      • Two-Step Refund & Void Authorization
    • Integration
    • Configuration
      • Global Configuration
      • Webhooks Configuration
      • Transaction Report Configuration
      • How to Get API Keys
      • URL Shortener Configuration
    • Notification Communication Channels
      • Email Notifications
      • SMS Notifications
      • WhatsApp Notifications
        • Integrated WhatsApp Channel
        • Manual WhatsApp Channel
      • Notification Templates
      • Notification Process: Automatic and Manual
    • Satellite
    • Real Estate
      • Regular Activities
        • Property management
        • Tenant and Contract Management
          • Tenant & Contract Dashboard
          • Tenant Management
          • Contract Management
            • Add New Contract
            • Contract Action
              • Renew Contract
              • Terminate Contract
              • Manual Payment
              • Suspend Contract
              • Resume Contract
              • Advance Payment
        • Generate Invoice
        • Invoices Management
        • Maintenance
        • Transactions
        • Auditing and Rolling Back Activities
      • Merchant First Journey
  • developer
    • Getting Started
    • Tokenization
    • Authentication
    • Payment Methods
    • Checkout API
    • Operations
    • User Cards
    • Payment Status-Inquiry
    • Auto-Debit
    • Invoice API
    • Message Notifications
    • Upload Attachment
    • Checkout SDK
      • Web
      • iOS
      • Android
      • Flutter
    • Webhooks
      • Payment Notification
      • Operation Notification
      • Signing Mechanism
      • Integration Guides
        • Laravel Webhook Receiver Guide
        • .NET Webhook Receiver Guide
    • Test Cards
Powered by GitBook
On this page
  • Ottu API
  • Key Concepts
  • API Selection Guide
  1. developer

Getting Started

PreviousMerchant First JourneyNextTokenization

Last updated 11 months ago

Welcome to Ottu’s API documentation! We have designed our platform to offer a unified API experience across all our endpoints. No matter which you choose, you’ll find the same intuitive interface, allowing you to integrate just once and leave the heavy lifting to us. Before diving into the technical details, you should familiarize yourself with a few key concepts that will recur throughout our documentation.

In the context of Ottu, the payment gateway holds the MID (Merchant ID) credentials provided by your bank. For more details on this, check the . Currently, our staff handle this configuration and will provide you with the needed for the API. Alternatively, you can fetch these codes using our Payment Methods API.

Currency configuration involves setting up the currencies you want to charge your customers. Ottu supports multi-currency transactions. If your MID is set up for KWD, but you want to display the charge amount to your customers in USD, we’ve got you covered. Your customers will see the amount in USD, but the actual funds will arrive in your bank account in KWD. Find more details in our .

Every payment or API operation starts with or involves a payment transaction. Essentially, this is the metadata for the payment. It includes information like amount, currency, customer data (email, phone number, address), and more. A payment transaction’s state can change based on the flow created, paid, expired, canceled, etc.). Learn more in the .

To get started with Ottu’s REST API, first understand our authentication methods in the . Then proceed to the to learn how to create payments and charge customers. Following this, you might want to explore the . This feature is crucial if you want to integrate Ottu with a system and get notified about payment status updates. After creating a payment transaction, you can specify a where Ottu will send updates about the payment status. This will keep your systems up to date in real-time with payment events. See .

Based on your specific needs, you can proceed to the sections that apply to your business:

For any other questions, please feel free to contact your local Ottu representative. Happy integration!

You don’t need to perform any additional steps. Just use the to create payment links and share them with your customers. They’ll land on Ottu’s checkout page, where we handle everything.

Our is perfect for you. Available for both web and mobile apps, it integrates seamlessly with the . Simply load the library and install it on your page, and it will manage the entire payment process.

These services work only with the . The SDK automatically enables these services on your website or app without any further configuration.

After familiarizing yourself with the , check the to understand how they work. If you wish to use these operations, the next step is to check the .

Check the and Docs.

Our sensitive API calls are signed for added security. Check out the .

Checkout API
Checkout SDK
Checkout API
Checkout SDK
Checkout API
Operations section
Webhook Operation Notification section
User Cards
Auto-Debit
Signing Mechanism section
CRM or Other Internal Systems
Ecommerce or Similar APPs
Apple Pay, Google Pay, and Other Payment Services
Refund, Capture, or Void Operations
Subscription, Recurring Payments, and Offline Payments
Concerned about Security?
payment gateway
Payment Gateway section
Authentication section
Checkout API section
Payment Notification Webhook
Webhook
Ottu API
Key Concepts
1. Payment Gateway
2. Currency Configuration
3. Payment Transaction
4. REST API
API Selection Guide
pg_codes
webhook URL
Currency Configuration section
Payment Transaction section