Public iOS framework for the MyOrder payments SDK. Check the online API documentation here
The iOS SDK is delivered as a compiled framework. It can be installed by manually adding the framework and its dependencies to your project or by the use of CocoaPods.
Add the following to your Podfile
pod "MyOrder"
Additionally, if CreditCard or PayPal providers are used add:
pod "CardIO", "~>3.10.0"
pod "PayPalMPL", "~>2.1.0"
# Use this podspec if official PayPal pod is broken
#pod 'PayPalMPL', podspec: 'https://gist.githubusercontent.com/angelolloqui/82768cbbc27da2c2e3ea/raw/35d77377edb57265db877db671c9a2c1c6df3c22/PayPalMPL.podspec.json'
And finally, if you want to make use of a generic HUD indicator, the lib supports SVProgressHUD automatically (more information below). Add it by:
pod "SVProgressHUD", "~>1.0.0"
And run pod install in your project.
CocoaPods is preferred as it is lot easier to install. However if you prefer a manual installation then do:
- Download the iOS SDK, drag and drop the
MyOrder.frameworkfolder into your Frameworks project group and make sure that the copy option is marked. - Open your project Build Settings, look for "Header Search Paths" and add "${SRCROOT}/MyOrder.framework" recursive.
- Add the MyOrder.bundle folder contained inside the MyOrder.framework into your project tree.
Additionally, make sure that the following Apple frameworks are included in your project:
AddressBook(Required)AddressBookUI(Required)Security(Required)
And these third party dependencies:
- TPKeyboardAvoiding (Required)
- SVProgressHUD (Optional. Configure
MOProgressHUDif a different HUD wanted. More information below) - PayPalMPL (Only required when PayPal is used as a payment method)
- CardIO (Optional, adds a camera card reader to the credit card payments)
Instructions on how to install the previous libraries can be found in their webpages.
Before using the MyOrderSDK, you need to set up the credentials. You can do it by placing the following code before its use (typically in your AppDelegate application:didFinishLaunchingWithOptions method):
MyOrder *myOrder = [MyOrder shared];
myOrder.apiKey = @"36bd8913-bf56-4aa0-9492-49a3240597ea";
myOrder.apiSecret = @"12H@c9kT$At";
myOrder.URLScheme = @"myapp-scheme";
Please, note that you will need your own apiKey and apiSecret. You can request them on the Official MyOrder developers portal.
Your URL Scheme is used to open the app after an iDeal transaction has been made, and therefore it is required when iDeal is active. Set a URL Type in your project Info settings and use the same for the lib URLScheme, and implement this method in your delegate:
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
return [[MyOrder shared] handleURL:url];
}
Additionally, you can customize other MyOrder properties depending on your project needs:
environment: useMyOrderEnvironmentLivefor real money operations orMyOrderEnvironmentSandboxorMyOrderEnvironmentPlaygroundfor testing purposes.defaultMerchantDescription: Customize the description that some services like iDeal will show in the bank description receipt.- Available payment providers can be changed by using the
configureWithPaymentProvidersmethod. Example:
[myOrder configureWithPaymentProviders:@[@"iDeal", @"MiniTix"]];
- Available payment operations can be changed by using the
configureWithPaymentOperationsmethod. Example:
[myOrder configureWithPaymentOperations:@[@"PayYourFriends", @"AutomaticCharge"]];
A list of all available payment providers and operations can be retrieved by [myOrder availablePaymentProviders] and [myOrder availablePaymentOperations]
Wallet can be presented by the use of walletViewControllerWithLogin method. Example:
UIViewController *vc = [[MyOrder shared] walletViewControllerWithLogin:YES];
[self.navigationController pushViewController:vc animated:YES];
Note that if login is required but the user is not logged in yet, then the SDK will return a Login UI controller instead of the wallet one, and will automatically redirect to the wallet when login is performed by changing the navigationController stack. If Login is passed to NO, you will need to deal with login sessions yourself.
Payments can be easily performed by using the paymentViewControllerForOrder method. Note that you need to create a MOOrder with the order information. Example:
MOOrder *order = [MOOrder new];
order.externalOrderId = @"12345";
[order addItemWithName:@"MyOrder demo item" price:5.5 quantity:2];
UIViewController *vc = [[MyOrder shared] paymentViewControllerForOrder:order forceLogin:YES onCompletion:nil];
[self.navigationController pushViewController:vc animated:YES];
Similarly to the wallet method, making a payment does not necessarily require login. However, If the user is not logged in, some payment methods will not be presented no payment methods will be presented. If login is required, then this method could potentially return a controller for login in, already set up for continuing with the payment when successfully logged in.
If you know which payment method to use (for example if you customize the UI for selecting payments in your app), then you can open an specific payment method screen by using:
//Custom way to start a particular payment and add blocks
MOTransactionViewController *transactionVC = [[MyOrder shared] transactionViewControllerForProvider:@"iDeal"];
transactionVC.transaction.order = order;
[transactionVC startInNavigationController:self.navigationController];
Additionally, this way gives you some extra blocks to perform custom actions when the transaction has an error, is completed or started. Example:
transactionVC.startBlock = ^(MOTransactionViewController *vc) {
//Custom logic to control whether the transaction is ready. Return YES to allow start
return YES;
};
transactionVC.completionBlock = ^(MOTransactionViewController *vc) {
[[[UIAlertView alloc] initWithTitle:nil message:@"Completed" delegate:nil cancelButtonTitle:@"close" otherButtonTitles:nil] show];
[vc.navigationController popToRootViewControllerAnimated:YES];
};
transactionVC.cancelBlock = ^(MOTransactionViewController *vc) {
[[[UIAlertView alloc] initWithTitle:nil message:@"Canceled" delegate:nil cancelButtonTitle:@"close" otherButtonTitles:nil] show];
[vc.navigationController popToRootViewControllerAnimated:YES];
};
transactionVC.errorBlock = ^(MOTransactionViewController *vc, NSError *error) {
[[[UIAlertView alloc] initWithTitle:nil message:@"Error" delegate:nil cancelButtonTitle:@"close" otherButtonTitles:nil] show];
[vc.navigationController popToRootViewControllerAnimated:YES];
};
Note that if you use the library this way you need to be sure the user is logged in properly for those methods that require a login. You can do that by using the login methods in 'MyOrderclass or by creating aMOLoginViewController` controller. And example is provided in the Example project.
MyOrder comes with a set of appearance methods to customize the UI according to your app main color schemas and fonts. You can find them in the UIColor+MOAppearance.h and UIFont+MOAppearance.h files. Example:
[UIColor MO_setBackgroundColor:[UIColor brownColor]];
[UIFont MO_setRegularFontName:@"Arial"];
MyOrder makes use of MOProgressHUD for displaying success and error messages. By default, MOProgressHUD will make use of SVProgressHUD if the library exists within your project. However, if you prefer to use a different HUD indicator (or any other type of UI control) you can customize MOProgressHUD by setting the appropriate blocks. Example:
[MOProgressHUD setShowErrorHandler:^(NSString *message) {
[[[UIAlertView alloc] initWithTitle:@"Error" message:message delegate:nil cancelButtonTitle:@"close" otherButtonTitles:nil] show];
}];
[MOProgressHUD setShowSuccessHandler:^(NSString *message) {
[[[UIAlertView alloc] initWithTitle:@"Success" message:message delegate:nil cancelButtonTitle:@"close" otherButtonTitles:nil] show];
}];
This guide presents some of the most useful and common integration methods. However, the SDK comes with many other options that allow third party developers to make advanced integrations where the UI can be fully customized, new payment methods can be added, etc. Please, check the API documentation to get more details of all options available