Native SDK Integration Steps

❗️
Security Best Practices:

Ensure you store your Client ID and Secret in your Backend securely.

Integrate our APIs on your backend system.

We strictly recommend not to call our APIs from the frontend.

Failure to adhere to the above guidelines may result in legal implications. In such cases, you will be held responsible for any damage or loss arising from non-compliance.

1. Prerequisites

Available Platform SDKs

Android iOS

Requirements:

Android SDK version 21 (Lollipop) or higher
Android Studio 4.0 or higher
Internet permissions configured in AndroidManifest.xml

1. Requirements:

Requirements

Category	Minimum Supported
iOS Version	`iOS 16.0+`
Xcode Version	`Xcode 15.0+`
Swift Version (SDK)	`Swift 5.x`
Swift Version (App)	`Swift 4+`
Framework Type	`XCFramework`
Architectures	`arm64`

2. Enable Apple Pay Capability in Xcode:

1. Open Your Project in Xcode

Launch Xcode and open your project.
In the Project Navigator (left panel), select your project name.
Under Targets, select your app target.

2. Configure Signing & Capabilities

Click on the Signing & Capabilities tab at the top of the main editor.
Ensure that your Team and Bundle Identifier are properly configured.
Verify that your project uses a valid Apple Developer account (with Merchant ID access).

3. Add the Apple Pay Capability

Click the + Capability button in the top-left corner.
In the popup, search for Apple Pay.
Double-click Apple Pay (or press Enter) to add it.
The Apple Pay capability will now appear under your app’s capabilities list.

4. Configure Merchant IDs

Under the newly added Apple Pay section, locate Merchant IDs.
Click the “+” button to add one.
Select an existing Merchant ID if already created in the Apple Developer Portal.
If not available, choose “Add an Account → Manage Certificates, Identifiers & Profiles” to create a new Merchant ID.
Use a naming convention such as:

bussiness_name.com.yourcompany.app

5. Verify Entitlements

Xcode automatically adds the required entitlements file (if not already present) and enables the following key:

<key>com.apple.developer.in-app-payments</key>
                                    <array>
                                    <string>merchant.com.yourcompany.app</string>
                                    </array>

This ensures your app is authorized to process Apple Pay transactions using the registered Merchant ID(s).

2. Integrate APIs in Your Backend

Start a payment by triggering the payment flow. To start a payment follow the below steps:

2.1. Generate Auth Token

Integrate our Generate Token API in your backend servers to generate the auth token. Use the token generated to authenticate Pine Labs Online APIs.

Below are the sample requests and response for the Generate Token API.

curl --location 'https://pluraluat.v2.pinepg.in/api/auth/v1/token' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--data '
{
  "client_id": "a17ce30e-f88e-4f81-ada1-c3b4909ed232",
  "client_secret": "fgwei7egyhuggwp39w8rh",
  "grant_type": "client_credentials"
}
'

curl --location 'https://api.pluralpay.in/api/auth/v1/token' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--data '
{
  "client_id": "a17ce30e-f88e-4f81-ada1-c3b4909ed232",
  "client_secret": "fgwei7egyhuggwp39w8rh",
  "grant_type": "client_credentials"
}
'

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "expires_in": 3600
}

Click here for request and response parameter information.

Request Parameters

Response Parameters

The table below lists the request parameters of our Generate Token API.

Parameter	Type	Description
client_id required	`string`	Unique client identifier in the Pine Labs Online database. Example: `a17ce30e-f88e-4f81-ada1-c3b4909ed232` Note: The Onboarding team has provided you with this information as part of the onboarding process.
client_secret required	`string`	Unique client secret key provided while onboarding. Example: `fgwei7egyhuggwp39w8rh` Note: The Onboarding team has provided you with this information as part of the onboarding process.
grant_type required	`string`	The grant type to generate an access token. Accepted value: `client_credentials`

The table below lists the response parameters of our Generate Token API.

Parameter	Type	Description
access_token	`string`	The access token generated by the system. • Minimum length: 1 character. • Maximum length: 8192 characters. Example: `eyJhbGciOiJIUzI1NiIsIn` Note: Use this token in the authorization headers to authenticate Pine Labs Online APIs.
expires_at	`string`	Access duration timestamp. Example: `2024-06-28T13:26:06.909140Z`

Refer to our Generate Token API documentation to learn more.

2.2. Generate Checkout Link

Use this API to Generate a checkout link, for authentication use the generated access token in the headers of the API request.

2.2.1. Hosted Checkout [v.3]

Use the payload below if you specifically want to accept payments via Hosted Checkout (V.3 Redirect).

Below are the sample requests and response for a Create Hosted Checkout API.

curl --location 'https://pluraluat.v2.pinepg.in/api/checkout/v1/orders' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'Content-Type: application/json' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'accept: application/json' \
--data '
{
  "merchant_order_reference": 112345171,
  "order_amount": {
    "value": 500,
    "currency": "INR"
  },
  "integration_mode": "SDK",
  "pre_auth": false,    
  "notes": "order1",
  "purchase_details": {
    "customer": {
      "email_id": "[email protected]",
      "first_name": "Kevin",
      "last_name": "Bob",
      "customer_id": "192212",
      "mobile_number": "9876543210",
			"country_code": "91",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",,
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "billing"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",,
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "shipping"
      }
    },
    "merchant_metadata": {
      "key1": "DD",
      "key2": "XOF"
    }
  }
}
'

curl --location 'https://api.pluralpay.in/api/checkout/v1/orders' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'Content-Type: application/json' \
--header 'Request-ID: c17ce30f-f88e-4f81-ada1-c3b4909ed235' \
--header 'Request-Timestamp: 2024-07-09T07:57:08.022Z' \
--header 'accept: application/json' \
--data '
{
  "merchant_order_reference": 112345171,
  "order_amount": {
    "value": 500,
    "currency": "INR"
  },
  "integration_mode": "SDK",
  "pre_auth": false,    
  "notes": "order1",
  "purchase_details": {
    "customer": {
      "email_id": "[email protected]",
      "first_name": "Kevin",
      "last_name": "Bob",
      "customer_id": "192212",
      "mobile_number": "9876543210",
			"country_code": "91",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",,
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "billing"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",,
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "shipping"
      }
    },
    "merchant_metadata": {
      "key1": "DD",
      "key2": "XOF"
    }
  }
}
'

{
  "token": "REDIRECT TOKEN",
  "order_id": "ORDER ID",
  "redirect_url": "https://api.pluralonline.com/api/v3/checkout-bff/redirect/checkout?token=REDIRECT TOKEN",
  "response_code": 200,
  "response_message": "Order Creation Successful."
}

Click here for request and response parameter information.

Request Parameters

Response Parameters

The table below lists the request parameters of our Create Checkout Link API.

Parameter	Type	Description
merchant_order_reference required	`string`	Enter a unique identifier for the order request. Minimum: 1 character. Maximum: 50 characters. Example: `1234567890` Supported characters: `A-Z` `a-z` `0-9` `-` `_`
order_amount required	`object`	An object that contains the transaction amount details. Learn more about the `order_amount` child object.
pre_auth	`boolean`	The pre-authorization type. Possible values: `false` (default): When pre-authorization is not required. `true`: When pre-authorization is needed.
allowed_payment_methods	`array of strings`	The type of payment methods you want to offer customers. Accepted values: `CARD` `UPI` `POINTS` `NETBANKING` `WALLET` `CREDIT_EMI` `DEBIT_EMI` Example: CARD Note: Ensure it is configured for you.
notes	`string`	Note to show against an order. Example: `Order1`
callback_url	`string`	Use this URL to redirect your customers to specific success or failure pages based on the order or product details. Example: `https://sample-callback-url`
failure_callback_url	`string`	Use this URL to redirect your customers to specific failure pages based on the order or product details. Example: `https://sample-failure-callback-url`
purchase_details	`object`	An object that contains purchase details. Learn more about the `purchase_details` child object.
cart_details	`object`	An object that contains cart details. Learn more about the `cart_details` child object.

Order Amount [Child Object]

The table below lists the various parameters in the order_amount child object. This object is part of the Create Checkout Link request object.

Parameter	Type	Description
value required	`integer`	Transaction amount in Paisa. Minimum value: `100` (₹1). Maximum value: `100000000` (₹10 lakh). Example: `1000`
currency required	`string`	Type of currency. Example: `INR`

Purchase Details [Child Object]

The table below lists the various parameters in the purchase_details child object. This object is part of the Create Checkout Link request object.

Parameter	Type	Description
customer	`object`	An object that contains the customer details. Learn more about the `customer` child object.
merchant_metadata	`object`	An object of key-value pair that can be used to store additional information. Learn more about the `merchant_metadata` child object.

Customer [Child Object]

The table below lists the various parameters in the customer child object. This is part of the purchase_details object.

Parameter	Type	Description
email_id	`string`	Customer's email address. Minimum length: `1` character. Maximum length: `50` characters. Example: `[email protected]`
first_name	`string`	Customer's first name. Minimum length: `1` character. Maximum length: `50` characters. Example: `Kevin`
last_name	`string`	Customer's last name. Minimum length: `1` character. Maximum length: `50` characters. Example: `Bob`
customer_id	`string`	Unique identifier of the customer in the Pine Labs Online database. Minimum length: `1` character. Maximum length: `19` characters. Example: `123456`
mobile_number	`string`	Customer's mobile number. Minimum length: `9` characters. Maximum length: `20` characters. Example: `9876543210`
country_code	`string`	Country code of the registered mobile number. Maximum length: `5` characters. Example: `91` Note: If the country code is not provided, it defaults to `91`.
billing_address	`object`	An object that contains the details of the billing address. Learn more about our `billing_address` child object.
shipping_address	`object`	An object that contains the shipping address details. Learn more about our `shipping_address` child object.

Billing Address [Child Object]

The table below lists the various parameters in the billing_address child object. This is part of the customer object.

Parameter	Type	Description
address1	`string`	Customer's billing address1. Max length: `100` characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's billing address2. Max length: `100` characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's billing address3. Max length: `100` characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the billing address. Min length: `6` characters. Max length: `10` characters. Example: `51524036`
city	`string`	City of the billing address. Max length: `50` characters. Example: `Westminster`
state	`string`	State of the billing address. Max length: `50 characters.` `Example: Westminster`
country	`string`	Country of the billing address. Max length: `50` characters. Example: `London`
full_name	`string`	Full name of the customer. Max length: `50` characters. Example: `Doctor Strange`
address_type	`string`	Type of the billing address. Example: `Home` Accepted values: `HOME` `WORK` `OTHER`
address_category	`string`	Address category. Example: `Billing`

Shipping Address [Child Object]

The table below lists the various parameters in the shipping_address child object. This is part of the customer object.

Parameter	Type	Description
address1	`string`	Customer's shipping address1. Max length: `100` characters. Example: `10 Downing Street Westminster London`
address2	`string`	Customer's shipping address2. Max length: `100` characters. Example: `Oxford Street Westminster London`
address3	`string`	Customer's shipping address3. Max length: `100` characters. Example: `Baker Street Westminster London`
pincode	`string`	Pincode of the shipping address. Min length: `6` characters Max length: `10` characters. Example: `51524036`
city	`string`	City of the shipping address. Max length: `50` characters. Example: `Westminster`
state	`string`	State of the shipping address. Max length: `50` characters. Example: `Westminster`
country	`string`	Country of the shipping address. Max length: `50` characters. Example: `London`
full_name	`string`	Full name of the customer. Max length: `50` characters. Example: `Doctor Strange`
address_type	`string`	Type of the shipping address. Example: `Home` Accepted values: `HOME` `WORK` `OTHER`
address_category	`string`	Address category. Example: `Shipping`

Merchant Metadata [Child Object]

The table below lists the various parameters in the merchant_metadata child object. This object is part of the purchase_details child object.

Parameter	Type	Description
express_checkout_allowed_action	`string`	Access allowed during the express checkout. Accepted values: `checkoutCollectAddress`: We will collect the address of the customer during the checkout. `checkoutCollectMobile`: We will collect the mobile number of the customer during the checkout.

Cart Details [Child Object]

The table below lists the various parameters in the cart_details child object. This object is part of the Create Checkout Link request object.

Parameter	Type	Description
cart_items	`array of objects`	An object that contains the cart item details. Learn more about the `cart_itmes` child object.

Cart Items [Child Object]

The table below lists the various parameters in the cart_items child object. This object is part of the cart_details child object.

Parameter	Type	Description
item_id	`string`	Unique identifier of the item. Example: `cart_id_1`
item_name	`string`	Name of the item. Example: `T Shirt`
item_description	`string`	Description corresponding to the item. Example: `Shopping on Diwali Sale`
item_image_url	`string`	Image URL of the item. Example: `https://chriscross.in/cdn/shop/files/95_800x.jpg` Note: To ensure better resolution and optimal display on the checkout, please provide the image in `24x24` dimensions.
item_original_unit_price	`string`	Original price of the item. Example: `199`
item_discounted_unit_price	`string`	Discount price of the item. Example: `49`
item_quantity	`string`	Number of items purchased. Example: `2`
item_currency	`string`	Indicates the currency type for the purchase of the item. Example: `INR`

The table below lists the various parameters returned in the Generate Checkout Link response objects.

Parameter	Type	Description
token	`string`	Token generated by our system for Pine Labs Online Hosted Checkout. Example: `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c`
order_id	`string`	Unique identifier of the order in the Pine Labs Online database. Example: `v1-5757575757-aa-hU1rUd`
redirect_url	`string`	The checkout link generated on our system. Example: `https://api.pluralonline.com/api/v3/checkout-bff/redirect/checkout?token=<>`
response_code	`integer`	Response code of the request. Example: `200`
response_message	`string`	Corresponding message to the response code. Example: `Order Creation Successful`

Refer to our Create Hosted Checkout API documentation to learn more.

2.2.2. Hosted Checkout [V.3.1]

Use the payload below if you specifically want to accept payments via Express Checkout.

Below are the sample requests and response for a Generate Checkout Link API.

curl --request POST \
     --url https://pluraluat.v2.pinepg.in/api/checkout/v1/orders \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "merchant_order_reference": "112345",
  "order_amount": {
    "value": 1100,
    "currency": "INR"
  },
  "integration_mode": "SDK",
  "pre_auth": false,
  "allowed_payment_methods": [
    "CARD",
    "UPI",
    "NETBANKING",
    "POINTS",
    "WALLET"
  ],
  "notes": "order1",
  "callback_url": "https://sample-callback-url",
  "failure_callback_url": "https://sample-failure-callback-url",
  "purchase_details": {
    "customer": {
      "email_id": "[email protected]",
      "first_name": "Kevin",
      "last_name": "Bob",
      "customer_id": "123456",
      "mobile_number": "9876543210",
			"country_code": "91",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "harsh kumar",
        "address_type": "HOME/WORK/OTHER",
        "address_category": "BILLING"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "harsh kumar",
        "address_type": "HOME/WORK/OTHER",
        "address_category": "BILLING"
      }
    },
    "merchant_metadata": {
      "express_checkout_enabled": "TRUE",
      "express_checkout_allowed_action": "checkoutCollectAddress",
      "key1": "DD",
      "key2": "XOF"
    }
  },
  "cart_details": {
    "cart_items": [
      {
        "item_id": "cart_id_1",
        "item_name": "T Shirt",
        "item_description": "Test Description",
        "item_details_url": "https://chriscross.in/cdn/shop/files/95_800x.jpg",
        "item_image_url": "https://chriscross.in/cdn/shop/files/95_800x.jpg",
        "item_original_unit_price": 1,
        "item_discounted_unit_price": 1,
        "item_quantity": 1,
        "item_currency": "INR"
      }
    ]
  }
}
'

curl --request POST \
     --url https://api.pluralpay.in/api/checkout/v1/orders \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "merchant_order_reference": "112345",
  "order_amount": {
    "value": 1100,
    "currency": "INR"
  },
  "integration_mode": "SDK",
  "pre_auth": false,
  "allowed_payment_methods": [
    "CARD",
    "UPI",
    "NETBANKING",
    "POINTS",
    "WALLET"
  ],
  "notes": "order1",
  "callback_url": "https://sample-callback-url",
  "failure_callback_url": "https://sample-failure-callback-url",
  "purchase_details": {
    "customer": {
      "email_id": "[email protected]",
      "first_name": "Kevin",
      "last_name": "Bob",
      "customer_id": "123456",
      "mobile_number": "9876543210",
			"country_code": "91",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "harsh kumar",
        "address_type": "HOME/WORK/OTHER",
        "address_category": "BILLING"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "harsh kumar",
        "address_type": "HOME/WORK/OTHER",
        "address_category": "BILLING"
      }
    },
    "merchant_metadata": {
      "express_checkout_enabled": "TRUE",
      "express_checkout_allowed_action": "checkoutCollectAddress",
      "key1": "DD",
      "key2": "XOF"
    }
  },
  "cart_details": {
    "cart_items": [
      {
        "item_id": "cart_id_1",
        "item_name": "T Shirt",
        "item_description": "Test Description",
        "item_details_url": "https://chriscross.in/cdn/shop/files/95_800x.jpg",
        "item_image_url": "https://chriscross.in/cdn/shop/files/95_800x.jpg",
        "item_original_unit_price": 1,
        "item_discounted_unit_price": 1,
        "item_quantity": 1,
        "item_currency": "INR"
      }
    ]
  }
}
'

{
  "token": "REDIRECT TOKEN",
  "order_id": "ORDER ID",
  "redirect_url": "https://api.pluralonline.com/api/v3/checkout-bff/redirect/checkout?token=REDIRECT TOKEN",
  "response_code": 200,
  "response_message": "Order Creation Successful."
}

Refer to our Generate Checkout Link documentation to learn more.

3. SDK Installation & Initialization

Android iOS

3.1. Installation

Follow the steps below to add the Infinity SDK to your Android application and initialize it using the token from the Order Creation API.

Step 1: Add the SDK Dependency

Add the dependency to your app-level build.gradle file.

dependencies {
    implementation("com.github.plural-pinelabs:Pinelabs-Android-SDK:1.1.8")
}

Alternatively, you can declare it through catalog styling using libs.versions.toml.

Step 2: Sync Your Project

Sync your project with Gradle to download the SDK and make it available in your build.

3.2. Initialization

To initialise the android web SDK, follow the below steps:

Step 1: Initialize and Launch the SDK

Use the method below to start the SDK and pass the token received from the Create Order API.

ExpressSDKInitializer().initializeSDK(
    this@MainActivity,
    "${tokenEt.text}", // Replace with the actual Redirect token
    object : ExpressSDKCallback {

        override fun onError(
            errorCode: String?,
            errorMessage: String?,
            errorDescription: String?
        ) {
            Toast.makeText(
                this@MainActivity,
                "Error: $errorCode, $errorMessage, $errorDescription",
                Toast.LENGTH_LONG
            ).show()
            Log.e("ExpressSDK", "Error: $errorCode, $errorMessage, $errorDescription")
        }

        override fun onSuccess(
            responseCode: String?,
            responseMessage: String?,
            responseDescription: String?
        ) {
            Toast.makeText(
                this@MainActivity,
                "Success: $responseCode, $responseMessage, $responseDescription",
                Toast.LENGTH_LONG
            ).show()
            Log.i("ExpressSDK", "Success: $responseCode, $responseMessage, $responseDescription")
        }

        override fun onCancel(
            responseCode: String?,
            responseMessage: String?,
            responseDescription: String?
        ) {
            Toast.makeText(
                this@MainActivity,
                "Cancelled: $responseCode, $responseMessage, $responseDescription",
                Toast.LENGTH_LONG
            ).show()
            Log.d("ExpressSDK", "Cancelled: $responseCode, $responseMessage, $responseDescription")
        }
    },
    true // Set to false for PROD, true for UAT
)

Step 2: Configure the Environment

Configure the runInSandBox flag based on the environment:

UAT (Testing): Set runInSandBox = true
Production (Live): Set runInSandBox = false

Note: Always validate the full flow in UAT before switching to Production.

3.1. Installation

Swift Package Manager Manual Installation

2.1 Add the SDK via Swift Package Manager

Recommended method for easy updates and dependency management

Requirements

Xcode 12.5+ iOS 11.0+

Installation Steps

Open your project in Xcode

Launch Xcode and open your iOS project.

Navigate to Add Packages

Go to the menu:

File → Add Packages…

Enter SDK GitHub URL

In the search bar, paste the SDK GitHub URL https://github.com/plural-pinelabs/Infinity_Checkout_iOS_SDK.

Select Release Tag

Choose the latest Release Tag (e.g., 1.1.1).

Add to App Target

Add the package to your App Target.

Verify Installation

Once added, it should appear in the General tab of your app target. You can also see the package details by clicking on the Package Dependency.

You can also see the package details by clicking on the Package Dependency.

Easy Updates

In case of any new release update, simply select Update Package and it will automatically get the latest build.

2.2 Add the SDK via Manual Method

To add the SDK to your app, import the (SDKFramework).xcframework file to the project using the following steps:

Installation Steps

Download the SDK Framework

You can download the SDK as a (SDKFramework).xcframework file here, which is in a package format that Apple recommends for distributing binary frameworks.

Drag and Drop Framework

Drag and drop the (SDKFramework).xcframework file into your Xcode project in the Project Navigator under the Frameworks section.

Configure Dialog Settings

A dialog box will appear when you drop the framework file into your project.

Ensure that the checkbox labeled "Copy items if needed" is selected. This ensures the framework gets copied into your project directory, making it available for builds.

Complete Installation

Drag and drop the .xcframework in the app.

Copy files to destination.

3.2. Configuration

You need to configure the target to embed the SDK framework properly.

Navigate to the General tab of your target's settings. Add the (SDKFramework).xcframework file under the Frameworks, Libraries, and Embedded Content section.
Ensure you choose Embed & Sign. This ensures the framework is embedded in your app when it's built and signed properly to run on iOS devices.

Note: Once the .xcframework is embedded, you can import the package in the view controller.

Info.plist update: To ensure proper functionality, you must update your app’s Info.plist (Information Property List) file to allow the required connections.

To enable UPI payments, add the necessary URL Schemes in the Info.plist file as shown below:

property-list-view — Figure: Property List View

Without these entries, the SDK won’t be able to navigate to the required UPI payment app.

3.3. Initialization

To initialise the iOS Native SDK, follow the below steps:

Import the SDK into the app.
Create an object of the class PineLabsOnlineSDKManager to initiate the payment function. In your application, you are creating a function that passes the order token received from the create order response to start the payment function of our SDK.

Parameters for startPayment:

from: Pass the context of the current ViewController where the SDK is invoked(generally ‘self’).
orderToken: The token generated from the Create Hosted Checkout API response.
environment: Use .uat for testing (default) or .prod for production.
MerchantCallbackResponse: An instance that sends callback messages to the merchant IOS app. This value remains constant.

Note: You can use a single build and change the environment variable to run the SDK in either UAT or Production. Currently, only two modes are supported: .uat for UAT and .prod for Production.

4. Handle Payment Callbacks

You need to implement call-back methods to handle your payment responses. This will provide the payment status and reason for transaction failures. Based on the reasons for failures, handling can be built at your end. Transaction callbacks can be listened to via overriding methods of EdgeResponseCallback.

Android iOS

Callback Methods

onSuccess() : Triggered when the transaction is successfully completed
onError() : Triggered when an error occurs (network, API failures, etc.)
onCancel() : Triggered when the user cancels the transaction

Callback Methods

onSuccessResponse : Triggered when the transaction is successfully completed
onFailureResponse : Triggered when an error occurs (network, API failures, etc.)
onCancelTxn : Triggered when the user cancels the transaction
onPressedBackButton : Triggered when the user presses the back button

4.1. Implementation Code Samples

public class MerchantCallbackResponse: UIViewController, ResponseCallback {

    public func onFailureResponse(orderID: String, status: String, code: String, message: String) {
        print("Test app response: error occurred")
    }

    public func onSuccessResponse(orderId: String, status: String) {
        print("Test app response: transaction response")
    }

    public func onCancelTxn(orderId: String, code: Int, message: String) {
        print("Test app response: transaction cancelled")
    }

    public func onPressedBackButton(code: Int, message: String) {
        print("Test app response: back pressed")
    }
}

5. Manage Transactions

Track and verify transaction status using Pine Labs APIs. To retrieve the latest status, use the Fetch APIs or subscribe to webhooks for real-time transaction updates.

Get Order by Order ID

Fetch real-time transaction status by order ID

View API Documentation

Webhooks

Configure webhook events for automatic transaction updates

View Webhook Documentation

Updated about 2 hours ago

❗️Security Best Practices:

1. Prerequisites

Requirements:

1. Requirements:

Requirements

2. Enable Apple Pay Capability in Xcode:

1. Open Your Project in Xcode

2. Configure Signing & Capabilities

3. Add the Apple Pay Capability

4. Configure Merchant IDs

5. Verify Entitlements

2. Integrate APIs in Your Backend

2.2.1. Hosted Checkout [v.3]

Order Amount [Child Object]

Purchase Details [Child Object]

Customer [Child Object]

Billing Address [Child Object]

Shipping Address [Child Object]

Merchant Metadata [Child Object]

Cart Details [Child Object]

Cart Items [Child Object]

2.2.2. Hosted Checkout [V.3.1]

3. SDK Installation & Initialization

2.1 Add the SDK via Swift Package Manager

Requirements

Installation Steps

Open your project in Xcode

Navigate to Add Packages

Enter SDK GitHub URL

Select Release Tag

Add to App Target

Verify Installation

Easy Updates

2.2 Add the SDK via Manual Method

Installation Steps

Download the SDK Framework

Drag and Drop Framework

Configure Dialog Settings

Complete Installation

Parameters for startPayment:

4. Handle Payment Callbacks

Callback Methods

Callback Methods

4.1. Implementation Code Samples

5. Manage Transactions

Get Order by Order ID

Webhooks

❗️
Security Best Practices: