The Smarter Way
Search…
⌃K

Payment Request

​Getting started​

Don't integrate with this API; use checkout-API instead Checkout API​

​Base URLs​

POST {ottu_url}/pos/crt/​
The variable URL is the installation domain. The URL must be secure, i.e.: https://

​Body parameters​

​Inbound​

Required
amount string
Against currency type for the decimal places.
currency_codestring
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.
customer_email
initiator integer
ID of the user who initiates the transaction.
Optional

gateway_codestring

Gateway account code defined in admin panel.

languagestring

ISO 639-2 language code. https://www.loc.gov/standards/iso639-2/php/code_list.php. Max length: 2.

order_nostring

Merchant unique identifier. Max length: 128.

email_payment_details bool

Send email to the customer with payment result details. Validated against customer_email.

sms_payment_details bool

Send email to the customer with payment result details.

sms_notificationbool

Send email to the customer with payment result details. Validated against customer_phone.

email_notificationbool

Send payment link to customer to pay via email. Validated against customer_email.

customer_phone string

International phone number, with prefix. Max length: 16.

customer_first_name

customer_last_name

customer_address_line1 string

no specific limit.

customer_address_line2 string

no specific limit.
customer_address_city string
Add a default address from admin. Max length: 40.

customer_address_state string

Max length: 40.

customer_address_country string

Max length: 40.

customer_address_postal_code integer

Max length: 12.

redirect_urlstring

URL where the user to be redirected after payment process has completed. Note that includes in query string order_no and reference_number. Can be set in admin panel also. Max length: 200.

disclosure_urlstring

URL where to send the payment result details. Must return a http status 200, in order to proceed with redirection to redirect_url. Can be set in admin panel also. Max length: 200.

initiator string

URL where to send the payment result details. Must return a http status 200, in order to proceed with redirection to redirect_url. Can be set in admin panel also. Max length: 200.
Merchant sends a request to the API endpoint
​https://pay.{yourdomain}/pos/d/crt/​
where Ottu is installed.

​Post request​

{
"gateway_code":"kpay",
"currency_code":"KWD",
"amount":"3",
"order_no":"Cust001",
"full_name":"Saifuddin Tahir",
"customer_email":"​[email protected]​",
"customer_phone":"96597117060",
"initiator":"2",
"disclosure_url":"http://postapp.knpay.net/disclose_ok/",
}
Ottu will respond back the Payment transaction details in POST request to this URL ​disclosure_url​ specified by the merchant while initiating the payment request, ​disclosure_url ​should return ​HTTP​ status ​200 ​and Merchant should save the payload in DB, If ​disclosure_url ​doesn’t return​ HTTP ​status​ 200 ​then user will be redirected to Ottu response page and Transaction details will be displayed. Ottu GET to ​redirect_url ​with 2 parameters, ​order_no​ as ​TT01 ​and ​reference_number 45FGX​,​ ​now on ​redirect_url merchant will fetch the data from DB and based on the ​result ​field customer will be redirected to success or failure page (created by Merchant).

​Post response​

{
"full_name":"Saifuddin Tahir",
"customer_email":"​[email protected]​",
"customer_phone":"96597117060",
"Gateway_name":"kpay",
"order_no":"TT01",
"reference_number":"45FGX",
"gateway_response":{
"result":"CAPTURED",
"postdate":"0531",
"ref":"715014026964",
"trackid":"45FGX",
"tranid":"1870568381471500",
"udf1":"TT01",
"udf3":"Saifuddin Tahir",
"udf2":"​[email protected]​",
"eci":"7",
"responsecode":"00",
"paymentid":"8972815371471500",
"auth":"442382",
"udf4":"96597117060"
},
"amount":"3.000",
"result":"success",
"gateway_account":"kpay",
"currency_code":"KWD"
}
Last modified 27d ago