Checkout API
Ottu's Checkout API collection offers a robust suite of tools designed to streamline the payment processing experience for merchants and developers alike. This comprehensive API collection facilitates seamless payment initiation and management, ensuring efficient and secure transactions. Whether through API-based or SDK-based implementations, the Checkout APIs provide critical functionalities required for modern e-commerce environments.
Create Payment Transaction: This API is pivotal for initiating payment transactions. It enables the creation of a payment transaction and generates a
session_id, which is crucial for further transaction processing. For an in-depth understanding of this API, please refer to the Create Payment Transaction section.Update Payment Transaction: Essential for modifying existing payment transactions, this API uses the
session_idto identify and update transactions accordingly. Detailed information is available in the Update Payment Transaction section.Retrieve Payment Transaction: This API is designed to fetch details of existing payment transactions using the
session_id. It ensures that merchants can access transaction details as needed. Further exploration can be done in the Retrieve Payment Transaction section.Upload Attachment API: Allows merchants to attach files to a transaction, enhancing the flexibility and documentation capabilities of the payment processing system. For more details on how to use this API, visit the Upload Attachment section.
To enhance your integration process, consider leveraging our official packages designed specifically for the Checkout API. These packages reduce the complexity of API integration by encapsulating the necessary logic, allowing you to focus on core business functionalities.
Available Packages:
Python SDK: Facilitates access to checkout functions with a Pythonic interface, streamlining developer tasks by abstracting complex API interactions. Learn more
Django SDK: Seamlessly integrates checkout functionalities into Django projects, equipped with Django-specific tools and utilities that simplify payment processes. Explore details
Understanding the key concepts and structures documented is vital for robust and maintainable integration of these packages, ensuring both speed and convenience.
In order to ensure optimal transaction success tracking and minimize the number of required payment transactions, merchants should create a Payment Transaction as soon as the amount is known. This typically occurs when a customer adds their first item to their cart. Following this, any changes to the total amount should be updated using the Checkout API PATCH method.
By updating the same payment transaction, rather than creating a new one for each payment attempt, merchants can more effectively trace customer interactions with their cart. This is particularly useful for events such as insufficient funds, where a customer may remove an item from their cart and successfully complete a transaction on their next attempt. Tracking and analyzing such events can help merchants make data-driven decisions for future improvements.
Permissions are managed using Basic Authentication and API-Key. Specifically, Basic Authentication is used to grant permissions for creating, updating, and reading data, as well as using allowed PG codes when creating or updating payment transactions.
It is important to ensure that the appropriate level of permissions is assigned to each user or application using the APIs. This can help to prevent unauthorized access or modification of sensitive data. Additionally, it is recommended to rotate API-Keys on a regular basis and to use secure password storage practices when using Basic Authentication.
Ottu Checkout API supports different levels of permissions for the Payment Request and E-Commerce plugins. The permissions depend on the authentication method being used.
When using the API-Key, all permissions are granted by default, as the API-Key is considered to have admin permissions. See How to Generate API Keys
For Basic Authentication, permissions are granted as follows:
To create a transaction, the user needs specific permission depending on the plugin being used:
"Can add payment requests" for the Payment Request plugin
"Can add e-commerce payments" for the E-Commerce plugin
Permission to use the payment gateway code is also required: "Can use
pg_code"
To update a transaction, the user needs specific permission depending on the plugin being used:
"Can change payment requests" for the Payment Request plugin
"Can change e-commerce payments" for the E-Commerce plugin
Permission to use the payment gateway code is also required: "Can use
pg_code"
By default, if a user has either the "Can add" or "Can change" permission, they can fetch transactions from the API.
For more granular control, the following view permissions can be used:
"Can view e-commerce payments" for the E-Commerce plugin
"Can view payment requests" for the Payment Request plugin
Thank you for exploring the Checkout API documentation. Ottu's Checkout APIs are designed to provide a robust, secure, and efficient toolset for the seamless handling of payment transactions. Whether payment transactions are being created, updated, or retrieved, the Checkout APIs are tailored to enhance operational capabilities and ensure a superior payment experience for customers.
Detailed guidance on each Checkout API, including setup instructions, request and response parameters, and practical examples, can be found in the specific sections outlined in this documentation.
Ottu is committed to supporting the integration journey every step of the way, ensuring that the benefits of the Ottu payment platform are leveraged efficiently and securely.
Last updated