Razorpay PHP SDK

Once the Api instance is created, you can access various Razorpay resources (such as payment, order, customer, etc.) using a property-based access pattern. Method calls follow the pattern $api->resource->function().

For example, to fetch a specific payment by its ID, use $api->payment->fetch($paymentId).

// Example: Fetching a payment
$api->payment->fetch($paymentId);

The Razorpay PHP library follows these core implementation patterns:

• Namespacing: All classes are namespaced under Razorpay\Api.
• Error Handling: The API throws exceptions instead of returning error objects/arrays.
• Argument Passing: Options are passed as associative arrays rather than multiple individual arguments whenever possible.
• Data Format: All requests and responses are communicated over JSON.

Advanced configurations can be passed via the options parameter during creation:

• Transfers: Distribute payments to multiple linked accounts using options => array('order' => array('transfers' => [...])).
• Offers: Associate an offer ID with the link using options => array('order' => array('offers' => array('offer_id'))).
• Reminders: Control whether reminders are sent using the reminder_enable boolean parameter.

// Example: Creating a link with transfers
$api->paymentLink->create(array(
    'amount'=>20000,
    'currency'=>'INR',
    'options'=>array(
        'order'=>array(
            'transfers'=>array(
                array('account'=>'acc_CPRsN1LkFccllA', 'amount'=>500, 'currency'=>'INR'),
                array('account'=>'acc_CNo3jSI8OkFJJJ', 'amount'=>500, 'currency'=>'INR')
            )
        )
    )
));

If you use Composer to manage PHP dependencies, you can add Requests to your project using the command line or by adding it to your composer.json file.

composer require rmccue/requests

Or in your composer.json:

{
    "require": {
        "rmccue/requests": "^2.0"
    }
}

If you are using a PSR-4 compliant class loader (like Symfony Class Loader), you can register the Requests namespace manually.

$loader = new Psr4ClassLoader();
$loader->addPrefix('WpOrg\\Requests\\', 'path/to/vendor/Requests/src');
$loader->register();

You can install the source code directly from GitHub or by downloading a tarball/zipball. If installing from source, you must include the autoloader and register it to use the library.

# From GitHub
$ git clone git://github.com/WordPress/Requests.git

# From Tarball
$ curl -L https://github.com/WordPress/Requests/tarball/stable | tar xzv
# Or via wget
$ wget https://github.com/WordPress/Requests/tarball/stable -O - | tar xzv

// Include the autoloader
require_once '/path/to/Requests/src/Autoload.php';

// Register the autoloader
WpOrg\Requests\Autoload::register();

You can interact with existing registration links (invoices) to notify customers or cancel the link.

Send/Resend Notifications Use invoice->fetch($invoiceId)->notifyBy($medium) to resend a notification.

• medium: Either sms or email.

Cancel a Registration Link Use invoice->fetch($invoiceId)->cancel() to invalidate a registration link.

Response for Cancellation: A JSON object containing the invoice details with status set to cancelled.

// Send notification
$api->invoice->fetch($invoiceId)->notifyBy('sms');

// Cancel link
$api->invoice->fetch($invoiceId)->cancel();

To use the library, you must instantiate the Razorpay\Api\Api class. You can authenticate using either your API credentials (Key ID and Key Secret) or an Access Token if you are a platform partner.

Using API Keys

Obtain your key_id and key_secret from the Razorpay Dashboard.

Using an Access Token

If you are a platform partner, you can instantiate the client using only an access_token.

use Razorpay\Api\Api;

// Option 1: Using API Keys
$api = new Api($api_key, $api_secret);

// Option 2: Using Access Token (Platform Partners only)
$api = new Api(null, null, "<ACCESS_TOKEN>");

You can install the library using Composer or by manual download.

Using Composer

Run the following command in your terminal:

Manual Installation

1. Download the latest razorpay-php.zip from the GitHub releases section.
2. Include Razorpay.php in your application to use the API.

composer require razorpay/razorpay:2.*

The Razorpay\Api\Invoice class is used to manage both the Invoices system and the Payment Links system.

Important Note: While the class is shared, some methods are specific to the Invoices system. Attempting to call Invoice-specific methods against a Payment Link entity will result in a Bad request error from the API.

Requests provides a simple API for sending HEAD, GET, POST, PUT, DELETE, and PATCH requests. It abstracts away the complexities of cURL or fsockopen. You can pass headers and options (like authentication) as arrays.

$headers = array('Accept' => 'application/json');
$options = array('auth' => array('user', 'pass'));
$request = WpOrg\Requests\Requests::get('https://api.github.com/gists', $headers, $options);

var_dump($request->status_code);
// int(200)

var_dump($request->headers['content-type']);
// string(31) "application/json; charset=utf-8"

var_dump($request->body);
// string(26891) "[...]"