iOS SDK¶
This documentation details the process to integrate Khalti payment gateway in your iOS app.
Example¶
Swift : Clone project and use 'Example' directory. Do 'pod install'.
Objective-C : Clone project and use 'Example Obj-c' directory. Do 'pod install'.
Installation guide¶
Khalti is available through CocoaPods. To install it, simply add the following line to your Podfile:
Usage¶
Adding CustomSchme¶
Khalti uses custom Scheme: So merhant should setup URLScheme unique for their app. We have made usability as of user case.
After adding Url Scheme create global constant for same customUrlScheme as below
Requirements¶
To work around with this redirection you have to implement some openUrl in Appdelegate.swift
.
Khalti.shared.defaultAction()
returns true
if you initiate payment through Khalti.
Khalti.shared.action(with: url)
is needed for complete action after ebanking and card payment.
Note: Using Khalti.shared.action(with: url)
is mandatory.
Add following code to Appdelegate.swift
func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool {
Khalti.shared.action(with: url)
return Khalti.shared.defaultAction() // Or true
}
Using at particular ViewController¶
At your viewController during action of pay add initiate config file
When instantiating Config
pass public key, product id, product name, amount (in paisa).
Product web url and additional data are optional.
let TEST_CONFIG:Config = Config(publicKey: khaltiMerchantKey, amount: 1000, productId: "1234567890", productName: "Dragon_boss", productUrl: "http://gameofthrones.wikia.com/wiki/Dragons",additionalData: additionalData)
// Data passed here are based on Example project
Note: Public is provided to every merchant of khalti. Intially test is available to every merchant and live key is provided after MoU signup with Khalti.
At this stage the scheme named you declared earlier is passed to Khatli.shared.appUrlScheme
Khalti.shared.appUrlScheme = khaltiUrlScheme // see above for file khaltiUrlScheme
// This can be used at appdelegate during didfinishlaunching.
// This should be mandatory
Finally present the khaltiPay Viewcontroller by calling public funcation
Params of present function of Khalti
param | Value |
---|---|
caller | viewController from where you initate payment. |
with | Config object |
delegate | self |
Delegate must be assigned to same Viewcontroller to get callback action from KhaltiPayDelegate.
Example as used in Example Project¶
let extra:[String : Any] = ["no":false,"yes":true,"int" : 0, "float":12.23]
let jsonData = try? JSONSerialization.data(withJSONObject: extra, options: JSONSerialization.WritingOptions())
let jsonString = String(data: jsonData!, encoding: .utf8)!
let additionalData:Dictionary<String,String> = [
"merchant_name" : "HelloPaaaaisaPVTLtd.",
"merchant_extra" : jsonString
]
Khalti.shared.appUrlScheme = khaltiUrlScheme
let khaltiMerchantKey = "test_public_key_dc74e0fd57cb46cd93832aee0a507256" // This key is from local server so it won't work if you use the example as is it. Use your own public test key
let TEST_CONFIG:Config = Config(publicKey: khaltiMerchantKey, amount: 1000, productId: "1234567890", productName: "Dragon_boss", productUrl: "http://gameofthrones.wikia.com/wiki/Dragons",additionalData: additionalData, cardPayment:false)
Khalti.present(caller: self, with: TEST_CONFIG, delegate: self)
merchant_
prefix in your map key.
Using delegates¶
The viewController you implement pay action should contain KhaltiPayDelegate implementing
onCheckOutSuccess(data: Dictionary<String, Any>)
onCheckOutError(action: String, message: String)
extension YourViewController: KhaltiPayDelegate {
func onCheckOutSuccess(data: Dictionary<String, Any>) {
print(data)
print("Oh there is success message received")
}
func onCheckOutError(action: String, message: String) {
print(action)
print(message)
print("Oh there occure error in payment")
}
}
Summary¶
Callback Methods¶
Method | Description |
---|---|
onCheckOutSuccess(data: Dictionary<String, Any>) |
This method is called when a transaction has been completed and confirmed by the user. A dictionary containing an access token, required to verify the transaction and data passed through Config instance is returned. Once this method is called, use the access token to verify the transaction. Please follow the verification process for further instructions. |
onCheckOutError(action: String, message: String, data:Dictionary<String,Any>?) |
This method is called when an error occurs during payment initiation and confirmation. Action, message and errordata value is passed where action defines, the current action being performed, message defines the error and data defines the errorData associated with error if exists. |
Response Sample¶
Success Messsage¶
Key | Value | Type |
---|---|---|
mobile | 98XXXXXXXX | String |
product_name | Product Name | String |
product_identity | Product Id | String |
product_url | Product Url | String |
amount | 100 | Int |
token | token | String |
cardPayment | false | Bool |
The success message also contains all the key
and value
provide as extra data while initiating Config
.
Error Messsage¶
Variable | Description | Type |
---|---|---|
action | initiate/confirm/ebanking | String |
message | Detail Error Message | String |
data | data of error (Optional) | Dictionary |
Support¶
For Queries, feel free to mail us at: merchant@khalti.com
Check out the API Documentation.