📬Response Params
object conditional
It denotes a pre-arranged contractual agreement with the paying customer, enabling the secure retention and future use of their payment details for specific purposes. These agreements encompass various payment arrangements, including recurring service payments like mobile subscriptions, installment payments for purchases, one-time charges such as account reloads, or compliance with industry practices like penalty fees for missed appointments. See the request parameter agreement for more information.
Presence condition:
This parameter should be included when the payment_type is set to "
auto_debit" On the other hand, it must not be sent when the payment_type is designated as "one_off" Importantly, this isn't restricted to just the initial transaction but should be consistently present in all following transactions associated with the "auto_debit" payment type.
In certain agreement types, the condition state becomes a required element. For further details on which parameters are mandatory for recurring agreements, please refer here.
string mandatory
Payment transaction total amount. The merchant should always check if the amount he receives from Ottu is the same amount of the order, to avoid user changing the cart amount in between. See the request parameter amount for more information.
string conditional
Attachment retrieval URL. See the request parameter attachment for more information.
Presence condition:
The attachment should be uploaded using attachment request parameter.
string conditional
A short attachment retrieval URL. Max length: 200.
Presence condition:
shortify_attachment_url request parameter should be "true" in order to generate it.
object conditional
Customer’s registered address data. See the request parameter billing_address for more information.
Presence condition:
Any child parameter provided with the billing_address object in the request payload will be populated in the response as billing_address child parameter.
object conditional
It outlines the rules for a card's payment eligibility See the request parameter card_acceptance_criteria for more information.
Presence condition:
Any child parameter provided with the card_acceptance_criteria object in the request payload will be populated in the response as card_acceptance_criteria child parameter.
string conditional
Short checkout url.
Presence condition:
shortify_checkout_url request parameter should be set to "true" in order to generate it.
string mandatory
URL that directs the customer to the Ottu Checkout Page where they can see the payment details and available payment methods for the transaction. If you need to share the payment link over SMS or WhatsApp, use checkout_short_url instead.
string mandatory
The code of the currency used in the transaction. See the request parameter currency_code for more information.
string conditional
Customer’s email address. See the request parameter customer_email for more information.
Presence condition:
customer_email request parameter should be provided.
string conditional
Customer’s first name. See the request parameter customer_first_name for more information.
Presence condition:
customer_first_name request parameter should be provided.
string conditional
It is a unique identifier assigned to a customer. This identifier can be used to distinguish one customer from another and can be utilized for tracking purposes or to retrieve specific customer information from the API. See the request parameter customer_id for more information.
Presence condition:
customer_id request parameter should be provided.
string conditional
Customer’s last name. See the request parameter customer_last_name for more information.
Presence condition:
customer_last_name request parameter should be provided.
string conditional
Customer's phone number. See the request parameter customer_phone for more information.
Presence condition:
customer_phone request parameter should be provided.
string date-time mandatory
It specifies the deadline for payment. It has no effect on changing the transaction state, and the transaction can be paid even after due_datetime. See the request parameter due_datetime for more information.
array of strings conditional
This is a list of internal email recipients, who will receive notifications sent to the customer about their payment. See the request parameter email_recipients for more information.
Presence condition:
email_recipients should be provided in the request payload.
string mandatory
It refers to the specific point in time after which the transaction cannot be paid anymore, and its state changes accordingly. See the request parameter expiration_time for more information.
object conditional
It represents additional data fields that can be dynamically added to the response using the extra request parameter. See the request parameter extra for more information.
Presence condition:
integer(initiator) conditional
The user who initiated the creation of this payment transaction, if available. This field is optional and may be used to track who created the payment transaction Max length: 11.
Presence condition:
It is present only when Basic Authentication is used, because API-Key Authentication is not associated with any user.
string mandatory
It represents the language code that is utilized for all communication related to payment transactions with the customer, including payment page, receipt, invoice, email, and SMS For more details check the request parameter language
object conditional
It represents the notification settings for this payment transaction which have been received and processed. See the request notifications for more information.
Presence condition:
Any child parameter provided with the notifications object in the request payload will be populated in the response as notifications child parameter.
string mandatory
Specifies the type of operation to be performed by the payment gateway. If set to 'purchase', the payment source will be directly charged. If set to 'authorize', the payment source will only be authorized and the actual charge will be made at a later time Max length: 16.
string conditional
It is a unique identifier assigned to the payment transaction, which is primarily used for tracking purposes. The identifier can be set by the merchant or the system. See the request parameter order_no for information.
Presence condition:
order_no request parameter should be included in the request payload.
array [object] mandatory
An array containing all the payment methods derived from the pg_codes input. Each object in the array contains information about a single payment gateway, including its icon and the redirect_url that will redirect the customer to the payment gateway's payment page
array mandatory
The options of the payment gateway codes included in the request payload to enable customers to make payments. See the request parameter pg_codes for more information.
string mandatory
It presents options such as "one_off" for one-time payments without future obligations and "auto_debit" for automated deductions, encompassing recurring subscriptions, installment payments, or unscheduled debits. For further details on the Auto Debit API and payment_type please refer to Auto-Debit API.
Default value: "one_off".
See the request parameter payment_type for more information.
string conditional
The nature of the purchased product or service, which can be employed for the purpose of keeping track and generating reports. See the request parameter product_type for more information.
Presence condition:
product_type request parameter should be included in the request payload.
string conditional
A QR code that, when scanned, redirects to the checkout page for this payment. This QR code may be displayed on invoices, receipts, or other documents to allow customers to easily access the checkout page and make a payment.
Presence condition:
The request parameter generate_qr_code should be set to "true".
string conditional
It represents the URL where the customer will be redirected after the payment stage is complete. See the request parameter redirect_url more information.
Presence condition:
The request parameter redirect_url should be provided.
object conditional
It is a JSON object containing preloaded data necessary for initializing the Checkout SDK. This data encompasses vital details such as customer information, available payment methods, and specific transaction details, all formatted according to the Checkout SDK's initialization specifications. By offering essential information upfront, this feature streamlines the checkout process, contributing to an improved user experience and increased efficiency.
It must be passed to the Checkout SDK constructor without any modifications.
Presence Conditions:
It will be included in the response solely when the include_sdk_setup_preload parameter is set to
true.
string mandatory
A unique identifier for each payment transaction, used to maintain the session state during the payment process. It can be used to perform subsequent operations, like retrieve, acknowledge, refund, capture, and cancellation.
object conditional
Shipping location data of the customer. See the request parameter shipping_address for more information.
Presence condition:
The child objects of the shipping_address parameter provided in the request object will be populated as child objects of the shipping_address parameter in the response object.
string mandatory
The current state of the payment transaction, it helps to understand the progress of the payment. Enum: "created" "pending" "attempted" "authorized" "paid" "failed" "canceled" "expired" "invalided" "refunded" "cod". See payment transaction state for more information.
string mandatory
The type of the payment transaction. See the request parameter type for more information.
string conditional
It represents the name of the merchant or vendor associated with a payment transaction. For more information see vendor_name.
Presence condition:
The request parameter vendor_name should be included in the request payload.
URL conditional
It contains the URL where the payment result will be sent via a POST request after the customer has completed the payment session. The payment result will be included in the request body. See Webhook Payment Notification.
Presence condition:
The request parameter webhook_url should be provided.
Last updated