↪️Ecommerce (obsolete)
Don't integrate with this API; use checkout-API instead Checkout API. Ottu offers ecommerce plugin, which empowers merchants business and facilitates the payments against the products.
POST {ottu_url}/pos/crt/
The variable URL is the installation domain. The URL must be secure, i.e.: https://...
amount
string required
Against currency type for the decimal places.
gateway_code
string required
Gateway account code defined in admin panel.
currency_code
string required
Letters only. ISO 4217 codes https://en.wikipedia.org/wiki/ISO_4217. Validated against the gateway settings currencies list defined in admin. Max length: 3.
language
string optional
ISO 639-2 language code. https://www.loc.gov/standards/iso639-2/php/code_list.php. Max length: 2.
order_no
string optional
Merchant unique identifier. Max length: 128.
email_payment_details
bool optional
Send email to the customer with payment result details. Validated against customer_email.
sms_payment_details
bool optional
Send email to the customer with payment result details. Validated against customer_phone.
sms_notification
bool optional
Send payment link to customer to pay via SMS. Validated against customer_phone.
email_notification
bool optional
* Send payment link to customer to pay via email. Validated against customer_email.
customer_email
optional
Customer email. Validated against customer_email.
customer_phone
string optional
International phone number, with prefix. Max length: 16.
customer_first_name
string optional
customer_last_name
string optional
customer_address_line1
string optional
no specific limit.
customer_address_line2
string optional
no specific limit.
customer_address_city
string optional
Add a default address from admin. Max length: 40.
customer_address_state
string optional
Max length: 40.
customer_address_country
string optional
ISO 3166-1 alpha-2 – two-letter country codes https://en.wikipedia.org/wiki/ISO_3166-1. Max length: 2.
customer_address_postal_code
integer optional
Max length: 12.
vendor_name
string optional
Vendor name is mapped to udf6 for kpay or knet. Max length: 64.
email_recipients
string optional
Comma separated emails. Recipients to receive emails, beside customer_email.
product_type
string optional
Product information. Max length: 128.
redirect_url
string (optional, if is set in admin control)
URL where the user to be redirected after payment process has completed. Note that in includes in query string order_no and reference_number. Can be set in admin panel also. Max length: 200.
disclosure_url
string (optional, if is set in admin control)
URL where to send the payment result details. Must return a http status 200, in order to proceed with redirection to redirect_url. Can also be set in admin panel. Max length: 200.
capture_address
bool (required, if the multi step is enabled)
It will display the form fields if received True in a request payload and the child plugin of multi step is enabled.
capture_delivery
bool (required,if multi step child plugin is enabled)
It will display the Map to mark the location, upon accessing the payment request link by customer, when the multistep child plugin is enabled.
extra
key value pair {} optional
Anything sent here will be sent back as a query string when redirecting the customer back to the merchant website. Must be valid JSON.
amount
string required
result
string required
Payment status, which can be "success", "canceled", "failed" or "error".
currency_code
string
message
string optional
Error message in case of a failed payment.
reference_number
string required
Ottu unique identifier.
order_no
string required
bulk_id string
customer_first_name
string required, if present in inbound payload
customer_last_name
string required, if present in inbound payload
customer_phone
string required, if present in inbound payload
customer_email
string required, if present in inbound payload
customer_address_line1
string required, if present in inbound payload
customer_address_line2
string required, if present in inbound payload
customer_address_city
string required, if present in inbound payload
customer_address_state
string required, if present in inbound payload
customer_address_postal_code
string required, if present in inbound payload
customer_address_line2
string required, if present in inbound payload
vendor_name
string required, if present in inbound payload
Merchant sends a request to the API endpoint
https://pay.{yourdomain}/pos/d/crt/
where Ottu is installed.
Last updated