Request & Response Parameters Specifications
In this manual, you will find a comprehensive guide to both required and optional API parameters used across our five integration types: Hosted Payment Page, Invoices, Managed Form, Own Form, and PayLinks. Each article within this folder focuses on a specific parameter, detailing its purpose, validation rules, and whether it is required or optional for a particular integration type.
These parameters are essential for defining and customizing various transaction aspects, from identifying merchant profiles and transaction types to handling advanced features like tokenization, customer details, and card filtering. Whether you are integrating payments through a simple Hosted Payment Page, generating invoices, or embedding payment options using Managed Form or Own Form, these parameters ensure a smooth and secure payment process.
By following this manual, you will gain a deep understanding of how each parameter fits into your integration, ensuring that your payment systems are flexible, secure, and optimized for your specific business needs. Whether you are using PayLinks for quick payment generation or fully managing transactions through custom forms, this guide will be your go-to resource for setting up and maintaining a seamless payment experience across all integration types.
📄️ Profile Id (profile_id)
📄️ Transaction Type (tran_type)
📄️ Transaction Class (tran_class)
📄️ Cart ID (cart_id)
📄️ Cart description (cart_description)
📄️ Cart Currency (cart_currency)
📄️ Cart Amount (cart_amount)
📄️ Return URL (return)
📄️ Callback URL (callback)
📄️ Tokenization (tokenise/token)
📄️ Hide Shipping (hide_shipping)
📄️ Customer Details (customer_details)
📄️ Card Discounts (card_discounts)
📄️ Card Filter (card_filter, card_filter_title)
📄️ Donation Mode (donation, cart_min, cart_max)
📄️ Iframe Mode (framed, framed_return_parent, framed_return_top, framed_message_target)
With our iFrame Mode feature, you can enhance the checkout experience by keeping customers on your site throughout the payment process. Instead of redirecting them to a separate payment page, you can embed the hosted payment page directly within your site using an iframe, providing a seamless and integrated experience.