📬Response Params
Last updated
Last updated
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 for more information.
Presence condition:
This parameter should be included when the is set to "auto_debit" On the other hand, it must not be sent when the 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.
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 for more information.
string conditional
Attachment retrieval URL. See the request parameter for more information.
Presence condition:
The attachment should be uploaded using request parameter.
string conditional
A short attachment retrieval URL. Max length: 200.
Presence condition:
object conditional
Presence condition:
object conditional
Presence condition:
string conditional
Presence condition:
string mandatory
string mandatory
string datetime optional
Presence condition:
string conditional
Presence condition:
string conditional
Presence condition:
string conditional
Presence condition:
string conditional
Presence condition:
string conditional
Presence condition:
string date-time mandatory
array of strings conditional
Presence condition:
string mandatory
object conditional
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:
string mandatory
object conditional
Presence condition:
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
Presence condition:
array [object] mandatory
array mandatory
string mandatory
string conditional
Presence condition:
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:
string conditional
Presence condition:
object conditional
Presence Conditions:
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
Presence condition:
string mandatory
string mandatory
string conditional
Presence condition:
URL conditional
Presence condition:
request parameter should be "true" in order to generate it.
Customer’s registered address data. See the request parameter for more information.
Any child parameter provided with the object in the request payload will be populated in the response as child parameter.
It outlines the rules for a card's payment eligibility See the request parameter for more information.
Any child parameter provided with the object in the request payload will be populated in the response as child parameter.
Short
request parameter should be set to "true" in order to generate it.
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 instead.
The code of the currency used in the transaction. See the request parameter for more information.
Customer's date of birth. For more information, please refer to .
request parameter should be provided.
Customer’s email address. See the request parameter for more information.
request parameter should be provided.
Customer’s first name. See the request parameter for more information.
request parameter should be provided.
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 for more information.
request parameter should be provided.
Customer’s last name. See the request parameter for more information.
request parameter should be provided.
Customer's phone number. See the request parameter for more information.
request parameter should be provided.
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 for more information.
This is a list of internal email recipients, who will receive notifications sent to the customer about their payment. See the request parameter for more information.
should be provided in the request payload.
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 for more information.
It represents additional data fields that can be dynamically added to the response using the extra request parameter. See the request parameter for more information.
Any child parameter provided with the object in the request payload will be populated in the response as object child parameter.
It is present only when is used, because Authentication is not associated with any user.
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
It represents the notification settings for this payment transaction which have been received and processed. See the request for more information.
Any child parameter provided with the object in the request payload will be populated in the response as child parameter.
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 for information.
request parameter should be included in the request payload.
An array containing all the payment methods derived from the input. Each object in the array contains information about a single payment gateway, including its icon and the that will redirect the customer to the payment gateway's payment page
This URL redirects to the payment page.See
The options of the payment gateway codes included in the request payload to enable customers to make payments. See the request parameter for more information.
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 .
Default value: "one_off".
See the request parameter for more information.
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 for more information.
request parameter should be included in the request payload.
The request parameter should be set to "true".
It represents the URL where the customer will be redirected after the payment stage is complete. See the request parameter more information.
The request parameter should be provided.
It is a JSON object containing preloaded data necessary for initializing the . 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 , contributing to an improved user experience and increased efficiency.
It will be included in the response solely when the parameter is set to true.
Shipping location data of the customer. See the request parameter for more information.
The child objects of the parameter provided in the request object will be populated as child objects of the parameter in the response object.
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 for more information.
The type of the payment transaction. See the request parameter for more information.
It represents the name of the merchant or vendor associated with a payment transaction. For more information see .
The request parameter should be included in the request payload.
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 .
The request parameter should be provided.