UPI

QP Integration option

This integration option supports the following transaction types:

Payment

Request

Info

Check the supported currencies and countries with your manager.

Send a payment request with the following additional parameters:

Parameter	Type	Description
method	object	A section of the payment method.
type * required	string	`upi`
account * required	string	A UPI account.
customer	object	A section of information about your customer.
first_name * required	string	The customer's first name.
last_name * required	string	The customer's last name.
email * required	string	The customer's email address.

Response

The upi response section will have parameters copied from the request. Additionally, you'll get the form parameter to build a form where the customer should be redirected to finalize the payment.

Payout

Request

Send a payout request with the following data:

Parameter	Type	Description
method	object	A section of the payment method.
type * required	string	`upi`
account * required	string	A UPI account.
customer	object	A section of information about your customer.
first_name * required	string	The customer's first name.
last_name * required	string	The customer's last name.
email * required	string	The customer's email address.
address * required	string	The customer's address.
phone * required	string	10 digits of the customer's phone number without the country code.

Response

The upi response section will have parameters copied from the request.

EP Integration option

This integration option supports the following transaction types:

Payment

Request

Send a payment request with the following additional parameters in the method section:

Parameter	Type	Description
method	object	A section of the payment method.
type * required	string	`upi`

Info

A minimum payment amount is 300 Indian rupees (submitted as 30000).

Response

The payment response additionally contains the form section. Redirect your customer to the URL received as a value of the form.action parameter, so he or she can complete the payment.

Info

The customer has only 15 minutes to confirm the payment.

Payout

Request

Send a payout request with the following data:

Parameter	Type	Description
method	object	A section of the payment method.
type * required	string	`upi`

Info

A minimum payout amount is 3000 Indian rupees (submitted as 300000).

Response

The payout response additionally contains the form section. Redirect your customer to the URL received as a value of the form.action parameter.

Info

The customer has only 15 minutes to confirm the payout.

Payment status query

Request

If you specify notification_url in the payment or payout request, Riverbanq sends a webhook notification about a transaction status. Please note, it might take some time for Riverbanq to get the transaction status confirmation from the payment method provider.

If needed, send a status query request to get the current transaction status.

Response

The response contains the transaction status, a section of the payment method as well as other details related to the transaction according to the description of a transaction status query.

PZC Integration option

This integration option supports the payment transaction type:

Payment

Payment flow

The customer selects UPI as a payment opiton.
The merchant sends a payment request to Riverbanq.
The page with the payment details is displayed to the customer.
The customer copies the payment details or scans the QR code, and makes a payment using an application or an internet banking option of their choice.
The customer is redirected to the return_url where the payment status is displayed.
Riverbanq sends a webhook notification to the merchant.

Note

The amount parameter value in the webhook notification and in the response to the transaction status query can be different from the value sent in the initial payment request and will equal the actual paid amount according to the provider's system.

Request

Send a payment request with the following additional parameters in the method section:

Parameter	Type	Description
return_url * required	string	A URL, to which the customer is returned once the transaction is completed.
method * required	object	A section of the payment method.
type * required	string	`upi`
user_id * required	string	Unique customer identifier.
customer	object	A section of information about the customer.
first_name	string	The customer's first name.
last_name	string	The customer's last name.
phone	string (10)	The customer's phone number.
email	string	The customer's email address.

Request example

{
    "request": {
        "amount": 10000,
        "currency": "INR",
        "description": "description",
        "test": false,
        "return_url": "someurl.com",            
        "method": {
            "type": "upi",
            "user_id": "09fce47f-ae55-402f-a181-cc4fab2f2644"              
        }
    }
}

Response

Response example

{
    "transaction": {
        "uid": "c3984a12-c9e4-4470-822b-3334a1e841",
        "type": "payment",
        "status": "pending",
        "amount": 200000,
        "currency": "INR",
        "description": "description",
        "created_at": "2023-08-04T09:17:51Z",
        "updated_at": "2023-08-04T09:17:51Z",
        "method_type": "upi",
        "receipt_url": "https://my.riverbanq.com/customer/transactions/c3984a12-c9e4-4470-822b-3334a1e841/42e9373ede400bfadf09c6edb4628f2ae46de96d01e56be28d98932d37226580",
        "payment": {
            "status": "pending",
            "gateway_id": 3073,
            "message": "Transaction created"
            },
        "upi": {
            "type": "upi",
            "user_id": "09fce47f-ae55-402f-a181-cc4fab2f2644"
        },
        "customer": {
            "email": null,
            "ip": null
            },
        "message": "Transaction created",
        "test": false,
        "additional_data": {
             "payment_method": {
                 "type": "alternative"
            }
        },
        "gateway": {
            "iframe": false
        },
        "form": {
            "action": "https://checkout.pzc.com/payment/t2118183a-0bce-4ba2-9c20-12adf99e133d/83236352389",
            "method": "GET",
            "fields": []
        }
    }
}

PE Integration option

Payment

Payment flow

Customer initiates UPI payment on the merchant's website.
Merchant sends the payment request to Riverbanq
Riverbanq returns a payment link to the merchant.
The merchant redirects the customer to the payment link that opens in the corresponding application on the customer's device.
The customer confirms the payment.
Riverbanq sends a webhook notification to the merchant.

Info

This integration option only supports INR currency.

Request

Send a payment request with the following additional parameters:

Parameter	Type	Description
request	object
return_url * required	string	URL to return the customer to when the transaction is completed.
method	object	A section of the payment method.
type * required	string	`upi`
customer * required	object	A section of information about the customer.
first_name * required	string	The customer's first name.
last_name * required	string	The customer's last name.
email * required	string (100)	The customer's email address.
phone * required	string	The customer's phone number.
external_id	string	The customer's identifier in the merchant's system.

Request example

{
  "request":{
      "amount":20000,
      "currency":"INR",
      "description":"description",
      "duplicate_check": false,
      "test": false,      
      "tracking_id":"your_uniq_number",
      "ip":"127.0.0.1",
      "language":"en",
      "notification_url":"https://merchant.ltd/notification",
      "return_url":"https://merchant.ltd/return",
      "customer":{
        "first_name":"John",
        "last_name":"Doe",       
        "phone":"17777777777",       
        "email": "[email protected]"
      },
      "method":{
        "type": "upi"
      }
  }
}

Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example

{
    "transaction": {
        "uid": "87802f06-270d-4dde-bca3-49c799d0949c",
        "type": "payment",
        "status": "pending",
        "amount": 20000,
        "currency": "INR",
        "description": "description",
        "created_at": "2025-04-17T14:43:25Z",
        "updated_at": "2025-04-17T14:43:25Z",
        "method_type": "upi",
        "receipt_url": "https://my.riverbanq.com/customer/transactions/87802f06-270d-4dde-bca3-49c799d0949c/8cf133b729330a339c117270420b430918847ae4ee86f7b45e247a1a232adad5?language=en",
        "payment": {
            "status": "pending",
            "gateway_id": 5255,
            "message": "Transaction was initialized."
        },
        "upi": {
            "type": "upi"
        },
        "customer": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "phone": "17777777777",
            "ip": "127.0.0.1"
        },
        "manually_corrected_at": null,
        "version": 0,
        "message": "Transaction was initialized.",
        "tracking_id": "your_uniq_number",
        "test": false,
        "language": "en",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "phone": "17777777777"
        },
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        },       
        "gateway": {
            "iframe": false
        },
        "form": {
            "action": "payment-link",
            "method": "GET",
            "fields": []
        }
    }
}