search

citruspay / citruspay-ios-sdk

Enhanced iOS SDK for Superior Native Payments Experience
MIT License
4 stars 1 forks source link
accept-payments citruspay-ios-sdk cocoapods payment-methods sdk

readme

Getting Started

CitrusPay logo

CitrusPay iOS SDK's

Introduction

The CitrusPay iOS SDK enables collection of payments via various payment methods.

The SDK is designed for CitrusPay partners who are developing their own iOS apps. The SDK provides a native integration to accept payments within these apps that is easy to integration and provides a high performance, functional checkout experience.

Features

CitrusPay iOS SDK broadly offers following features.

Core SDK V 4.1.5 - CitrusPay.framework

CitrusGraphics SDK V 1.1.2 - CitrusGraphics.framework

LazyPay SDK V 1.0.1 - LazyPay.framework

PlugNPlay SDK V 1.1.0 - PlugNPlay.framework

The full SDK ChangeLog is also available

Example Project

An example project is available via CocoaPods or manual-inclusion to try out and familiarize yourself with the Citrus Payments SDK. This project comes bundled with the SDK.

via CocoaPods - To run the example project, clone the repo, and run pod install from the Example directory first.

Example App Requirements

Prerequisites to integrating with Citrus PG

Note: Please ensure all the requirements mentioned above are met before proceeding.

Setup

Everything has a beginning. For using a framework, it's installation.

Using CocoaPods (recommended)

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate CitrusPay into your Xcode project using CocoaPods, specify it to a target in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
# your other pod
# ...
pod 'CitrusPay', '~> 4.1.5'
end

Then, run the following command:

$ pod install

You should open the {Project}.xcworkspace instead of the {Project}.xcodeproj after you installed anything from CocoaPods.

Including the SDK as a Git Submodule

If you do not wish to use CocoaPods then the secondary recommendation is to use a submodule. This allows you to easily track updates using standard Git commands. The first step to installation is to add the submodule to your project:

$ cd /path/to/MyApplication
# If this is a new project, initialize git...
$ git init
$ git submodule add git://github.com/citruspay/citruspay-ios-sdk.git
$ git submodule update --init --recursive
$ open citruspay-ios-sdk

Manual inclusion

If you’d like to download and maintain the SDK manually, please follow the steps listed below:

Adding dependencies (required when including the SDK as a Submodule including it manual)

JSONModel
CitrusGraphics
Kingfisher

Next

After installation, you must import the CitrusPay SDK in your project by adding this:

Swift

import CitrusPay

Objective-C

#import <CitrusPay/CitrusPay.h>

to the files in which you want to use this framework.

Once you prepared, continue to have a look at the Documentation to see how to use CitrusPay.

Documentation

HTML documentation is hosted on our CitrusPay Developer Guide.

Git Wiki documentation is available on the Git Wiki Documentation.

SDK Organization

CitrusPay.h

CitrusPay.h is the starting point for consuming the SDK, and contains the primary class you will interact with. It exposes all the methods you can call to accept payments via the supported payment methods. Detailed reference documentation is available on the reference page for the CitrusPay class.

Data Models

All other classes in the SDK are data models that are used to exchange data between your app and the SDK. Detailed reference documentation is available on the reference page for each class.

Next Steps

Head over to the Git Wiki Documentation to see all the API methods available.

See the the latest releases page

Next Steps

Head over to the Git Wiki Documentation to see all the API methods available. When you are ready, look at the samples below to learn how to interact with the SDK.