On Demand Settlements

Learn about the Pine Labs Online On-Demand settlement process and how to manage your settlements efficiently.

On-Demand Settlement (ODS) puts cash flow control directly in your hands, enabling you to request captured funds anytime through your dashboard. With real-time processing, transparent fees, and instant notifications, you can manage liquidity efficiently and eliminate settlement delays.

Traditional settlement cycles, such as T+1 or T+2, often create cash flow constraints. ODS transforms these rigid cycles into a flexible, user-controlled process, allowing you to access your funds immediately, even on weekends, bank holidays, and non-working days. This ensures continuous cash flow without waiting for standard settlement cycles.

With Plura's On-Demand Settlement, you have the power to manage your finances on your terms.

Key Features

1. On-Demand Settlement Requests

• You can request settlements through the Pine Labs Online Dashboard.
• ODS processes leftover transactions post the last payout.
• Available balance and fees are displayed before request confirmation.

2. Real-Time Processing

• Payouts are completed within 1.5 hours of trigger.
• Settlement requests can be initiated daily between 9 AM - 9 PM.
• ODS batches are processed every hour, sweeping the last hour’s requests.

3. Transparent Fee Structure

• ODS incurs a fee on top of Merchant Discount Rate (MDR).
• An additional Weekend Settlement Fee applies for holiday settlements.

4. Smart Balance Management

• Real-time visibility of eligible balance.
• Automatic fee calculation before settlement confirmation.
• Configurable payout limits for each merchant.

5. Comprehensive Tracking and Notifications

• Instant confirmation and settlement tracking details.
• Notifications via SMS/Email at key settlement milestones.
• Detailed settlement history available on the dashboard.

6. Risk-Managed Security

• RBI-compliant pre-funding and fraud checks.
• MCC profiling and transaction limits ensure secure payouts.

Key Benefits

1. Improve Liquidity: Access funds for urgent expenses or opportunities.
2. Reduce Financial Stress: No more waiting for payouts.
3. Boost Operational Agility: Align settlements with business needs.

📘

Note:

• To enable the On-Demand Settlements feature, contact our support team.

How to Raise an ODS Request

1. Log in to the Pine Labs Online Dashboard

2. Check Available Balance

   • Navigate to the Settlements Section.

   1. In the left sidebar, under the TRANSACTIONS section, click on Settlements.
   2. This will open the Settlements Dashboard, where you can view all settlement details.

   

   
   
   • View the eligible balance available for instant settlement.

3. On the Settlements Dashboard, select the On-Demand Settlement button to proceed with an instant settlement request.

4. Review Settlement Eligibility & Limits

• Check the Available Balance for settlement (e.g., ₹19,000).
• Review the On-Demand Daily Limit (e.g., ₹2,00,000).
• Verify the Limit Used Today and the Remaining Limit for Today (e.g., ₹50,000 used, ₹1,50,000 available).

5. Check Applicable Fees

• Review any additional charges for the settlement request (e.g., ₹475 fee for processing).
• Click View On-Demand Settlement Terms if needed.

6. Confirm and Submit Request

• Once reviewed, click Continue to proceed with the settlement request.

• Click on Confirm to proceed with the settlement request.

• After submitting the request, you will receive a confirmation screen with settlement details.

  

• Click Done to Complete the Process.

7. View Settlement History

   • Navigate to the Settlements section from the left sidebar.
   • Click on On-Demand Settlement History to view all settlement requests.
   
   
   

8. Review Settlement Details

   • Locate your Request ID in the list (e.g., 1611).
   • Check the Status:
     Success: The settlement is completed.
     In Progress: The settlement is still being processed.
   • Verify the Raised On and Settled On timestamps.
   • Review the Gross Amount, Deductions, and Net Settlement Amount for accuracy.

Native SDKs

Learn how you can Integrate with Pine Labs Online Native SDKs and start accepting payments from your customers.

Our Native SDKs facilitate seamless payment processing within mobile applications. These SDKs include pre-built UI components, enabling businesses to integrate payments effortlessly while enhancing the user experience.

With Pine Labs Online SDKs, you can streamline payment integration using pre-configured code, APIs, comprehensive documentation, and debugging tools, ensuring a secure and efficient transaction process.

You can leverage our platform-specific SDKs to develop applications for various platforms, including:

• Android Native SDK
• iOS Native SDK

Android Native SDK Integration Steps

Learn how you can start integrating with Pine Labs Online Android Native SDK.

The Android Native SDK integration involves the following steps below:

1. [Prerequisite] Integrate APIs in Your Backend
   1. Generate Auth Token
   2. Create Hosted Checkout
2. Installation
   1. Configure Build Setting
3. Initialize SDK
4. Handle Payments
5. Manage Transactions
   1. Fetch APIs
   2. Webhooks

📘

Note:

• 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. [Prerequisite] Integrate APIs in Your Backend

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

1.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
}

Refer to our Generate Token API documentation to learn more.

1.2. Create Hosted Checkout

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

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": "f4c45dbd-6eba-453d-b317-158c6ba12825",
  "order_amount": {
    "value": 500,
    "currency": "INR"
  },
  "purchase_details": {
    "customer": {
      "email_id": "[email protected]",
      "first_name": "joe",
      "last_name": "kumar",
      "customer_id": "192212",
      "mobile_number": "192192883",
			"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": "value1",
      "key2": "value2"
    },
    "integration_mode": "SDK"
  }
}
'

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": "f4c45dbd-6eba-453d-b317-158c6ba12825",
  "order_amount": {
    "value": 500,
    "currency": "INR"
  },
  "purchase_details": {
    "customer": {
      "email_id": "[email protected]",
      "first_name": "joe",
      "last_name": "kumar",
      "customer_id": "192212",
      "mobile_number": "192192883",
			"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": "value1",
      "key2": "value2"
    },
    "integration_mode": "SDK"
  }
}
'

{
  "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 Create Hosted Checkout API documentation to learn more.

2. Installation

To include the Pine Labs Online Android SDK in your project, follow these steps:

2.1. Configure Build Setting

1. Navigate to the build.gradle file of your app module (usually located at app/build.gradle).
2. Include the below dependencies in your build.gradle file.

dependencies {
  implementation 'com.github.plural-pinelabs:Plural_Android_SDK:1.2'
}

dependencies {
  implementation 'com.github.plural-pinelabs:Plural_Android_SDK:9.5'
}

3. After adding the necessary dependencies to your build.gradle file, click on "Sync Now" in the notification bar to sync your project with the updated Gradle files.
4. Next, include the following code in your AndroidManifest.xml file to obtain the required static permissions.

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

3. Initialize SDK

To initialise the Pine Labs Online SDK, follow these steps:

1. Create an PluralSDKManager object: Initialise an instance of PluralSDKManager as shown below in your project:

val sdkManager = PluralSDKManager()

2. Invoke startPayment: Use the sdkManager object to call the startPayment method, which is defined in the Android SDK.

sdkManager.startPayment(context, token, PaymentResultCallBack)

Parameters Used in a Payment

context: Refers to the activity context where this method is called.
token: The token generated from the Create Hosted Checkout API response.
PaymentResultCallBack: PaymentResultCallBack is a constant that handles callback messages sent back to your Android app.

4. Handle Payments

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 PaymentResultCallBack. 

 onErrorOccured: This method is called when SDK is unable to load the payment page.
onSuccessOccured: This method is called when transaction is complete. Transaction can be failed or success.
onCancelTransaction: This method is called when the user cancels the transaction.

override fun onErrorOccured(orderId: String?, code: String?, message: String?) {
    Toast.makeText(context: this, text: "Error occurred ->$message", Toast.LENGTH_SHORT).show()
}

override fun onSuccessOccured(orderId: String?) {Toast.makeText(context: this, text: "Payment Successful ${orderId}",Toast.LENGTH_SHORT).show()
}

override fun onCancelTransaction() {Toast.makeText(this text: "Cancel transaction", Toast.LENGTH_SHORT).show()}()
}

5. Manage Transactions

To get the status of the transaction made from your application, you can use our Fetch APIs to know the real time status.

5.1. Get Order by Order ID

Use this API to know the real time status of the transaction made on your application. Refer to our Get Order by Order ID API documentation to learn more.

5.2. Webhooks

You can configure the webhook events to know the status of your transactions. Refer to our Webhooks documentation to learn more.

Infinity Checkout Native SDK Integration Steps

Learn how you can start integrating with Pine Labs Online Android Native SDK.

The Android Native SDK integration involves the following steps below:

1. [Prerequisite] Integrate APIs in Your Backend
   1. Generate Auth Token
   2. Generate Checkout Link
2. Installation
   1. Add the SDK Dependency
   2. Sync Your Project
   3. Initialize and Launch the SDK
   4. Configure the Environment
   5. Handle SDK Callbacks
3. Manage Transactions
   1. Fetch APIs
   2. Webhooks

📘

Note:

• Ensure you store your client_id and client_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. [Prerequisite] Integrate APIs in Your Backend

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

1.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
}

Refer to our Generate Token API documentation to learn more.

1.2. Generate Checkout Link

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

Below are the sample requests and response for a Generate Checkout Link 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": "112345",
  "order_amount": {
    "value": 1100,
    "currency": "INR"
  },
  "integration_mode": "REDIRECT",
  "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 --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": "112345",
  "order_amount": {
    "value": 1100,
    "currency": "INR"
  },
  "integration_mode": "REDIRECT",
  "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 API documentation to learn more.

2. 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.

2.1. Add the SDK Dependency

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

dependencies {
    implementation 'com.github.pinelabs.express:1.0.0'
}

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

2.2. Sync Your Project

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

2.3. 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
)

2.4. 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.

2.5. Handle SDK Callbacks

The SDK triggers three callbacks via ExpressSDKCallback. Implement all three to manage the payment flow effectively:

1. onError

Triggered when an error occurs, such as network or API failures.
Provides:

• errorCode
• errorMessage
• errorDescription

2. onSuccess

Triggered when the transaction is successfully completed.

3. onCancel

Triggered when you customer cancels the transaction.

3. Manage Transactions

To get the status of the transaction made from your application, you can use our Fetch APIs to know the real time status.

3.1. Get Order by Order ID

Use this API to know the real time status of the transaction made on your application. Refer to our Get Order by Order ID API documentation to learn more.

3.2. Webhooks

You can configure the webhook events to know the status of your transactions. Refer to our Webhooks documentation to learn more.

iOS Native SDK Integration Steps

Learn how you can start integrating with Pine Labs Online iOS Native SDK.

The iOS Native SDK integration involves the following steps below:

1. Prerequisite
2. Installation
3. Configure the App Target
4. Initialize SDK
5. Handle Payments
6. Manage Transactions
   1. Get Order by Order ID
   2. Webhooks

📘

Note:

• Ensure you store your client_id and client_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. Prerequisite

bussiness_name.com.yourcompany.app

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

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
}

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": "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 --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": "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."
}

2. Installation

Follow the below steps to install Pine Labs Online iOS Native SDK using Xcode. We provide two methods to integrate our SDK into your project.

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

1

Open your project in Xcode

Launch Xcode and open your iOS project.

2

Navigate to Add Packages

Go to the menu:

File → Add Packages…

3

Enter SDK GitHub URL

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

4

Select Release Tag

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

5

Add to App Target

Add the package to your App Target.

6

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

1

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.

2

Drag and Drop Framework

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

3

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.

4

Complete Installation

Drag and drop the .xcframework in the app.

Copy files to destination.

📘

Note:

The userSDKFramework function, created during the SDK installation, implements startPayment. Use this function to pass the order token and initiate the call to ios_SDK.

🚧

Watch Out:

Ensure that the minimum compilation compatibility version is set to iOS 16 or 17

3. Configure the App Target

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

1. Navigate to the General tab of your target's settings. Add the (SDKFramework).xcframework file under the Frameworks, Libraries, and Embedded Content section.

2. 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.

3. 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:

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

4. Initialize SDK

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

1. Import the SDK into the app and,

2. Create an object of the class EdgeController 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.

5. Handle Payments

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 ResponseCallback. 

 In case of success, inside the SDK we check if the URL being loaded is the completion/final URL in the checkout flow. If that URL is being opened, then onSuccessResponse() is called from your app, which will return the flow back to your app from the SDK, indicating a successful transaction.

onFailureResponse: This method is called when SDK reaches a failure state.

onSuccessResponse: This method is called when the SDK reaches the success state.

onCancelTxn: This method is called when the user cancels the transaction.

onPressedBackButton: This method is called when the user presses the back button.

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")
    }
}

6. Manage Transactions

To get the status of the transaction made from your application, you can use our Fetch APIs to know the real time status.

6.1. Get Order by Order ID

Use this API to know the real time status of the transaction made on your application. Refer to our Get Order by Order ID API documentation to learn more.

6.2. Webhooks

You can configure the webhook events to know the status of your transactions. Refer to our Webhooks documentation to learn more.