PayU

https://docs.payu.in/
Admin
PayU is a payment gateway platform that enables businesses to accept payments through multiple...
Tokens:2,236,350
Snippets:6,514
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Setup and Run PayU SDK Example

Source: https://docs.payu.in/docs/reactnative-coresdk-integrate-with-android

Clones the PayU Core PG React SDK example repository, installs dependencies, and runs the Android application. This setup is for demonstrating and testing the SDK's functionality.

```bash
git clone https://github.com/payu-intrepos/payu-core-pg-react.git payuSdkExample
  cd payuSdkExample
  npm i
  cd example
  npm i
  react-native start
  react-native run-android
```

--------------------------------

### Install PayU GO SDK

Source: https://docs.payu.in/docs/integrate-go-sdk

Command to install the PayU GO SDK using the go get utility. This is a prerequisite for using the SDK in Go projects.

```go
go get github.com/payu-india/web-sdk-go
```

--------------------------------

### Install PayU NodeJS SDK

Source: https://docs.payu.in/docs/integrate-gosdk

Install the PayU NodeJS Web SDK using NPM.

```APIDOC
## Install the SDK

Run the following command to install the PayU NodeJS SDK using the NPM:

### Method
```bash
npm install payu-websdk
```
```

--------------------------------

### PayU SDK Installation

Source: https://docs.payu.in/docs/integrate-pythonsdk

Instructions on how to install the PayU Python SDK using pip.

```APIDOC
## Install Using PIP
To install the PayU Python SDK using PIP, run the following command:
```
pip install payu-websdk
```
```

--------------------------------

### Get Subscription Details API Request Example

Source: https://docs.payu.in/reference/get-subscription-details-api

This code snippet shows an example of how to make a GET request to the PayU Get Subscription Details API. It includes the base URL and a placeholder for the subscription ID.

```http
https://subscription.citruspay.com/api/sub/v1/merchant/subscriptions/5c972a35652d405ed9834f52
```

--------------------------------

### PayU Merchant Sign-Up URL Example

Source: https://docs.payu.in/docs/workflow-cobranded-onboarding

An example of the PayU merchant sign-up URL, demonstrating how to substitute placeholders with actual reseller ID and merchant email for initiating the onboarding process.

```text
https://onboarding.payu.in/app/account/signup?reseller_id=11ea-c29b-c691cce0-8256-02aa98a2d2b0&email=AuthConnect2@yopmail.com
```

--------------------------------

### Refer using Portal Onboarding

Source: https://docs.payu.in/docs/payu-partner-program-overview

Details on onboarding via the Partner Portal, a low-effort method for freelancers and small businesses.

```APIDOC
## Refer using Portal Onboarding

### Description
Onboarding through the Partner Portal is a low-effort method where partners can refer merchants directly via the PayU Partner Portal.

### Method
Interaction via the PayU Partner Portal interface.

### Endpoint
PayU Partner Portal URL.

### Parameters
#### Path Parameters
None specified.

#### Query Parameters
None specified.

#### Request Body
None specified, actions are performed within the portal.

### Request Example
```json
{
  "example": "Actions performed via the Partner Portal UI."
}
```

### Response
#### Success Response (200)
Success is indicated by the merchant being successfully registered through the portal.

#### Response Example
```json
{
  "example": "Merchant status update within the Partner Portal."
}
```
```

--------------------------------

### Get All Payment Links API Request Examples

Source: https://docs.payu.in/reference/get-all-payment-links-api

Demonstrates how to fetch all payment links using the GET method. It includes examples for cURL, Python, Ruby, and Java, specifying parameters like date range, page size, and sorting.

```curl
curl --location -g --request GET 'https://uatoneapi.payu.in/payment-links?pageSize=20&pageOffset=0&orderBy=amount&order=desc&dateFrom=2022-03-21&dateTo=2022-03-22' \
--header 'merchantId: {{merchantId}}' \
--header 'Authorization: Bearer {{access_token}}'
```

```python
import http.client

conn = http.client.HTTPSConnection("{{stagingurl}}")
payload = ''
headers = {
  'merchantId': '{{merchantId}}',
  'Authorization': 'Bearer {{access_token}}'
}
conn.request("GET", "/payment-links?pageSize=20&pageOffset=0&orderBy=amount&order=desc&dateFrom=2022-03-21&dateTo=2022-03-22", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```

```ruby
require "uri"
require "net/http"

url = URI("{{stagingurl}}/payment-links?pageSize=20&pageOffset=0&orderBy=amount&order=desc&dateFrom=2022-03-21&dateTo=2022-03-22")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["merchantId"] = "{{merchantId}}"
request["Authorization"] = "Bearer {{access_token}}"

response = http.request(request)
puts response.read_body
```

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("{{stagingurl}}/payment-links?pageSize=20&pageOffset=0&orderBy=amount&order=desc&dateFrom=2022-03-21&dateTo=2022-03-22")
  .method("GET", null)
  .addHeader("merchantId", "{{merchantId}}")
  .addHeader("Authorization", "Bearer {{access_token}}")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Get Merchant Credentials API Success Response

Source: https://docs.payu.in/reference/get_merchant_credentials_api

Example of a successful response from the Get Merchant Credentials API, containing the production key and salt for the merchant.

```json
{
  "data": {
    "credentials": {
      "prod_key": "JPM7Fg",
      "prod_salt": "a*******"
    }
  }
}
```

--------------------------------

### Build PayU Object

Source: https://docs.payu.in/docs/integrate-pythonsdk

Sample code for creating an instance of the PayU Client with merchant key, salt, and environment.

```APIDOC
## Build PayU Object
Use the following sample code for creating an instance of the PayU Object:
```
client = payu_sdk.payUClient({
    "key": <YOUR_MERCHANT_KEY>,
    "salt": <YOUR_MERCHANT_SALT>,
    "env": <ENVIRONMENT>
  }
)
```
```

--------------------------------

### Get Token API Request Examples (Shell, Node, Ruby, PHP, Python)

Source: https://docs.payu.in/docs/get-token-api-payment-links

Provides examples of how to call the Get Token API using different programming languages. These snippets demonstrate how to construct the POST request to the PayU OAuth token endpoint with the necessary credentials and parameters.

```Shell
curl -X POST \
  https://uat-accounts.payu.in/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'client_id=YOUR_CLIENT_ID' \
  -d 'client_secret=YOUR_CLIENT_SECRET' \
  -d 'scope=create_payment_links' \
  -d 'grant_type=client_credentials'
```

```Node.js
const axios = require('axios');

const getToken = async () => {
  try {
    const response = await axios.post('https://uat-accounts.payu.in/oauth/token', null, {
      headers: {
        'Content-Type': 'application/x-www-form-urlencoded'
      },
      data: 'client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&scope=create_payment_links&grant_type=client_credentials'
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error getting token:', error);
  }
};

getToken();
```

```Ruby
require 'uri'
require 'net/http'

url = URI("https://uat-accounts.payu.in/oauth/token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/x-www-form-urlencoded"
request.body = "client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&scope=create_payment_links&grant_type=client_credentials"

response = http.request(request)
puts response.read_body
```

```PHP
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://uat-accounts.payu.in/oauth/token');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, "client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&scope=create_payment_links&grant_type=client_credentials");

$headers = array();
$headers[] = 'Content-Type: application/x-www-form-urlencoded';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

echo $result;

?>
```

```Python
import requests

url = "https://uat-accounts.payu.in/oauth/token"

payload = {
    'client_id': 'YOUR_CLIENT_ID',
    'client_secret': 'YOUR_CLIENT_SECRET',
    'scope': 'create_payment_links',
    'grant_type': 'client_credentials'
}
headers = {
    'Content-Type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
```

--------------------------------

### Initiate Payment (Swift)

Source: https://docs.payu.in/docs/ios-checkoutprosdk-integration-steps

Demonstrates how to initiate a payment using the PayU CheckoutPro SDK in Swift. It shows the necessary parameters, including the view controller, payment parameters, configuration, and delegate.

```swift
PayUCheckoutPro.open(on: self, paymentParam: paymentParam, config: <PayUCheckoutProConfig>, delegate: self)
```

--------------------------------

### cURL Request Example for PayU API

Source: https://docs.payu.in/reference/get-prepaid-recharge-plans-api

An example of how to make a POST request to the PayU NBC API using cURL.

```bash
curl --request POST \
     --url https://bbps-sb.payu.in/payu-nbc/v3/nbc/getRechargePlans \
     --header 'content-type: application/json'
```

--------------------------------

### Example Merchant Sign-up URL with Email

Source: https://docs.payu.in/docs/enable-co-branded-onboarding-oauth-for-partners

An example of the onboarding URL with both the reseller ID and a specific merchant's email address appended, directing the merchant to the appropriate sign-in or sign-up page.

```plaintext
https://onboarding.payu.in/app/account/signup?reseller_id=11ea-c29b-c691cce0-8256-02aa98a2d2b0&email=ishikanarang27@gmail.com
```

--------------------------------

### Handle Get Transaction Info API Response (Java)

Source: https://docs.payu.in/docs/get-transaction-info-api-android-core-sdk

Provides an example of how to handle the response from the Get Transaction Info API using an `onGetTransactionApiListener`. It logs the raw response received from the API.

```java
@Override
public void onGetTransactionApiListener(PayuResponse payuResponse) {
   Log.d(TAG, "onGetTransactionApiListener: " + payuResponse.getRawResponse());
}
```

--------------------------------

### Initialize PayU Object

Source: https://docs.payu.in/docs/integration-phpsdk

Creates an instance of the PayU class and initializes the gateway with environment, key, and salt. Requires the PayU SDK.

```php
namespace <namespace_name>;
require_once('PayU.php');
$payu_obj = new PayU();
```

```php
$payu_obj->env_prod = 0;  //  1 for Live Environment/ 0 for SandBox Environment
    $payu_obj->key = '<key>';
    $payu_obj->salt = '<salt>';

    $res = $payu_obj->initGateway();
```

--------------------------------

### Build PayU Object

Source: https://docs.payu.in/docs/integrate-gosdk

Instantiate the PayU client with merchant credentials and environment.

```APIDOC
## Build the PayU Object

Use the sample code snippet to build an instance of PayU Object:

### Method
```javascript
const PayU = require("payu");

const payuClient = new PayU({
  key: "<YOUR_MERCHANT_KEY>",
  salt: "<YOUR_MERCHANT_SALT>",
},"<ENVIRONMENT>"); // Possible value  = TEST/LIVE
```
```

--------------------------------

### Get TDR API Request (cURL)

Source: https://docs.payu.in/reference/get_tdr_api

Example cURL request to the PayU Get TDR API. It includes the endpoint, headers, and form data with parameters like key, command, transaction ID (var1), and hash.

```curl
curl -X POST "https://test.payu.in/merchant/postservice?form=2" \
-H "accept: application/json" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "key=JP***g&command=get_TDR&var1=403993715521891555&hash=a0cf2d4ed3fb551388bd9e078f7ace8fb565d3240e06735cfc83330bb604b0f97a26a31160f1987af4ba5f78e126f400826a62d71337395e6e127b28a62b860d"
```

--------------------------------

### PayU Merchant Login URL Example

Source: https://docs.payu.in/docs/workflow-cobranded-onboarding

An example of the PayU merchant login URL, showing the correct format for reseller ID and merchant email to initiate the login flow.

```text
https://onboarding.payu.in/app/account?reseller_id=11ea-c29b-c691cce0-8256-02aa98a2d2b0&email=[ishikanarang27@gmail.com](mailto:ishikanarang27@gmail.com)
```

--------------------------------

### Get Transaction Info API

Source: https://docs.payu.in/docs/get-transaction-info-api-android-core-sdk

Retrieve transaction details using the Get Transaction Info API. This involves setting the merchant key, command, start date, end date, and an API command hash.

```APIDOC
## POST /v1/get_transaction_info

### Description
This endpoint retrieves transaction details between a specified start and end time.

### Method
POST

### Endpoint
/v1/get_transaction_info

### Parameters
#### Request Body
- **key** (string) - Required - Your merchant key.
- **command** (string) - Required - Set to `"get_transaction_info"`.
- **var1** (string) - Required - The starting date/time for fetching transactions.
- **var2** (string) - Required - The ending date/time for fetching transactions.
- **hash** (string) - Required - The API command hash.

### Request Example
```json
{
  "key": "YOUR_MERCHANT_KEY",
  "command": "get_transaction_info",
  "var1": "2023-01-01 00:00:00",
  "var2": "2023-12-31 23:59:59",
  "hash": "CALCULATED_HASH"
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the API call ('success' or 'failed').
- **result** (array) - An array containing transaction details.
  - Each element in the array is an object with transaction-specific fields.

#### Response Example
```json
{
  "status": "success",
  "result": [
    {
      "transaction_id": "txn123",
      "amount": "100.00",
      "status": "captured",
      "timestamp": "2023-10-27T10:00:00Z"
    },
    {
      "transaction_id": "txn456",
      "amount": "50.50",
      "status": "refunded",
      "timestamp": "2023-10-28T11:30:00Z"
    }
  ]
}
```
```

--------------------------------

### Get Checkout Details API JSON Response Example

Source: https://docs.payu.in/docs/get-checkout-details-api-ios-core-sdk

This JSON structure represents a typical response from the Get Checkout Details API, detailing various flags for retrieving payment information and filtering options.

```json
{
        "useCase":{
            "getExtendedPaymentDetails":true,
            "getTaxSpecification":true,
            "checkDownStatus":true,
            "getAdditionalCharges":true,
            "getOfferDetails":true,
            "getPgIdForEachOption":true,
            "checkCustomerEligibility":true,
            "getMerchantDetails":true,
            "getPaymentDetailsWithExtraFields":true
        },
        "filters":{
            "paymentOptions":{
                "emi":{
                    "dc":"HDFC",
                    "cardless":"ZESTMON"
                },
                "bnpl":"MOBIZIP"
            }
        },
        "requestId":"iOS230113135103",
        "customerDetails":{
            "mobile":"9876543210"
        },
        "transactionDetails":{
            "amount":"1"
        }
    }
```

--------------------------------

### Create PayU Client Object in Go

Source: https://docs.payu.in/docs/integrate-go-sdk

Sample Go code to create an instance of the PayU client. It requires merchant key, salt, and environment details.

```go
import (
 payu "github.com/payu-india/web-sdk-go"
)

payuClient, err := payu.NewClient(
  <YOUR_MERCHANT_KEY>,
  <YOUR_MERCHANT_SALT>,
  <ENVIRONMENT>,
) 

```

--------------------------------

### Get Single Payment Link - Failure Response

Source: https://docs.payu.in/reference/get-single-payment-link

Example of a failure response when a payment link is not found. It indicates an error status and a message explaining the issue.

```json
{
  "status": -1,
  "message": "paymentLink not found",
  "result": null,
  "errorCode": null,
  "guid": null
}
```

--------------------------------

### Get Installed UPI Apps in React.js

Source: https://docs.payu.in/docs/reactnative-upisdk-integration-steps

Initializes and launches the UPI SDK to retrieve a list of all UPI applications installed on the device. The callback function receives the list of apps.

```javascript
PayUUPI.intentApps((intentApps) => {
        //list of installed UPI Apps
      });
```

--------------------------------

### Sample Payment Initialization Request

Source: https://docs.payu.in/reference/print-receipts-api

Example Java code demonstrating how to initialize and send a payment request.

```APIDOC
## Sample Payment Initialization Request

### Description
This code snippet demonstrates how to prepare and send a payment initialization request using the PayU SDK.

### Method
JAVA

### Endpoint
Not Applicable (SDK method)

### Request Example
```java
Bitmap bitmap = BitmapFactory.decodeResource(getApplicationContext().getResources(), R.drawable.payswiff);
Map<String, Bitmap> map = new HashMap<String, Bitmap> ();
String bmp0 = "bmp0;";
map.put(bmp0, bitmap);
StringBuffer buffer = new StringBuffer();
buffer.append("*line\n!yspace 5\n");
buffer.append("*line\n!yspace 5\n");
buffer.append("*image c 200 * 300 path:" + bmp0 + "\n");
buffer.append("*line\n!yspace 5\n");
buffer.append("*text c आपका पाठ यहाँ जाता है\n");
buffer.append("*line\n!yspace 5\n");
buffer.append("!qrcode 200 2\n*qrcode c ABCDEFG\n");
buffer.append("*line\n!yspace 5\n");
buffer.append("*text c € £ $ ¥ ₹\n");
buffer.append("*line\n!yspace 5\n");
buffer.append("!barcode 3 100\n*barcode c 1234567\n");

PaymentInitialization initialization = new PaymentInitialization(N910PrinterActivity.this);
initialization.printImage(printerHandler, DeviceType.N910, buffer, map, "Yantramanav-Medium.ttf");
```
```

--------------------------------

### Initialize PayU SDK and Show Cards

Source: https://docs.payu.in/docs/virtual-cards-integration-android-sdk

Initialize the PayU SDK by creating a `OnePayUJSParams` object with environment, merchant details, and user information. Then, call the `showCards` function to display the virtual cards interface, providing activity context, parameters, and a listener for callbacks.

```Kotlin
val onePayUJSParams = OnePayUJSParams(
    environment = <Environment - Prod or Test>,
    merchantKey = <String - Merchant Key>,
    mobileNumber = <String - user mobile number>,
    walletIdentifier = <String - merchant wallet Identifier>,
    walletUrn = <String - User wallet urn linked with aboved mobile number>,
    referenceId = <String - Any unique reference id>
)

onePayUJSSDK.showCards(
    activity,
    onePayUJSParams,
    onePayUJSListener
) {
    val hashMap = HashMap<String, String?>()
    val hashGenerationOnePayUJKListener = OnePayUJSHashGenerationListener()
    // 1. onCancel() - If user press back button on card page or verify otp page
    // 2. fun onError(code: Int, message: String) - If any error occurred
    // 3. fun generateHash(map: HashMap<String, String?>, hashGenerationOnePayUJKListener: OnePayUJSHashGenerationListener) - Create and send dynamic hash
}.linkToText()
```

--------------------------------

### List UPI Apps

Source: https://docs.payu.in/docs/integration-steps-flutterupi

Code snippet and response example for fetching the list of installed UPI applications on the device.

```APIDOC
## List the UPI apps

### Description
Initialise and launch the Flutter UPI SDK by calling the following code snippet to get the list of UPI apps installed on Android and iOS devices.

### Method
GET

### Endpoint
`/upi/apps` (Implied)

### Request Example
```dart
intentApps() async {
    var data = await payUUpiFlutter.intentApps();
    showAlertDialog(context, "intentApps", "$data");
  }
```

### Response
#### Success Response (200)
- **data** (Object) - Contains details of the UPI app.
  - **value** (String) - Identifier for the UPI app (e.g., package name for Android).
  - **title** (String) - Display name of the UPI app (e.g., "Paytm").

#### Response Example
```json
{
  "data": {
    "value": "net.one97.paytm",
    "title": "Paytm"
  }
}
```
```

--------------------------------

### SDK Integration Steps - Android PhonePe SDK

Source: https://docs.payu.in/docs/android-phonepesdk-integration-steps

This section outlines the essential steps to integrate the PayU PhonePe SDK into your Android project, from initial setup to making payments.

```APIDOC
## SDK Integration Steps - Android PhonePe SDK

### Step 1: Create a PayU account
First, create a PayU account. See [Register for a Merchant Account](https://help.payu.in/hc/en-us/articles/203110493-How-to-register-for-a-merchant-account).

### Step 2: Set up build.gradle
Add the following URL in the root project's build.gradle:

```
allprojects {
  repositories {
    maven {
      url "https://phonepe.mycloudrepo.io/public/repositories/phonepe-intentsdk-android"
    }
  }
}
```

Add the following dependency in your application's build.gradle:

```
implementation 'in.payu:phonepe-intent:1.8.7'
```

### Step 3: Create Callbacks Instance
PayUPhonePeCallback provides the following callback methods:

*   `onPaymentOptionFailure(String payuResponse, String merchantResponse)`: Calls when payment fails.
*   `onPaymentOptionSuccess(String payuResponse, String merchantResponse)`: Calls when payment succeeds.
*   `onPaymentOptionInitialisationFailure(int errorCode, String description)`: Called for PhonePe initialisation failure.
*   `onPaymentOptionInitialisationSuccess(boolean result)`: Callback when PhonePe is successfully initialised.

Following are error messages concerning PhonePe initialization failure:

| Error Code                                  | Description                                      |
| :------------------------------------------ | :----------------------------------------------- |
| `MERCHANT_KEY_NOT_REGISTER_FOR_PHONEPE` | Merchant is not registered for PhonePe with PayU |

Create an instance of PayUPhonePeCallback similar to the following code block:

```java
PayUPhonePeCallback payUPhonePeCallback = new PayUPhonePeCallback() {
    @Override
    public void onPaymentOptionFailure(String payuResponse, String merchantResponse) {
        //Called when Payment gets failed.
    }

    @Override
    public void onPaymentOptionInitialisationSuccess(boolean result) {
        super.onPaymentOptionInitialisationSuccess(result);
        // Merchants are advised to show PhonePe option on their UI after this callback is called.
    }

    @Override
    public void onPaymentOptionSuccess(String payuResponse, String merchantResponse) {
        //Called when Payment gets successful.
    }

    @Override
    public void onPaymentOptionInitialisationFailure (int errorCode, String description) {
        //Callback thrown in case PhonePe initialisation fails.
    }
};
```

### Step 4: Set up for Test/Sandbox merchant
If you are using the SDK with a test merchant, provide the following metadata value to the manifest file:

```xml
<application>
    <meta-data
        android:name="payu_web_service_url"
        android:value="https://test.payu.in" />
    <meta-data
        android:name="payu_post_url"
        android:value="https://test.payu.in" />
</application>
```

### Step 5: Check for PhonePe availability
SDK provides the `checkForPaymentAvailability` method to check if PhonePe payment is available or not on the device. This method must be executed before showing PhonePe as a checkout option.

```java
PhonePe.getInstance().checkForPaymentAvailability(Activity activity, PayUPhonePeCallback callback, String paymentOptionHash, String merchantKey, String user_credentials)
```

Where:

*   `PayUPhonePeCallback`: the class to provide callbacks
*   `Activity`: Activity
*   `paymentOptionHash`: Payment Related Details hash
*   `merchantKey`: PayU Merchant Key
*   `user_credentials`: Provide user credentials or use “default"

> 📘
> ### Generate PaymentOption Hash
> To generate `PaymentOption` Hash refer to [Generate Static Hash](https://www.payu.in/docs/hash-generation). 
> **Formula** :-`sha512(key|command|var1|salt)`
> where
>   * `key`=YOUR KEY
>   * `command`="payment_related_details_for_mobile_sdk" // Api Commands
>   * `salt`= YOUR SALT
>   * `var1`= default // Pass `default` value in var1

### Step 6: Make Payment by PhonePe
After successful initialization of PhonePe by calling `checkForPaymentAvailability` method, call `makePayment` method to make payment.

```java
PhonePe.getInstance().makePayment(PayUPhonePeCallback callback, Activity activity, String postData,boolean isUserCacheEnabled, View customDialogView);
```

Where:

*   **`PayUPhonePeCallback`**: the class to provide callbacks
*   **`Activity`**: activity instance
*   **`postData`**: PayU postdata
*   **`isUserCacheEnabled`**: To Enable/Disable User Cache
*   **`customDialogView`**: Provide your Custom Progress dialog view (Optional)

> 📘
> ### Generate Payment Hash
> To generate a `Payment` Hash refer to [Hash Generation](https://www.payu.in/docs/hash-generation).
> **Formula** :-`sha512(key|txnid|amount|productinfo|firstname|email|udf1|udf2|udf3|udf4|udf5||||||salt)`

### Sample PostData

```
txnid=1524122818080&productinfo=product_info&user_credentials=default&key=*****&surl=**SUCCESS_URL**&furl=**FAILURE_URL&firstname=firstname&email=test@gmail.com&amount=10&udf1=udf1&udf2=udf2&udf3=udf3&udf4=udf4&udf5=udf5&pg=CASH&bankcode=PPINTENT&hash=***PAYMENT_HASH***
```
```

--------------------------------

### Get Tokenized Stored Cards API Setup (Java)

Source: https://docs.payu.in/docs/tokenized-payment-android-core-sdk

Sets up the MerchantWebService for the Get Tokenized Stored Cards API, requiring merchant key, command, user credentials, and hash.

```java
MerchantWebService merchantWebService = new MerchantWebService();
merchantWebService.setKey("<pass the merchant key>");
merchantWebService.setCommand(PayuConstants.GET_TOKENISED_USER_CARD);
merchantWebService.setVar1(user_credentials); //In var1, pass the user_credential
merchantWebService.setHash("<pass the hash value>");
```

--------------------------------

### Referral Link Onboarding

Source: https://docs.payu.in/docs/payu-partner-program-overview

Information on using referral links for onboarding, suitable for freelancers and small businesses.

```APIDOC
## Referral Link Onboarding

### Description
Referral Links offer the lowest integration effort for onboarding merchants, ideal for freelancers and small businesses. This method involves a simple hyperlink.

### Method
Not specified, involves sharing a hyperlink.

### Endpoint
Not specified, but a hyperlink to the PayU referral or onboarding page.

### Parameters
#### Path Parameters
None specified.

#### Query Parameters
None specified.

#### Request Body
None specified.

### Request Example
```json
{
  "example": "A simple hyperlink is provided to the partner."
}
```

### Response
#### Success Response (200)
Success is indicated by the referred merchant completing the onboarding process via the link.

#### Response Example
```json
{
  "example": "Referral success confirmation."
}
```
```

--------------------------------

### Get Aggregator Transactions API Request (cURL)

Source: https://docs.payu.in/reference/get_aggregator_parent_transaction_info_api

Example of how to call the Get Aggregator Transactions API using cURL. It demonstrates the POST request with necessary headers and form-urlencoded data, including keys, commands, and transaction-specific variables.

```curl
curl --location --request POST 'https://info.payu.in/merchant/postservice?form=2' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'key=A****J' \
--data-urlencode 'command=get_aggregator_transactions' \
--data-urlencode 'var1=2021-12-29 22:00' \
--data-urlencode 'hash=586e3379b3d9f90682329cf7efd27273aeb290936d9edf98686370bc59fdc67b06c57a5201b9bd193dc0f00fe6ecd821f60d81d5789ca2ee516db309f28025e9' \
--data-urlencode 'var2=2021-12-29 22:30' \
--data-urlencode 'var3=1' \
--data-urlencode 'var4=100' \
--data-urlencode 'var5='
```

--------------------------------

### Merchant Onboarding Configuration Settings

Source: https://docs.payu.in/reference/sub-account-listing-v3-api

This snippet details the configuration for onboarding steps, specifying requirements for documentation, PAN, bank details, and business information. It helps in defining the mandatory fields for merchant account setup.

```json
{
                        "id": 6852,
                        "name": "skip_onboarding_steps",
                        "config": {
                            "onboarding_steps": {
                                "documentation": {
                                    "agreement_required": false,
                                    "kyc_docs_upload_required": true
                                },
                                "pan_details_required": true,
                                "bank_details_required": true,
                                "website_details_required": false,
                                "business_details_required": true,
                                "aadhar_ckyc_address_required": false,
                                "business_members_details_required": false,
                                "signing_authority_details_required": true
                            }
                        },
                        "configuration_id": null,
                        "active": true,
                        "configurable_type": null,
                        "configurable_id": null,
                        "uuid": "11ef-0669-43985e74-9956-02975f21d323",
                        "created_at": "2024-04-29T20:44:24.000Z",
                        "updated_at": "2024-04-29T20:44:24.000Z",
                        "record_id": 22656,
                        "record_type": "ProductAccount"
                    }
```

--------------------------------

### Get Token API Response Example

Source: https://docs.payu.in/docs/get-token-api-payment-links

Illustrates a typical successful response from the Get Token API. The response includes the access token, its type, expiry duration, scope, and creation timestamp, which are essential for subsequent API calls.

```JSON
{
  "access_token": "82c38b64e072f3d64da6e4e6efee9789ffe1250f0cd04c20753d6e6f25df9cc7",
  "token_type": "Bearer",
  "expires_in": 7200,
  "scope": "send_sign_in_otp",
  "created_at": 1595411399
}
```

--------------------------------

### PayU Object Initialization

Source: https://docs.payu.in/docs/integration-phpsdk

This section details how to initialize the PayU object and set up credentials for live or sandbox environments.

```APIDOC
## Build PayU object

Use the following code snippet to create the instance of the PayU class object:

### Method
```php
<?php
namespace <namespace_name>;
require_once('PayU.php');
$payu_obj = new PayU();
?>
```

Set the credentials data and URL using the following code sample:

### Method
```php
<?php
$payu_obj->env_prod = 0;  //  1 for Live Environment/ 0 for SandBox Environment
$payu_obj->key = '<key>';
$payu_obj->salt = '<salt>';

$res = $payu_obj->initGateway();
?>
```
```

--------------------------------

### POST /merchant/postservice.php - Get Transaction Info

Source: https://docs.payu.in/reference/get_transaction_info_api

The Get Transaction Info API allows you to retrieve details of transactions within a specified time frame. It requires a command parameter 'get_transaction_info' and time parameters for the start and end of the period.

```APIDOC
## POST /merchant/postservice.php

### Description
This endpoint retrieves transaction information based on a provided time range. The API command `get_transaction_info` is used to initiate this request.

### Method
POST

### Endpoint
**Test Environment:** `https://apitest.payu.in/merchant/postservice.php?form=2`
**Production Environment:** `https://info.payu.in/merchant/postservice?form=2`

### Parameters
#### Request Body
- **key** (string) - Required - Your Merchant Key.
- **command** (string) - Required - Should be set to `get_transaction_info`.
- **var1** (string) - Required - The start date and time for fetching transactions (e.g., `YYYY-MM-DD HH:MM:SS`).
- **var2** (string) - Required - The end date and time for fetching transactions (e.g., `YYYY-MM-DD HH:MM:SS`).

### Request Example
```json
{
  "key": "JP***g",
  "command": "get_transaction_info",
  "var1": "2024-10-11 12:00:00",
  "var2": "2024-10-11 14:00:00"
}
```

### Response
#### Success Response (200)
- **status** (integer) - Indicates the success or failure of the request (1 for success, 0 for failure).
- **msg** (string) - A message describing the result of the operation.
- **Transaction_details** (array) - An array of transaction objects, where each object contains detailed information about a transaction.

#### Response Example (Success)
```json
{
      "status": 1,
      "msg": "Transaction Fetched Successfully",
      "Transaction_details": [
            {
                  "id": "403993715521889443",
                  "action": "capture",
                  "status": "SUCCESS",
                  "issuing_bank": "HDFC",
                  "transaction_fee": "10.00",
                  "key": "JP***g",
                  "merchantname": "demo",
                  "txnid": "02fdb4f0a0decd1e4937",
                  "firstname": "Ashish",
                  "lastname": "Kumar",
                  "addedon": "2020-10-26 13:54:52",
                  "bank_name": "Credit Card",
                  "payment_gateway": "AXISPG",
                  "phone": "9876543210",
                  "email": "ashish25@mailinator.com",
                  "amount": "10.00",
                  "discount": "0.00",
                  "additional_charges": "0.00",
                  "productinfo": "iPhone",
                  "error_code": "E000",
                  "bank_ref_no": "895255",
                  "ibibo_code": "CC",
                  "mode": "CC",
                  "ip": "106.202.49.52",
                  "card_no": "512345XXXXXX2346",
                  "cardtype": "domestic",
                  "offer_key": "",
                  "field2": "171519",
                  "udf1": "",
                  "pg_mid": null,
                  "offer_type": null,
                  "failure_reason": null,
                  "mer_service_fee": "0.00",
                  "mer_service_tax": "0.00"
            }
      ]
}
```

#### Response Example (No Transactions Found)
```json
{
      "status": 1,
      "msg": "Transaction Fetched Successfully",
      "Transaction_details": []
}
```

#### Response Example (Invalid Date Format)
```json
{
      "status": 0,
      "msg": "Invalid Date Entered. Date format should be yyyy-mm-dd"
}
```

### Further Information
- For details on fields in the JSON response, refer to [Additional Info for General APIs](link_to_additional_info).
- For information on possible error codes and their descriptions, refer to [Error Codes](link_to_error_codes).
```

--------------------------------

### Initialize PayU Object

Source: https://docs.payu.in/docs/integrate-gosdk

Creates an instance of the PayU object using merchant credentials (key and salt) and environment (TEST/LIVE). This object is used to interact with the PayU API.

```javascript
const PayU = require("payu");

const payuClient = new PayU({
  key: <YOUR_MERCHANT_KEY>,
  salt: <YOUR_MERCHANT_SALT>,
},<ENVIRONMENT>);     // Possible value  = TEST/LIVE
```

--------------------------------

### Get Single Payment Link API Request (Ruby)

Source: https://docs.payu.in/reference/get_single_payment_link_api

This Ruby example fetches a single payment link using the 'httparty' gem. It constructs the API endpoint and sets required headers like 'Content-Type', 'merchantId', and 'Authorization' for the GET request.

```ruby
# Make sure to replace 'YOUR_INVOICE_NUMBER', 'YOUR_MERCHANT_ID', and 'YOUR_ACCESS_TOKEN'
# You'll also need to have httparty installed: gem install httparty

require 'httparty'

def get_payment_link(invoice_number, merchant_id, access_token)
  url = "https://uat-partner.payu.in/api/#{invoice_number}"
  headers = {
    'Content-Type' => 'application/json',
    'merchantId' => merchant_id,
    'Authorization' => "Bearer #{access_token}"
  }

  begin
    response = HTTParty.get(url, headers: headers)
    if response.success?
      return response.parsed_response
    else
      puts "Error fetching payment link: Status Code #{response.code}"
      puts "Response: #{response.body}"
      return nil
    end
  rescue StandardError => e
    puts "An error occurred: #{e.message}"
    return nil
  end
end

# Example usage:
# result = get_payment_link('YOUR_INVOICE_NUMBER', 'YOUR_MERCHANT_ID', 'YOUR_ACCESS_TOKEN')
# if result
#   puts result
# end
```

--------------------------------

### API Response Examples (JSON)

Source: https://docs.payu.in/reference/get_merchant_api

This section provides examples of JSON responses for various scenarios, including a successful merchant data retrieval, unauthorized requests, invalid merchant IDs, and not found errors. These examples illustrate the structure and content of API outputs.

```json
{
  "merchant": {
    "name": "test7_6july20",
    "email": "test3_6july20.aman.garg@payutest.in",
    "registered_mobile": "9466811031",
    "mid": 7060013,
    "product": "PayUmoney",
    "business_type": "LongTail",
    "business_name": null,
    "pancard_name": null,
    "pancard_number": null,
    "website_url": null,
    "android_url": null,
    "ios_url": null,
    "gst_number": null,
    "created_at": "2020-07-06T12:58:17.000Z",
    "mobile": "9466811031",
    "blocked": false,
    "first_name": "",
    "last_name": "test7_6july20",
    "bank_detail": {
      "bank_account_number": null,
      "ifsc_code": null,
      "holder_name": null,
      "nodal_code": null,
      "nodal_status": "Not Activated"
    },
    "operating_address": {
      "address_line": null,
      "city": null,
      "state": null,
      "pincode": null
    },
    "registration_address": {
      "address_line": null,
      "city": null,
      "state": null,
      "pincode": null
    },
    "business_entity": null,
    "status": "account_created",
    "partner_source": "Create Merchant API",
    "pan_verification_status": "Pending",
    "website_approval_status": "Not Applicable",
    "notification_email": "test3_6july20.aman.garg@payutest.in",
    "settlement_status": null,
    "is_service_agreement_accepted": false,
    "is_authorisation_letter_required": true,
    "monthly_expected_volume": null,
    "business_category": null,
    "business_sub_category": null,
    "bank_verification_status": null,
    "penny_deposit_status": null,
    "uuid": "11ea-bf88-5c1eb1f4-9363-0acb18027a2a",
    "document_status": "Pending"
  }
}
```

```json
{
  "status": "Unauthorized"
}
```

```json
{
  "data": {
    "message": "Invalid merchant mid"
  }
}
```

```json
{
  "error": "Partner Not Found"
}
```

```json
{
  "status": "NotFound"
}
```

--------------------------------

### Initialize PayU Client (Java)

Source: https://docs.payu.in/docs/integration-javasdk

This code snippet shows how to create an instance of the PayU Client for the Java SDK. You need to provide your merchant key and salt.

```java
PayuClient payuClient = PayuClient.init("KEY", "SALT");
// Need to set merchant key and salt
```

--------------------------------

### Get Single Payment Link - Success Response

Source: https://docs.payu.in/reference/get-single-payment-link

Example of a successful response when retrieving a single payment link. It includes details like invoice number, payment link URL, status, and timestamps.

```json
{
  "status": 0,
  "message": null,
  "result": {
    "summary": {
      "amountRequested": 2,
      "totalRevenue": 0,
      "totalViews": 0
    },
    "subAmount": 2,
    "tax": 0,
    "shippingCharge": 0,
    "totalAmount": 2,
    "totalAmountCollected": 0,
    "invoiceNumber": "INV8446471886220",
    "paymentLink": "http://pp72.pmny.in/4IwlctBtwp2V",
    "description": "paymentLink for testing",
    "active": true,
    "isPartialPaymentAllowed": false,
    "status": "active",
    "expiryDate": "2023-03-21T14:53:52.000+0530",
    "udf": {
      "udf1": null,
      "udf2": null,
      "udf3": null,
      "udf4": null,
      "udf5": null
    },
    "address": {
      "line1": null,
      "line2": null,
      "city": null,
      "state": null,
      "country": null,
      "zipCode": null
    },
    "addedOn": "2022-03-21T14:53:53.000+0530",
    "isAmountFilledByCustomer": false,
    "isScheduled": 0,
    "reminderCount": 0,
    "customAttributes": []
  },
  "errorCode": null,
  "guid": null
}
```

--------------------------------

### API Reference - Webhook Configuration

Source: https://docs.payu.in/docs/pythonsdk-go-live-checklist

Guidance on setting up webhooks to receive real-time payment responses directly on your server, ensuring reliable status updates.

```APIDOC
## POST /webhooks/configure

### Description
Configures a webhook URL to receive asynchronous payment status notifications.

### Method
POST

### Endpoint
/webhooks/configure

### Parameters
#### Request Body
- **merchantId** (string) - Required - The unique identifier for your merchant account.
- **webhookUrl** (string) - Required - The URL on your server to receive webhook notifications.
- **eventTypes** (array of strings) - Optional - Specifies which events to receive notifications for (e.g., ["PAYMENT_SUCCESS", "PAYMENT_FAILURE"]).

### Request Example
```json
{
  "merchantId": "your_merchant_id",
  "webhookUrl": "https://your-server.com/payu-callback",
  "eventTypes": [
    "PAYMENT_SUCCESS",
    "PAYMENT_FAILURE"
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the webhook has been configured.

#### Response Example
```json
{
  "message": "Webhook configured successfully."
}
```
```
Tokens:
Raw