PayPal - Razorpay

You can accept payments based on the transaction limit of your PayPal account. Know more about the other payment methods and the transaction limits.

Advantages

Integrating PayPal as a payment method offers you the following advantages:

Better Success Rates: Enjoy up to 20% higher success rates.
Faster Settlement time: Get paid on a T+1 settlement schedule.
Wide user base: Reach Over 30 million PayPal users around the world.
No additional charges: PayPal defines the rates for transactions.

Watch Out!You can accept payments from the provided list of supported currencies.

Onboarding Process to Enable PayPal

Watch this video to see the onboarding process to enable PayPal on your checkout form.

Handy TipsThe PayPal section is visible only in the Live mode on the Dashboard.

To enable PayPal:

Log in to the Dashboard.
Navigate to Account & Settings → International payments (under Payment methods). Scroll to the PayPal section and click Link Account.
Upon redirection to PayPal:
- If you do not have a PayPal account, you need to complete the verification process and KYC. This will include confirming your email address by clicking on the link sent to you by PayPal.
- If you already have a PayPal account, you need to authorise Razorpay to accept payments.
You should now be able to see your PayPal enablement status set to Pending on your Razorpay Dashboard. PayPal will activate your account within 48 hours if all of the previous steps are successfully completed. You can now proceed with the integration. This depends on how you have integrated Razorpay on your website or application. By default, your PayPal account is configured to receive USD payments. You can enable more currencies on your account from your PayPal Dashboard.

Watch Out!

You should not use the same email ID for multiple MIDs.
Each merchant should set up a separate PayPal account for each MID.

Integration Steps

If you are using Razorpay Server-to-Server integration, first you need to raise a request with our Support team to enable PayPal and complete the onboarding procedure. Follow the steps given below to integrate S2S JSON API and accept payments using PayPal. 1.1 Create an Order 1.2 Create a Payment 1.3 Handle Payment Success and Error Events 1.4 Verify Payment Signature 1.5 Integrate Payments Rainy Day Kit 1.6 Verify Payment Status

1.1 Create an Order

To process a payment, create a Razorpay Order to correspond with the order in your system. Send the order request parameters to the following endpoint: Order is an important step in the payment process.

An order should be created for every payment.
You can create an order using the Orders API. It is a server-side API call. Know how to authenticate Orders API.
The order_id received in the response should be passed to the checkout. This ties the order with the payment and secures the request from being tampered.

You can create an order:

Using the sample code on the Razorpay Postman Public Workspace.
By manually integrating the API sample codes on your server.

Razorpay Postman Public Workspace

You can use the Postman workspace below to create an order:

Handy TipsUnder the Authorization section in Postman, select Basic Auth and add the Key Id and secret as the Username and Password, respectively.You can create an order manually by integrating the API sample codes on your server.

API Sample Code

Use this endpoint to create an order using the Orders API. /orders

Curl

curl -X POST https://api.razorpay.com/v1/orders 
-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
  "amount": 50000,
  "currency": "INR",
  "receipt": "qwsaq1",
  "partial_payment": true,
  "first_payment_min_amount": 230,
  "notes": {
    "key1": "value3",
    "key2": "value2"
  }
}'
```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject orderRequest = new JSONObject();
orderRequest.put("amount",50000);
orderRequest.put("currency","INR");
orderRequest.put("receipt", "receipt#1");
JSONObject notes = new JSONObject();
notes.put("notes_key_1","Tea, Earl Grey, Hot");
notes.put("notes_key_1","Tea, Earl Grey, Hot");
orderRequest.put("notes",notes);

Order order = instance.orders.create(orderRequest);
```Python: Python
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.order.create({
  "amount": 50000,
  "currency": "INR",
  "receipt": "receipt#1",
  "partial_payment": false,
  "notes": {
    "key1": "value3",
    "key2": "value2"
  }
})
```php: PHP
$api = new Api($key_id, $secret);

$api->order->create(array('receipt' => '123', 'amount' => 50000, 'currency' => 'INR', 'notes'=> array('key1'=> 'value3','key2'=> 'value2')));
```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary orderRequest = new Dictionary();
orderRequest.Add("amount", 50000);
orderRequest.Add("currency", "INR");
orderRequest.Add("receipt", "receipt#1");
Dictionary notes = new Dictionary();
notes.Add("notes_key_1", "Tea, Earl Grey, Hot");
notes.Add("notes_key_2", "Tea, Earl Grey, Hot");
orderRequest.Add("notes", notes);

Order order = client.Order.Create(orderRequest);
```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "amount": 50000,
  "currency": "INR",
  "receipt": "receipt#1",
  "notes": {
    "key1": "value3",
    "key2": "value2"
  }
}

Razorpay::Order.create(para_attr)
```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.orders.create({
  "amount": 50000,
  "currency": "INR",
  "receipt": "receipt#1",
  "partial_payment": false,
  "notes": {
    "key1": "value3",
    "key2": "value2"
  }
})
```go: Go
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data := map[string]interface{}{
  "amount": 50000,
  "currency": "INR",
  "receipt": "some_receipt_id",
  "partial_payment": false,
  "notes": map[string]interface{}{
      "key1": "value1",
      "key2": "value2",
    },
}
body, err := client.Order.Create(data, nil)

Success Response

{
  "id": "order_IluGWxBm9U8zJ8",
  "entity": "order",
  "amount": 50000,
  "amount_paid": 0,
  "amount_due": 50000,
  "currency": "INR",
  "receipt": "rcptid_11",
  "offer_id": null,
  "status": "created",
  "attempts": 0,
  "notes": [],
  "created_at": 1642662092
}
```json: Failure Response
{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "Order amount less than minimum amount allowed",
    "source": "business",
    "step": "payment_initiation",
    "reason": "input_validation_failed",
    "metadata": {},
    "field": "amount"
  }
}

Request Parameters

amount mandatory : integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of 299.35, the value of this field should be 29935. currency mandatory : string The currency in which the transaction should be made. Refer to the list of supported currencies. Length must be of 3 characters. receipt optional : string Your receipt id for this order should be passed here. 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”. partial_payment optional : boolean Indicates whether the customer can make a partial payment. Possible values:

true: The customer can make partial payments.
false (default): The customer cannot make partial payments.

first_payment_min_amount optional : integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of 7000 is to be received from the customer in two installments of #1 - 5000, #2 - 2000, then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

Response Parameters

Descriptions for the response parameters are present in the Orders Entity parameters table.

Error Response Parameters

The error response parameters are available in the API Reference Guide.

1.2 Create a Payment

Once an order is created, your next step is to create a payment. The following API will create a payment with wallet as the payment method: /payments/create/json

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payments/create/json \
-H "Content-Type: application/json" \
 -d '{
  "amount": "50000",
  "currency": "INR",
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "order_id": "order_EAkbvXiCJlwhHR",
  "ip": "198.29.65.27",
  "method": "wallet",
  "wallet": "paypal"
  }'

```php: PHP
$api = new Api($key_id, $secret);

$api->payment->createPaymentJson(array('amount' => 50000,'currency' => 'INR','email' => 'gaurav.kumar@example.com','contact' => '+919876543210','order_id' => 'order_I6LVPRQ6upW3uh','ip' => '198.29.65.27','method' => 'wallet','wallet' => 'paypal'));

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.createPaymentJson({
  amount: 50000,
  currency: "INR",
  order_id: "order_EAkbvXiCJlwhHR",
  ip: "198.29.65.27",
  email: "gaurav.kumar@example.com",
  contact: "+919876543210",
  method: "wallet",
  wallet: "paypal"
})

```python: Python
import razorpay

client = razorpay.Client(auth=("key", "secret"))

resp = client.payment.createPaymentJson({
  "amount": 50000,
  "currency": "INR",
  "order_id": "order_ItZMEZjpBD6dhT",
  "ip": "198.29.65.27",
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "method": "wallet",
  "wallet": "paypal"
})

```go: Go
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

para_attr := map[string]interface{}{
  "amount": 50000,
  "currency": "INR",
  "order_id": "order_EAkbvXiCJlwhHR",
  "ip": "198.29.65.27",
  "email": "gaurav.kumar@example.com",
  "contact": "+919876543210",
  "method": "wallet",
  "card": "paypal"
}
body, err := client.Payment.CreatePaymentJson(para_attr, nil)

print(resp)

```json: Response
{
    "razorpay_payment_id": "pay_JbQPrlRl1CnSKc",
    "next": [
        {
            "action": "redirect",
            "url": "https://api.razorpay.com/v1/payments/JbQPrlRl1CnSKc/authenticate"
        }
    ]
}

Request Parameters

amount mandatory : integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of 299.35, the value of this field should be 29935. currency mandatory : string The currency in which the transaction should be made. Refer to the list of supported currencies. Length must be of 3 characters. order_id mandatory : string Unique identifier of the Order. Know more about Orders API. ip mandatory : string Customer’s IP address. email mandatory : string Email address of the customer. Maximum length supported is 40 characters. contact mandatory : string Phone number of the customer. Maximum length supported is 15 characters, inclusive of country code. method mandatory : string Name of the payment method. Possible value is wallet wallet : string Wallet code for the wallet used for the payment. Required if the method is wallet. Possible value is paypal.

Response Parameters

razorpay_payment_id : string Unique identifier of the payment. Present for all responses. next : array A list of action objects available to you to continue the payment process. Present when the payment requires further processing. action : string An indication of the next step available to you to continue the payment process. Possible values:

redirect : Use this URL to redirect customer to submit the OTP on the bank page.

url : string URL to be used for the action indicated.

1.3 Handle Payment Success and Error Events

Once the payment is completed by the customer, a POST request is made to the callback_url provided in the payment request. The data contained in this request will depend on whether the payment was a success or a failure.

Success Callback

If the payment made by the customer is successful, the following fields are sent:

razorpay_payment_id
razorpay_order_id
razorpay_signature

Callback Example

{
  "razorpay_payment_id": "pay_29QQoUBi66xm2f",
  "razorpay_order_id": "order_9A33XWu170gUtm",
  "razorpay_signature": "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
}

Failure Callback

If the payment has failed, the callback will contain details of the error. Refer to Errors for details.

1.4 Verify Payment Signature

Signature verification is a mandatory step to ensure that Razorpay sends the callback. The razorpay_signature contained in the callback can be regenerated by your system and verified as follows. Create a string to be hashed using the razorpay_payment_id contained in the callback and the Order ID generated in the first step, separated by a |. Hash this string using SHA256 and your API Secret.

generated_signature = hmac_sha256(order_id + "|" + razorpay_payment_id, secret);

if (generated_signature == razorpay_signature) {
    payment is successful
}

Generate Signature on your Server

Java

/**
* This class defines common routines for generating
* authentication signatures for Razorpay Webhook requests.
*/
public class Signature
{
    private static final String HMAC_SHA256_ALGORITHM = "HmacSHA256";
    /**
    * Computes RFC 2104-compliant HMAC signature.
    * * @param data
    * The data to be signed.
    * @param key
    * The signing key.
    * @return
    * The Base64-encoded RFC 2104-compliant HMAC signature.
    * @throws
    * java.security.SignatureException when signature generation fails
    */
    public static String calculateRFC2104HMAC(String data, String secret)
    throws java.security.SignatureException
    {
        String result;
        try {

            // get an hmac_sha256 key from the raw secret bytes
            SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(), HMAC_SHA256_ALGORITHM);

            // get an hmac_sha256 Mac instance and initialize with the signing key
            Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM);
            mac.init(signingKey);

            // compute the hmac on input data bytes
            byte[] rawHmac = mac.doFinal(data.getBytes());

            // base64-encode the hmac
            result = DatatypeConverter.printHexBinary(rawHmac).toLowerCase();

        } catch (Exception e) {
            throw new SignatureException("Failed to generate HMAC : " + e.getMessage());
        }
        return result;
    }
}

```php: PHP
use Razorpay\Api\Api;
$api = new Api($key_id, $key_secret);
$attributes  = array('razorpay_signature'  => '23233',  'razorpay_payment_id'  => '332' ,  'razorpay_order_id' => '12122');
$order  = $api->utility->verifyPaymentSignature($attributes)

```ruby: Ruby
require 'razorpay'
Razorpay.setup('key_id', 'key_secret')
payment_response = {
  'razorpay_order_id': '12122',
  'razorpay_payment_id': '332',
  'razorpay_signature': '23233'
}

Razorpay::Utility.verify_payment_signature(payment_response)

```python: Python
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.utility.verify_payment_signature({
   'razorpay_order_id': razorpay_order_id,
   'razorpay_payment_id': razorpay_payment_id,
   'razorpay_signature': razorpay_signature
   })

```c: .NET
 Dictionary attributes = new Dictionary();

            attributes.Add("razorpay_payment_id", paymentId);
            attributes.Add("razorpay_order_id", Request.Form["razorpay_order_id"]);
            attributes.Add("razorpay_signature", Request.Form["razorpay_signature"]);

            Utils.verifyPaymentSignature(attributes);
```nodejs: Node.js
var { validatePaymentVerification } = require('./dist/utils/razorpay-utils');

validatePaymentVerification({"order_id": razorpayOrderId, "payment_id": razorpayPaymentId }, signature, secret);
```Go: Go
import (
	"crypto/hmac"
	"crypto/sha256"
	"crypto/subtle"
	"encoding/hex"
	"fmt"
)

func main()  {
	signature := "477d1cdb3f8122a7b0963704b9bcbf294f65a03841a5f1d7a4f3ed8cd1810f9b"
	secret := "qp3zKxwLZxbMORJgEVWi3Gou"
	data := "order_J2AeF1ZpvfqRGH|pay_J2AfAxNHgqqBiI"
	//fmt.Printf("Secret: %s Data: %s\n", secret, data)
	
	// Create a new HMAC by defining the hash type and the key (as byte array)
	h := hmac.New(sha256.New, []byte(secret))
	
	// Write Data to it
	_, err := h.Write([]byte(data))
	
	if err != nil {
		panic(err)
	}
	
	// Get result and encode as hexadecimal string
	sha := hex.EncodeToString(h.Sum(nil))
	
	fmt.Printf("Result: %s\n", sha)
	
	if subtle.ConstantTimeCompare([]byte(sha), []byte(signature)) == 1 {
		fmt.Println("Works")
	}
}

1.5 Integrate Payments Rainy Day Kit

Use Payments Rainy Day kit to overcome payments exceptions such as:

1.6 Verify Payment Status

Handy TipsOn the Razorpay Dashboard, ensure that the payment status is captured. Refer to the payment capture settings page to know how to capture payments automatically.

You can track the payment status in three ways:

To verify the payment status from the Razorpay Dashboard:

Log in to the Razorpay Dashboard and navigate to Transactions → Payments.
Check if a Payment Id has been generated and note the status. In case of a successful payment, the status is marked as Captured.

You can use Razorpay webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook’s configured URL. Know how to set up webhooks.

Example

If you have subscribed to the order.paid webhook event, you will receive a notification every time a customer pays you for an order. Poll Payment APIs to check the payment status.

Next Steps

Step 2: Test Integration

Settlements

You receive the payments made using PayPal directly to your PayPal wallet. PayPal makes the settlements in INR.

Refunds

Refunds - PayPal Balance RequiredEnsure you have sufficient balance in your PayPal account before you initiate a refund.

Refunds can be initiated by you either from the Dashboard or by using the Refunds API.
The refund amount is deducted from your PayPal account and credited to your customer’s PayPal account.

​Advantages

​Onboarding Process to Enable PayPal

​To enable PayPal:

​Integration Steps

​1.1 Create an Order

​Razorpay Postman Public Workspace

​API Sample Code

​Request Parameters

​Response Parameters

​Error Response Parameters

​1.2 Create a Payment

​Request Parameters

​Response Parameters

​1.3 Handle Payment Success and Error Events

​Success Callback

​Failure Callback

​1.4 Verify Payment Signature

​Generate Signature on your Server

​1.5 Integrate Payments Rainy Day Kit

​1.6 Verify Payment Status

​You can track the payment status in three ways:

​Example

​Next Steps

​Settlements

​Refunds

Advantages

Onboarding Process to Enable PayPal

To enable PayPal:

Integration Steps

1.1 Create an Order

Razorpay Postman Public Workspace

API Sample Code

Request Parameters

Response Parameters

Error Response Parameters

1.2 Create a Payment

Request Parameters

Response Parameters

1.3 Handle Payment Success and Error Events

Success Callback

Failure Callback

1.4 Verify Payment Signature

Generate Signature on your Server

1.5 Integrate Payments Rainy Day Kit

1.6 Verify Payment Status

You can track the payment status in three ways:

Example

Next Steps

Settlements

Refunds