UPI Collect One-Time Mandate Integration

The merchant initiates a call to PayU with the SI details, pg, bankcode, and pre-authorization amount. This amount is considered the Block Amount.
Using these details, Payu will then relay the callback with the current status to the merchant.

The pre_authorize parameter is used for pre-authorize payments using the seamless integration with the _payment API.

Step 1: Post the Pre-Auth transaction request

Post the additional parameters for with the Pre-Authorization using the Merchant Hosted Checkout. For API Reference, refer to UPI One-Time Mandate Consent Transaction API.

Environment

The pre_authorize parameter as specified is used to pre-authorize payments using the Merchant Hosted Checkout integration with the _payment API.

  <th>
    Description
  </th>

  <th>
    Example
  </th>
</tr>

  <td>
    `varchar` This parameter is the unique Merchant Key provided by PayU for your merchant account.
  </td>

  <td>
    Your Test Key
  </td>
</tr>

<tr>
  <td>
    txnid\
    `mandatory`
  </td>

  <td>
    `varchar` This parameter is known as Transaction ID (or Order ID). It is the order reference number generated at your (Merchant’s) end. It is an identifier that you (merchant) would use to track a particular order. If a transaction using a particular transaction ID has already been successful at PayU, the usage of the same Transaction ID again would fail. Hence, you must post us a unique transaction ID for every new transaction.\
    `Character limit`: 25  

    * \*Note\*\*: Ensure that the transaction ID sent to us has not been successful earlier. In case of this duplication, the customer would get an error of ‘duplicate Order ID.’
  </td>

  <td>
    fd3e847h2
  </td>
</tr>

<tr>
  <td>
    amount\
    `mandatory`
  </td>

  <td>
    `float` This parameter should contain the payment amount of the particular transaction.  

    * \*Note\*\*: Type-cast the amount to float type
  </td>

  <td>
    1000
  </td>
</tr>

<tr>
  <td>
    productinfo\
    `mandatory`
  </td>

  <td>
    `varchar` This parameter should contain a brief product description. It should be a string describing the product.\
    `Character limit`: 100
  </td>

  <td>
    Time Magazine Subscription
  </td>
</tr>

<tr>
  <td>
    firstname\
    `mandatory`
  </td>

  <td>
    `varchar` Must contain the first name of the customer.\
    `Character limit`: 60
  </td>

  <td>
    Ashish
  </td>
</tr>

<tr>
  <td>
    email\
    `mandatory`
  </td>

  <td>
    `varchar` Must contain the email of the customer.\
    This information is helpful when it comes to issues related to fraud detection and chargebacks. Hence, it is a must to provide the correct information.\
    Also, MIS reporting is shared with few issuing banks where email and mobile number is used to keep track of users using SI transactions.\
    Character limit: 50
  </td>

  <td>
    [[email protected]](mailto:[email protected])
  </td>
</tr>

<tr>
  <td>
    phone\
    `mandatory`
  </td>

  <td>
    `varchar` Must contain the phone number of the customer.  

    This information is helpful when it comes to issues related to fraud detection and chargebacks. Hence, it is must to provide the correct information.\
    Character limit: 50
  </td>

  <td>
    9843176540
  </td>
</tr>

<tr>
  <td>
    surl\
    `mandatory`
  </td>

  <td>
    surL is the acronym for Success URL. This parameter must contain the URL on which PayU will redirect the final response if the transaction is successful.
  </td>

  <td>

  </td>
</tr>

<tr>
  <td>
    furl\
    `mandatory`
  </td>

  <td>
    furl is the acronym for for Failure URL. This parameter must contain the URL on which PayU will redirect the final response if the transaction is failed.
  </td>

  <td>

  </td>
</tr>

<tr>
  <td>
    pg\
    `mandatory`
  </td>

  <td>
    It defines the payment category for which you wish to perform UPI One-Time Mandate integration. For UPI, **pg= UPI**
  </td>

  <td>
    UPI
  </td>
</tr>

<tr>
  <td>
    bankcode\
    `mandatory`
  </td>

  <td>
    It defines the bank with which you wish to perform UPI Collect One-Time Mandate integration using the bank code. For UPI Collect, use **UPI**.
  </td>

  <td>
    UPI
  </td>
</tr>

<tr>
  <td>
    vpa\
    `mandatory for Collect flow`
  </td>

  <td>
    This parameter contains the customer’s VPA handle. For the list UPI handles supported, refer to UPI Handles  

    The merchant is advised to check the validity of the VPA through using the VPA Validation API. PayU extends support for the same if required. For more information on using VPA Validation API, refer to  [Validate VPA API](ref:validate_vpa_api).
  </td>

  <td>
    anything\@payu
  </td>
</tr>

<tr>
  <td>
    txn\_s2s\_flow\
    `mandatory`
  </td>

  <td>
    This parameter must be passed with the values as **4** for UPI Intent.
  </td>

  <td>
    4
  </td>
</tr>

<tr>
  <td>
    pre\_authorize\
    `mandatory for Pre-Auth`
  </td>

  <td>
    This parameter is set to**1** to pre-authorize payment.
  </td>

  <td>
    1
  </td>
</tr>

<tr>
  <td>
    si\_details
  </td>

  <td>
    This parameter contains the following information in JSON format:  

    * paymentStartDate
    * paymentEndDate**Example**:  \{"paymentStartDate":"2024-07-24","paymentEndDate":"2024-07-28"}
  </td>

  <td>

  </td>
</tr>

<tr>
  <td>
    hash\
    `mandatory`
  </td>

  <td>
    Hash is a crucial parameter used to ensure that any date is not tampered while redirecting customer from the merchant website to PayU’s payment interface while registration transactions.  

    It is SHA512 hash generated by encrypting values of merchant key, txnid, amount, productinfo, firstname, email, udf and si\_details by merchant salt.  

    In the case of registration transaction, the formula is used to calculate this hash is similar to the following:\
    \`HASH = sha512(key|txnid|amount|productinfo|firstname|email|udf1|udf2|udf3|udf4|udf5||||||SALT)
  </td>

  <td>

  </td>
</tr>

Hashing

You must hash the request parameters using the following hash logic:

sha512(key|txnid|amount|productinfo|firstname|email|udf1|udf2|udf3|udf4|udf5||||||SALT)

For more information, refer to Generate Hash.

Sample request

curl --request POST  

--url https://test.payu.in/_payment  
--header 'accept: text/plain'  
--header 'content-type: application/x-www-form-urlencoded'  
--data key=JPM7Fg  
--data pg=UPI  
--data bankcode=UPI  
--data vpa=anything@payu  
--data txn_s2s_flow=4  
--data txnid=aso6787  
--data siDetails="{"paymentStartDate": "2019-09-01","paymentEndDate": "2019-12-01"}"  
--data pre_authorize=1 \ 
 --data amount=100.00  
--data productinfo=iPhone  
--data firstname=Ashish  
--data [email protected]  
--data phone=9876543210  
--data surl=https://apiplayground-response.herokuapp.com/  
--data furl=https://apiplayground-response.herokuapp.com/  
--data hash=8e8de8a3cf2ba999e16c0ffdb63a645074af4ad1aa0a8d66d81555a119c004e1791173fe6199084f256623664b250d3aeb50fc2c4cfc155e729d8811a157c98b 

Step 2: Check the response from PayU

Success scenario

{ 
   "metaData":{ 
      "message":null, 
      ""referenceId":"c5161bae370de1bd4fb886c6c66567a8", 
      "statusCode":null, 
      ""txnId":"a7440cc636e747b635df", 
      ""txnStatus":"pending", 
      ""unmappedStatus":"pending" 
   }, 
   "result":{ 
      "postToBank":{ 
         "useMethodGet":true 
      }, 
      "issuerUrl":"https://api.payu.in/ public/#/c5161bae370de1bd4fb886c6c66567a8/upiLoader" 
   } 
} 
 

Failure scenarios

{ 
   "metaData":{ 
      "message":"Transaction failed due to invalid params shared by the merchant", 
      "referenceId":"dde7096af9db932a9fd09b9b4383d8be", 
      "statusCode":"E1101", 
      "txnId":"0c4931ddee7a4f69227f", 
      "txnStatus":"failed", 
      "unmappedStatus":"failure" 
   }, 
   "result":{ 
       
   } 
} 

Step 3: Capture a pre-authorized payment

To capture a pre-authorized payment, use the following command. After the API command is successful, the transaction would be captured and settled to you.=

  <th>
    Description
  </th>
</tr>

    mandatory
    ```
  </td>

  <td>
    This parameter is the unique Merchant Key provided by PayU for your merchant account. The Merchant Key acts as the unique identifier (primary key) to identify a Merchant Account in our database. <br> *Sample value* – YbfVda
  </td>
</tr>

<tr>
  <td>
    command ```

    mandatory
    ```
  </td>

  <td>
    For initiating a capture transaction, the value of the parameter will be passed as - **capture\_transaction**
  </td>
</tr>

<tr>
  <td>
    hash ```

    mandatory
    ```
  </td>

  <td>
    This parameter must contain the hash value to be calculated at merchant end. Hash logic for this API is:\
    sha512(key|command|var1|salt)
sha512
  </td>
</tr>

<tr>
  <td>
    var1```

    mandatory
    ```
  </td>

  <td>
    This parameter must contain the payuId that was generated by PayU as part of pre-authorize operation.
  </td>
</tr>

<tr>
  <td>
    var2 ```

    mandatory
    ```
  </td>

  <td>
    This parameter contains the token, that is, merchant unique reference number.
  </td>
</tr>

<tr>
  <td>
    var3```

    mandatory
    ```
  </td>

  <td>
    This parameter must contain the amount to be captured.
  </td>
</tr>

Sample request

curl --location --request POST 'https://info.payu.in/merchant/postservice.php?form=2' \   
 --header 'Content-Type: application/x-www-form-urlencoded' \   
 --form 'key="JF***g"' \   
 --form 'command="capture_transaction"' \   
 --form 'hash="67411736ab98c59522492a12751a6015c41b87764019f9dc14052690c2c7af9095d31002fc109dcf3596c2f38792d56db6f6207b1989010f2adf51c144fa3019"' \   
 --form 'var1="15246574846"' \   
 --form 'var2="authorizeTransaction123"' \   
 --form 'var3="1"'  

 

Sample response

{
  "msg": "Transaction Processed successfully",
  "status": 1,
  "result": {
    "payuid": 613345678912399031,
    "txnId": "upiAuthCapture_12",
    "amount": 10000.00,
    "merchantId": 3,
    "authpayuid": "3975",
    "status": "in progress",
    "mode": "UPIOTM",
    "bankRefNumber": "410700457030",
    "payerVpa": "surya@icici",
    "field5": "3159219e58ed45eda39e8914b998401a@icici",
    "field9": "0|Transaction Successful"
  }
}

Step 4: Check Transaction Status

To check the status of the transaction, use the verify_payment API. For more information, refer to Verify Payment API.