You should choose one or the other, but not both.

If the customer has not linked any UPI account, u

You can filter UpiAccounts for bank accounts related to each orderID or Whitelisted accounts. You need to select which bank accounts the users can use for payments, and we will provide a list of linked bank accounts. When users first sign up, you should display them the approved bank accounts that they can use for transactions. Users need to choose one from the provided list.

DEVICE_BINDING_INCOMPLETE

Step 1: Collect Investor Bank Account DetailsCollect the bank account details provided by t

You can choose to maintain a whitelisted account per customer using S2S Customers API on your end.

If the user changes their mobile number during onboarding, you should store the updated number and pass it to the Turbo SDK.

r Turbo)

itelisted accounts will be sho

us

SecureComponen

The AARs on the main branch are for the UAT environment, the ones on the prod branch are for the production environment, and the mock branch is for the mock environment.

et your mobile number, app, and GitHu

No Dependency on UAT Environment:

1. Ar

UPI terminals

We have built Turbo UPI in a way that it can be deployed across any Razorpay checkout - Standard, Custom or S2S. The integration efforts on each of these will differ depending on whether or not you wish to control the user-experience journey. On our Standard Checkout offering, you can be up and running in 1-2 days.

Error Code Mapping

No, a business does not become a TPAP when integrating with the Turbo UPI solution. According to the (OC 154 Circular); the licensed party remains the bank's SDK, while Razorpay steps in to play the front-end role of a TPAP like GPay / PhonePe. For this reason, the business does not have to undergo any lengthy certification process with NPCI and experiences a faster go-to-market. For all other purposes, businesses become a UPI app (for P2M transactions only) without undergoing the red tape associated with becoming a TPAP.

outing rule to direct 100% of traffic towards Razorpay instead of other PGs. Only then will end-users be able to benefit from Turbo

2. What happens in case of pending transactions due to issues in the UPI ecosystem? Is the user returned to the original checkout with pending status or remains on the PIN screen to retry?

1. We already have payment success / fail screens at our end. Do we have the option to remove it from this flow to avoid duplicity?

The device binding process is a one-time effort. It must be repeated if the user uninstalls the app or clears their storage only.

Razorpay will trigger a webhook when the payment is successful or failed. Refer to the payment payloads.

6. What is the process for refunds on UPI transactions via Turbo UPI? Refunds on Turbo UPI will be processed in 3-4 business days, which is the normal TAT for refunds. The complete amount will be refunded to you.

Immediately after you set a new PIN or reset an old UPI PIN, the bank sets a cooling-off period on the user's bank account to ensure security. The actual duration of this period may vary from bank to bank.

e there any sp

Onboarding

w SMS permission so

An @axisbank VPA is created at the backend only if the user is not already an Axis VPA user.

If the user does not have an @axisbank UPI ID, we will create it during the one-time device binding process.

Turbo UPI logo i

These are the important files in the sample app repo: app/src/turboHeadless: sample app code for headless SDK app/libs: all libraries (bank, NPCI and Turbo) common f

Get your mobile number and app whitelisted

ill take T+4 days.

NPCI

NPCI

VPA

Get your

epo

In this repository, you will find the AAR files (libraries for Turbo) and the sample app source code to help you do the entire integration. The AARs on the main branch are for the UAT environment, and the ones on the prod branch are for the production environment. These are the important files in the sample app repo:

You can directly interact with the exposed methods of the Turbo framework to perform the non-transactional flow listed below.

Integration StepsThis feature will be available soon for Standard Int

UPI ac

UPI acco

Link a new UPI Account: Customers can link a new UPI account to the merchant app.

can be

g the new VPA.

This creates a new VPA and links it to your app.

Handy TipsIn case the customer has multiple SIMs in their device, they should choose the SIM linked to their bank account.

They select UPI as the payment method and are

ers

They are guided to select a bank account, create a VPA and link it with your app.

Watch Out!You can ignore the following steps if you already have an existing VPA with our Partner Bank. In this flow, the customer will not have an existing VPA set with the partner bank.

ample UI representation:

Given

The customer will receive a confirmation message once the transaction is successful.

and confirms the payment.

linked bank account

Transactional Flow is the process a user makes a payment for a product/service usin

Trubo

Turb

in the payment experience.

opportunities

Higher success

get mor

re

Achieve a faster time-to-market.

end-to-end control over transactions.

Single

prove UPI payment success rate with UPI Turbo compared to traditional Third Party UPI Apps.

2 simple steps.

iders like GPa

2. Onboarding Flow

Higher success rate.

r UPI Turbo usi

only supported payment provider for UPI

Custom

make

a faster time-to-market.

They can get all the information from your app.

thereby increasing the success rate.

PSP (Payment Service Providers

SDK

2-step

Returns a list of banks. This list is fetched from Razorpay backend.

Bank SDK (depending on the bank that you want to use)

NPCI Commons Library

break; case SELECT_SIM:

Let your customers delink their VPAs.

Name of account holder.

Bank of bank account.

Returns masked bank account number.

IM slot number.

Mobile number stored in SIM card.

Expiry yea

Package-Private--VPA

AllBanks

ext Function

and has created a new one

result

result

result

set the VPA PIN

ng the prod

xisting VPA with Partner Bank

The customer needs to give permission to complete SMS verification to validate the phone number with the bank.

your customers need to complete device binding and link their VPA to your app.

iagram:

VPA PIN

low 2: Customer does not have an existing VPA with Partner Bank

Dialog

After the customer has completed the onboarding, the transaction flow for subsequent payments is simplified to a 2-step process.

Given below is the flow diagram:

They need to complete SMS verifi

In this flow, as the customer does not have an existing VPA and no PIN set up. They are guided to select a bank account, create a VPA, set up a PIN and link it with your app.

product/service

In this flow, as the customer does not have an existing VPA. They are guided to select a bank account, create a VPA and link it with your app.

They need to complete SMS

Given below is the flow diagram:

Flow 1: Customer has an existing VPA Flow 2: Customer does not have an existing VPA but has set UPI PIN Flow 3: Customer neither has a VPA nor a UPI PIN

There are two flows for the customer: Onboarding and Transaction.

Reduce payment failures: A smoother payment process for end-users, means less failures.

Reduce timeouts and improve visibility on UPI: With customers never leaving your app, reduce timeout issues significantly, and get more visibility on payment failures.

Get end-to-end control over transactions and a faster time-to-market.

Minimal room for payment failure.

Simplified payment process with just 2 steps.

Given below is a sample UI representation:

During payments, customers can select the linked UPI and get redirected to the preferred UPI app to complete the payment.

Customers can link their preferred VPA with your app.

Your customers no longer need to remember UPI IDs (VPA).

Turbo-in-app SDK Integration

reference_id mandatory string The internal reference ID.This value can be maximum of 20 characters. For example, 123123.

BbHKlnuyZkf0x

.

Request Parameters🔗 addresses The address of the stakeholder. residential The residential address information. street optional string The street in the address. city optional string The name of the city in your address. state optional string The name of the state in your address. postal_code optional string The postal code. country optional string The name of the country. kyc Your KYC information.

string The name of the stakeholder. addresses The address of the stakeholder. residential The residential address information. street optional string The street in the address. city optional string The name of the city in your address. state optional string The name of the state in your address. postal_code optional string The postal code. country optional string The name of the country. kyc Your KYC information.

contact_name":"Gaurav Kumar", "contact_info":{ "chargeback":{ "email":null, "phone":null, "policy_url":null }, "refund":{ "email":null, "phone":null, "policy_url":null }, "support":{ "email":null, "phone":null, "policy_url":null } } }

email mandatory string The account holder's email id.

Linked Account Ent

90ced751-6575-4708-a070-0bdf7a94b0e5

Request Parameters

UUI4

UUI4

Linked Account Activation State

"account_permissions":{ "dashboard":true, "refunds":false

"field_reference":"settlements.beneficiary_name", "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e", "reason_code":"field_missing", "status":"required"

"account_permissions":{ "dashboard":true, "refunds":false }, "notifications":{ "whatsapp":false, "sms":false, "email":[ "gaurav.kumar@example.com", "acd@example.com"

DEMO

account_code

linked_account

profile

standard

linked_account

KYC Requirements

Onboard Linked Accounts

a Apis

linked_account

How does it help me?🔗

5. What happens if I send a duplicate transfer request with the Idempotency Key?🔗 You will receive the same response as the first transfer that was processed. In case a different request is sent with the same idempotency key, it will fail with a Bad Request Error.

t with the Idempotency Key?🔗

4. Is it mandatory to send the idempotency key in all Direct Transfer requests?🔗

idempotency is supported only for Direct Transfers.

created as part of the first transaction.

ayout entity

double-payout

For example, if a transfer is created with on_hold_until timestamp defined as 1583991784, the settlement will be held off until the specified time period. The amount will be settled to the linked account only on the next day.

For example, if the settlement schedule is T+10 days, a transfer made with on_hold set to 1 will not be settled even after 10 days, as it is on hold. If the hold is disabled on T+15 day, the amount will be settled to the linked account by the next working day.

setting

A nique i

A new reversal entity is created internally and linked for every reversal defined by the transfer_id. The following endpoint creates refunds on a particular payment_id.

ayment before processing

omers and reverse transfers made to linked acco

uring payment. For

curl -X GET https://api.razorpay.com/v1/payments \ -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \ -H 'X-Razorpay-Account: acc_IRQWUleX4BqvYn' \

The following endpoint fetches details of settlements made to linked accounts. /transfers?expand[]=recipient_settlementYou should append ?expand[]=recipient_settlement as the query parameter to the fetch transfer request. This would return a settlement entity and the transfer entity.

settlement obtained from the settlement.processed webhook event.

The following endpoint retrieves the collection of all transfers made for a particular recipient_settlement_id. /transfers?recipient_settlement_id Curl Java PHP Node.JS Python Ruby Go ResponseCopycurl -X GET https://api.razorpay.com/v1/transfers?recipient_settlement_id=setl_HYIIk3H0J4PYdX \ -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \ CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); JSONObject params = new JSONObject(); params.put("recipient_settlement_id","setl_HYIIk3H0J4PYdX"); List<Transfer> transfers = razorpay.transfers.fetchAll(params); Copy$api = new Api($key_id, $secret); $api->transfer->all(array('recipient_settlement_id'=> $recipientSettlementId)); Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' }) instance.transfers.all({ recipient_settlement_id : recipientSettlementId }) Copyclient = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET")) client.transfer.all({ "recipient_settlement_id":"recipientSettlementId" }) Copyrequire "razorpay" Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET') recipientSettlementId = "setl_HYIIk3H0J4PYdX" Razorpay::Transfer.all({ "recipient_settlement_id": recipientSettlementId }) Copyimport ( razorpay "github.com/razorpay/razorpay-go" ) client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET") data:= map[string]interface{}{ "recipient_settlement_id": "<recipientSettlementId>", } body, err := client.Transfer.All(data, nil) Copy

Response Parameters🔗

string Indicates the status of the transfer.

should be retrieved.

Check the response parameters descriptions in the Transfer entity parameters table.

string The currency used in the transaction. We support only INR for Route transactions. notes optional json object Set of key-value pairs that can be associated with an entity. These pairs can be useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported.

curl -X POST https://api.razorpay.com/v1/transfers \ -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \ -H 'content-type: application/json' \ -d '{ "account": "acc_CPRsN1LkFccllA", "amount": 100, "currency": "INR" }' CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]"); JSONObject transferRequest = new JSONObject(); transferRequest.put("amount",50000); transferRequest.put("currency","INR"); transferRequest.put("account","acc_CPRsN1LkFccllA"); Transfer transfer = razorpay.transfers.create(transferRequest); Copy$api = new Api($key_id, $secret); $api->transfer->create(array('account' => $accountId, 'amount' => 500, 'currency' => 'INR')); Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' }) instance.transfers.create({ "amount": 500, "currency": "INR" }) Copyclient = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET")) client.transfer.create({ "amount":500, "currency":"INR" }) Copyrequire "razorpay" Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET') para_attr = { "account": accountId, "amount": 500, "currency": "INR" } Razorpay::Transfer.create(para_attr) Copyimport ( razorpay "github.com/razorpay/razorpay-go" ) client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET") data:= map[string]interface{}{ "account": "<accountId>", "amount": 100, "currency": "INR", } body, err := client.Transfer.Create(data, nil) Copy{ "id":"trf_E9utgtfGTcpcmm", "entity":"transfer", "transfer_status":"pending", "settlement_status":null, "source":"acc_CJoeHMNpi0nC7k", "recipient":"acc_CPRsN1LkFccllA", "amount":100, "currency":"INR", "amount_reversed":0, "notes":[ ], "fees":1, "tax":0, "on_hold":false, "on_hold_until":null, "recipient_settlement_id":null, "created_at":1580219046, "linked_account_notes":[ ], "processed_at":null, "error":{ "code":null, "description":null, "field":null, "source":null, "step":null, "reason":null } }

This API creates a direct transfer of funds from your account to a linked account and responds with the created transfer entity on successful creation. Watch Out! Direct Transfers is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account. Apart from transferring payments received from customers, you can also transfer funds to your linked accounts directly from your account balance using the Direct Transfers API. You can transfer funds directly from your account using the following endpoint.

direct transf

r should be created.

The payments transferred to the linked accounts are settled in their respective bank accounts per the pre-defined

The following endpoint transfers a captured payment to one or more linked accounts using account_id. A response is generated on a successful transfer with a collection of transfer entities created for the payment.

ot happen

e provided AP

You have to pass the details such as account_id and amount.

transfer API call.

error Provides error details that may occur during transfers. code string Type of the error.

Only the keys will be shown, not values.

settled

Status

parameters

When the transfer is settled to the Linked Account.

You can create the reversal if required.