> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-60c89f9a-mintlify-audit-missing-sections-1778528421.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Integrate Turbo UPI TPV
> Third-party validation (TPV) of bank accounts is mandatory for businesses in the BFSI (Banking, Financial Services and Insurance) sector dealing with Securities, Broking and Mutual Funds. You can accept customer payments by integrating with the Turbo UPI - TPV SDK.
### Prerequisites
1. Integrate with [Razorpay Cordova Standard SDK](/payments/payment-gateway/cordova-integration).
2. Import the following frameworks:
* Razorpay Cordova Standard SDK
* Razorpay Turbo Wrapper Plugin SDK (maven)
* Razorpay Turbo Core SDK
* Razorpay Turbo UI SDK
* Razorpay SecureComponent SDK
* Bank SDK
3. Enable data binding in your `app.gradle`.
```json: Data binding theme={null}
{
"android": {
// Containing other settings
"buildFeatures": {
"dataBinding": true
}
}
}
```
**Watch Out!**
* API Key Usage for Different Environments:
* Use the `rzp_test_0wFRWIZnH65uny` API key id for testing on the UAT environment.
* Use the [Razorpay live keys](/api/authentication#live-mode-api-keys) for prod testing.
* As a compliance requirement, you should get approval from Google for **READ\_SMS** permission. Refer [to the Google article](https://support.google.com/googleplay/android-developer/answer/10208820?hl=en) for more details.
## 1. Integration Steps
Given below are the steps:
### Step 1: Whitelist Customer Bank Accounts *(Optional)*
You can whitelist (also known as allowlist) your customer's bank accounts to ensure that only those accounts are considered during customer onboarding. By whitelisting the accounts at the start, you can avoid the bank account linking during payment. Use the Customer APIs to create customers and add their bank account details.
For example, if a customer, Gaurav, has two bank accounts ABC and XYZ, you can use the APIs to create a customer id and link the bank accounts to that id. You can then pass this customer id at the time of payment.
Follow these steps.
Step 1.1: Create a Customer
Use this endpoint to create or add a customer with basic details such as name and contact details.
````cURL: Request theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/customers \
-H "Content-Type: application/json" \
-d '{
"name": "Gaurav Kumar",
"contact": "9123456780",
"email": "gaurav.kumar@example.com",
"fail_existing": "0",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
}
}'
```json: Success Response
{
"id" : "cust_1Aa00000000004",
"entity": "customer",
"name" : "Gaurav Kumar",
"email" : "gaurav.kumar@example.com",
"contact" : "9123456780",
"gstin": null,
"notes": {
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"created_at ": 1234567890
}
```json: Failure Response
{
"error": {
"code": "BAD_REQUEST_ERROR",
"description": "Contact number should be at least 8 digits, including country code",
"source": "business",
"step": "NA",
"reason": "invalid_contact_number",
"metadata": {},
"field": "contact"
}
}
````
Request Parameters
`name` *optional*
: `string` Customer's name. Alphanumeric value with period (.), apostrophe ('), forward slash (/), at (@) and parentheses are allowed. The name must be between 3-50 characters in length. For example, `Gaurav Kumar`.
`contact ` *optional*
: `string` The customer's phone number. A maximum length of 15 characters including country code. For example, `+919876543210`.
`email ` *optional*
: `string` The customer's email address. A maximum length of 64 characters. For example, `gaurav.kumar@example.com`.
`fail_existing` *optional*
: `string` Possible values:
* `1` (default): If a customer with the same details already exists, throws an error.
* `0`: If a customer with the same details already exists, fetches details of the existing customer.
`gstin` *optional*
: `string` Customer's GST number, if available. For example, `29XAbbA4369J1PA`.
`notes` *optional*
: `object` This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, `"note_key": "Beam me up Scotty”`.
### Response Parameters
`id`
: `string` Unique identifier of the customer. For example, `cust_1Aa00000000004`.
`name`
: `string` Customer's name. Alphanumeric, with period (.), apostrophe ('), forward slash (/), at (@) and parentheses allowed. The name must be between 3-50 characters in length. For example, `Gaurav Kumar`.
`contact`
: `string` The customer's phone number. A maximum length of 15 characters including country code. For example, `+919876543210`.
`email`
: `string` The customer's email address. A maximum length of 64 characters. For example, `gaurav.kumar@example.com`.
`gstin`
: `string` GST number linked to the customer. For example, `29XAbbA4369J1PA`.
`notes`
: `json object` This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, `"note_key": "Beam me up Scotty”`.
`created_at`
: `integer` UNIX timestamp, when the customer was created. For example, `1234567890`.
### Step 1.2: Add Customer's Bank Account
The following endpoint adds the customer's bank accounts.
````cURL: Request theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/customers/:customer_id/bank_account \
-H "Content-Type: application/json" \
-d '{
"ifsc_code": "UTIB0000194",
"account_number": "11214311215411",
"beneficiary_name": "Gaurav",
"beneficiary_address1": "address 1",
"beneficiary_address2": "address 2",
"beneficiary_address3": "address 3",
"beneficiary_address4": "address 4",
"beneficiary_email": "gaurav.kumar@example.com",
"beneficiary_mobile": "9900990099",
"beneficiary_city": "Bangalore",
"beneficiary_state": "KA",
"beneficiary_country": "IN"
}'
```json: Response
{
"id": "ba_LSZht1Cm7xFTwF",
"entity": "bank_account",
"ifsc": "ICIC0001207",
"bank_name": "ICICI Bank",
"name": "Gaurav Kumar",
"notes": [],
"account_number": "XXXXXXXXXXXXXXX0434"
}
````
Path Parameter
`customer_id` *mandatory*
: `string` Customer id of the customer whose bank account is to be added.
### Request Parameters
`account_number` *mandatory*
: `string` Customer's bank account number. For example, `11214311215411`.
`beneficiary_name` *mandatory*
: `string` The name of the beneficiary associated with the bank account.
`beneficiary_address1` *optional*
: `string` The virtual payment address.
`beneficiary_email` *optional*
: `string` Email address of the beneficiary. For example, `gaurav.kumar@example.com`.
`beneficiary_mobile` *optional*
: `string` Mobile number of the beneficiary.
`beneficiary_city` *optional*
: `string` The city of the beneficiary.
`beneficiary_state` *optional*
: `string` The state of the beneficiary.
`beneficiary_country` *optional*
: `string` The country of the beneficiary.
`beneficiary_pin` *optional*
: `integer` The pin code of the beneficiary's address.
`ifsc_code` *mandatory*
: `string` The IFSC of the bank branch associated with the account.
### Response Parameters
`bank_accounts`
: `array` An array containing bank account details.
`id`
: `string` Unique identifier of the bank account.
`entity`
: `string` The type of entity, which in this case is `bank_account`.
`ifsc`
: `string` The IFSC of the bank branch associated with the account.
`bank_name`
: `string` The name of the bank.
`name`
: `string` The name associated with the bank account.
`notes`
: `object` Set of key-value pairs that can be used to store additional information about the payment.
`account_number`
: `string` Customer's bank account number. For example, `11214311215411`.
### Step 2: Create an Order *(Mandatory)*
Pass the investor bank account details to the `bank_account` array of the Orders API. Given below is the sample code when the `method` is `upi`.
````curl: Request theme={null}
curl -u : \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
"amount": 500,
"method": "upi",
"receipt": "BILL13375649",
"currency": "INR",
"bank_account": {
"account_number": "765432123456789",
"name": "Gaurav Kumar",
"ifsc": "HDFC0000053"
}
}'
```json: Response
{
"id": "order_GAWRjlWkVcRh0V",
"entity": "order",
"amount": 500,
"amount_paid": 0,
"amount_due": 500,
"currency": "INR",
"receipt": "BILL13375649",
"offer_id": null,
"status": "created",
"attempts": 0,
"notes": [],
"created_at": 1573044206
}
````
Request Parameters
`amount` *mandatory*
: `integer` The transaction amount expressed in paise (currency supported is INR). For example, for an actual amount of ₹1, the value of this field should be `100`.
`currency` *mandatory*
: `string` The currency in which the transaction should be made. You can create orders in **INR** only.
`receipt` *optional*
: `string` Receipt number that corresponds to this order, set for your internal reference. Maximum length is 40 characters.
`notes` *optional*
: `json object` Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `"note_key": "Beam me up Scotty”`.
`method` *mandatory*
: `string` The payment method used to make the payment. If this parameter is not passed, investors will be able to make payments using both netbanking and UPI payment methods. Possible values:
* `netbanking`: Investors can make payments only using netbanking.
* `card`: Investors can make payments using debit card.
* `upi`: Investors can make payments only using UPI.
`bank_account` *mandatory*
: `object` Details of the bank account that the investor has provided at the time of registration.
`account_number` *mandatory*
: `string` The bank account number from which the investor should make the payment. For example, `765432123456789` Payments will not be processed for an incorrect account number.
`name` *mandatory*
: `string` The name linked to the bank account. For example, `Gaurav Kumar`.
`ifsc` *mandatory*
: `string` The bank IFSC. For example, `HDFC0000053`.
### Response Parameters
`id`
: `string` Unique identifier of the order.
`entity`
: `string` Indicates the type of entity. Here, it is `order`.
`amount`
: `integer` The order amount represented in the smallest unit of the currency passed. For example, amount = 100 translates to 100 paise, that is ₹1 (default currency is INR).
`amount_paid`
: `integer` The amount that has been paid.
`amount_due`
: `integer` The amount that is yet to be paid.
`currency`
: `string` The 3-letter ISO currency code for the payment. Currently, we support INR only.
`receipt`
: `string` A unique identifier of the order entered by the user. For example, `BILL13375649`.
`status`
: `string` The status of the order.
`notes`
: `object` Key-value pair you can use to store additional information about the entity. Maximum of 15 key-value pairs, 256 characters each. For example, "note\_key": "Beam me up Scotty”.
`created_at`
: `integer` The Unix timestamp at which the order was created.
`offer_id`
: `string` Unique identifier of the offer.
`attempts`
: `integer` The number of payment attempts, successful and failed, that have been made against this order.
### Step 3: Turbo UPI SDK Action
You need to link the customer's UPI account with your app. Use the code samples given below to [fetch the UPI account](#32-link-new-upi-account).
3.1 Initialise the SDK
Use the code given below to initialise the SDK.
```java: Initialise theme={null}
RazorpayCheckout.initUpiTurbo("rzp_test_0wFRWIZnH65uny")
```
### 3.2 Link New UPI Account
Use the following code to link the newly created UPI account with your app. This function can be called from anywhere in the application, providing multiple entry points for customers to link their UPI account with your app.
```js: Link New UPI Account theme={null}
RazorpayCheckout.upiTurbo.linkNewUpiAccount("mobileNo", "color", function (upiAccounts) {
// handle data
}, function(error) {
// handle error
});
```
Request Parameters
`mobileNo` *mandatory*
: `string` Mobile number of the customer.
`color` *optional*
: `string` Colour in HEX format.
### Response Parameters
## Parameters | Description
## `function(upiAccounts)` | This function is triggered if the list is fetched successfully. The `upiAccounts` can be empty to indicate that no accounts have been linked yet.
`function(error)` | This function is triggered in case of an error, and the error object will be received.
* Handle payment failure responses, displaying important details such as error codes, error descriptions, and metadata. This function is responsible for handling and logging information in case of a payment error.
```js: Payment Failure Response Handling theme={null}
var cancelCallback = function(error) {
/**
* error contains two values:
* 1. Error Code
* 2. Error Description
**/
// handle failure
};
```
* Handle successful payment responses, displaying key information like order id, payment id, and signature. This code manages and logs details when a payment transaction is successful.
```js: Payment Success Response Handling theme={null}
var successCallback = function(response) {
/**
* response contains three values:
* 1. Order ID
* 2. Payment ID
* 3. Signature
**/
// handle success
};
```
### 3.3 Submit Method
To accept payments, call the `submit` method with the following payload:
```java: Submit Payment Details theme={null}
"key": "[YOUR_KEY_ID]",
"currency": "INR",
"amount": 100,
"contact": "9000090000",
"method": "upi",
"email": "gaurav.kumar@example.com",
"upi": {
"flow": "in_app"
}
```
Request Parameter
`payload` *mandatory*
: `Map` Payload for initiating the transaction.
### Response Parameters
## Parameter | Description
## `onSuccess` | This function is triggered if the list is fetched successfully. `accList` can be empty to indicate that no accounts have been linked yet.
`onFailure` | This function is triggered in case an error is thrown during the retrieval process, either by the Razorpay SDK or the Bank SDK.
### Step 4: Handle Payment Success and Failure
The way you handle payment success and failure scenarios depends on the Checkout sample code you opted for in the previous step. Know how to [handle payment success and failure](/payments/third-party-validation/standard-integration#step-14-handle-payment-success-and-failure).
### Steps 5: Store Fields in Your Server
A successful payment returns the following fields to the Checkout form.
* You need to store these fields in your server.
* You can confirm the authenticity of these details by verifying the signature in the next step.
```json: Success Callback theme={null}
{
"razorpay_payment_id": "pay_29QQoUBi66xm2f",
"razorpay_order_id": "order_GAWRjlWkVcRh0V",
"razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
}
```
Parameters
`razorpay_payment_id`
: `string` Unique identifier for the payment returned by the Checkout **only** for successful payments.
`razorpay_order_id`
: `string` Unique identifier for the order returned by the Checkout.
`razorpay_signature`
: `string` Signature returned by the Checkout. This is used to verify the payment.
### Step 6: Verify Signature
This is a mandatory step to confirm the authenticity of the details returned to the Checkout form for successful payments.
To verify the `razorpay_signature` returned to you by the Checkout form:
1. Create a signature in your server using the following attributes:
* `order_id`: Retrieve the `order_id` from your server. Do not use the `razorpay_order_id` returned by Checkout.
* `razorpay_payment_id`: Returned by Checkout.
* `key_secret`: Available in your server. The `key_secret` that was generated from the [Dashboard](/api/authentication#generate-api-keys).
2. Use the SHA256 algorithm, the `razorpay_payment_id` and the `order_id` to construct a HMAC HEX digest as shown below:
```html: HMAC HEX Digest theme={null}
generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);
if (generated_signature == razorpay_signature) {
payment is successful
}
```
3. If the signature you generate on your server matches the `razorpay_signature` returned to you by the Checkout form, the payment received is from an authentic source.
### Non-Transactional Flow
Razorpay provides a single exposed function that allows you to manage linked UPI accounts and access all non-transactional flows seamlessly.
### Manage UPI Accounts
The SDK manages the linked `UpiAccounts` on the application by triggering `manageUpiAccounts()`. The sequence of steps is as given below:
* **Fetch balance**: Check the customer's account balance.
* **Change UPI PIN**: Provide the customer the ability to change their UPI PIN.
* **Reset UPI PIN**: Let your customers reset the PIN for their account.
* **Delete the account from the application**: Let your customers delink, that is, remove a selected UPI account from your application.
```js: Java theme={null}
RazorpayCheckout.upiTurbo.manageUpiAccounts("mobileNo", "color", function(error) {
// handle error
});
```
Request Parameters
`mobileNo` *mandatory*
: `string` Mobile number of the customer.
`color` *optional*
: `string` Colour in HEX format.
### Response Parameter
## Parameters | Description
`function(error)` | This function is triggered in case of an error, and the error object will be received.
### Models Exposed from SDKs
Given below are the models:
### Error
## Error | Description
`errorCode` | Types of error codes - `BAD_REQUEST_ERROR`: Failure from the client's end (SDK).
* `GATEWAY_ERROR`: Failure either from the Secure Component or the Bank.
* `SERVER_ERROR`: Failure at PSP.
***
## `errorDescription` | Brief description of the error.
## `errorReason` | Specifies the specific reason for the error.
## `errorSource` | Indicates the origin of the error.
`errorStep` | Highlights the stage where the error occurred.
[Refer to the list of possible error reasons](/payments/payment-gateway/cordova-integration/payment-methods/turbo-upi/error-codes).
### UpiAccount
## Fields | Return Type | Description
## `accountNumber` | String | Masked account number.
## `ifsc` | String | IFSC of the bank.
## `bankLogoUrl` | String | Image URL of the bank logo.
## `bankName` | String | Name of the bank.
`bankPlaceholderUrl` | String | Image URL of the bank logo placeholder.
## 2. Test Integration
We recommend the following:
* Complete the integration on UAT before using the prod builds.
* Perform the UAT using the Razorpay-provided API keys.
## 3. Go-live Checklist
Complete these steps to take your integration live:
* You should get your app id whitelisted by Razorpay to test on prod.
**Handy Tips**
Contact our [integrations team](mailto:integrations@razorpay.com) to get your mobile number and app whitelisted.
* Import the prod library from the GitHub repository → `https://github.com/upi-turbo/android-turbo-sample-app/tree/prod/app/libs` prod branch.
* Add Proguard rules:
* `keepclassmembers,allowobfuscation class * {
@com.google.gson.annotations.SerializedName ;
}`
* `keepclassmembers enum * { *; }`
* `keepclassmembers class * {
@android.webkit.JavascriptInterface ;
}`
* `dontwarn com.razorpay.**`
* `keep class com.razorpay.** {*;}`
* `keep class com.olivelib.** {*;}`
* `keep class com.olive.** {*;}`
* `keep class org.apache.xml.security.** {*;}`
* `keep interface org.apache.xml.security.** {*;}`
* `keep class org.npci.** {*;}`
* `keep interface org.npci.** {*;}`
* `keep class retrofit2.** { *; }`
* `keep class okhttp3.** { *; }`
* Replace the UAT credential with the [Razorpay live keys](/api/authentication#live-mode-api-keys) for prod testing.