README.md

Razorpay Java SDK

Official java bindings for the Razorpay API.

Documentation

Documentation of Razorpay's API and their usage is available at https://docs.razorpay.com

Requirements

Java 1.8 or later

Mock Tests Support till Java 1.8

Installation

Maven users

Add this dependency to your project's POM:

<dependency>
 <groupId>com.razorpay</groupId>
 <artifactId>razorpay-java</artifactId>
 <version>1.4.6</version>
</dependency>

Gradle users

Add this dependency to your project's build file:

implementation "com.razorpay:razorpay-java:1.4.6"

Usage

RazorpayClient can be instantiated via two ways:

Using Private Auth

Instantiate RazorpayClient with key_id & key_secret. You can obtain the keys from the dashboard app https://dashboard.razorpay.com/#/app/keys

// Initialize client
RazorpayClient instance = new RazorpayClient("key_id", "key_secret");

• Add custom headers to request (optional)

Map<String, String> headers = new HashMap<String, String>();
razorpayClient.addHeaders(headers);

Using Access Token

Instantiate RazorpayClient with access_token. The access_token can be obtained only in case if you are a platform partner. For more information, refer page - https://razorpay.com/docs/partners/platform/.

// Initialize client
RazorpayClient instance = new RazorpayClient("access_token");

• Add custom headers to request (optional)

Map<String, String> headers = new HashMap<String, String>();
razorpayClient.addHeaders(headers);

Supported Resources

• Addon

• Account

• Item

• Customer

• Token

• Order

• Payments

• Product Configuration

• Settlements

• Stakeholder

• Fund

• Refunds

• Invoice

• Subscriptions

• Payment Links

• Smart Collect

• Route

• QR Code

• Emandate

• Cards

• Paper NACH

• UPI

• Register Emandate and Charge First Payment Together

• Register NACH and Charge First Payment Together

• Payment Verification

• Webhook

• OAuth Token Client

• Dispute

• Document

---

• Make custom requests

You can make custom API requests using clients. For example, here is how to make custom request to /payments/path endpoint.

Entity response = razorpayClient.Payments.post("path", JSONObject requestBody);