instamojo/instamojo-php

This is composer wrapper for instamojo-php

1.0 2020-09-08 10:18 UTC

Requires

• php: >=5.3.0

Requires (Dev)

• phpunit/phpunit: ^7.5

MIT

• Instamojo and contributors

• php
• api
• wrapper
• instamojo

README

Assists you to programmatically create, edit and delete Links on Instamojo in PHP.

Note: If you're using this wrapper with our sandbox environment https://test.instamojo.com/ then you should pass true as third argument to the Instamojo class while initializing it. client_id and client_secret token for the same can be obtained from https://test.instamojo.com/developers/ (Details: Test Or Sandbox Account).

$authType = "app/user" /**Depend on app or user based authentication**/

$api = Instamojo\Instamojo::init($authType,[
        "client_id" =>  'XXXXXQAZ',
        "client_secret" => 'XXXXQWE',
        "username" => 'FOO', /** In case of user based authentication**/
        "password" => 'XXXXXXXX' /** In case of user based authentication**/

    ],true); /** true for sandbox enviorment**/

Installing via Composer

php composer.phar require instamojo/instamojo-php

Note: If you're not using Composer then directly include the contents of src directory in your project.

Usage

$api = Instamojo\Instamojo::init($authType,[
        "client_id" =>  'XXXXXQAZ',
        "client_secret" => 'XXXXQWE',
        "username" => 'FOO', /** In case of user based authentication**/
        "password" => 'XXXXXXXX' /** In case of user based authentication**/

    ]);

Documentation

See the Documentation for datailed instructions

• v1.1 Documentation
• v2 Documentation

Table of Content

• Create a payment request
• Get status of Payment request
• Get list of all Payment requests
• Get list of all Payments
• Get Details of a payment
• Create Gateway order
• Create Gateway order for Payment request
• Get Gateway order details
• Get list of Gateway orders
• Create refund for payments
• Get details of a refund
• Get list of refunds
• Common FAQ's

Create a new Payment Request

try {
    $response = $api->createPaymentRequest(array(
        "purpose" => "FIFA 16",
        "amount" => "3499",
        "send_email" => true,
        "email" => "[e-mail]",
        "redirect_url" => "http://www.example.com/handle_redirect.php"
        ));
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you JSON object containing details of the Payment Request that was just created with longurl key provide you instamojo-payment-url.

Recommended seamless checkout Option

You can render your Instamojo checkout form and collect payments on your webpage with just the instamojo-payment-url obtained in createPaymentRequest() using JS based seamless checkout library. To know more how its work Click here.

Payment Request Creation Parameters

Required

• purpose: Purpose of the payment request.
• amount: The amount for the request. The minimum amount is 9. And the maximum is 200000.

Optional

• buyer_name: Name of the payer.
• email: Email of the payer.
• phone: Phone number of the payer.
• send_email: Set this to true if you want to send email to the payer if email is specified. If email is not specified then an error is raised. (default value: false)
• send_sms: Set this to true if you want to send SMS to the payer if phone is specified. If phone is not specified then an error is raised. (default value: false)
• redirect_url: set this to a thank-you page on your site. Buyers will be redirected here after successful payment.
• webhook: set this to a URL that can accept POST requests made by Instamojo server after successful payment.
• allow_repeated_payments: To disallow multiple successful payments on a Payment Request pass false for this field. If this is set to false then the link is not accessible publicly after first successful payment, though you can still access it using API(default value: true).
• partner_fee_type : Allows you to receive a cut from from payments you facilitate. For fixed fee set this to fixed, or for percentage fee set it to percent.
• partner_fee : This describes the fee that you would collect. It can be either a fixed amount, or a percentage of the original amount, depending on the value of partner_fee_type.
• mark_fulfilled : Flag to determine if you want to put the payment on hold until you explicitly fulfil it. If mark_fulfilled is True the payment will be paid out to the merchant. If mark_fulfilled is False, then the payment will be put on hold until you explicitly fulfil the payment. See Fulfil a Payment below on how to fulfil a payment.
• expires_at : Time after which the payment request will be expired in UTC timestamp. Max value is 600 seconds. Default is Null.

Get the status or details of a Payment Request

try {
    $response = $api->getPaymentRequestDetails(['PAYMENT REQUEST ID']);
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you JSON object containing details of the Payment Request and the payments related to it. Key for payments is 'payments'.

Here ['PAYMENT REQUEST ID'] is the value of 'id' key returned by the createPaymentRequest() query.

Get a list of all Payment Requests

try {
    $response = $api->getPaymentRequests();
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you an array containing Payment Requests created so far. Note that the payments related to individual Payment Request are not returned with this query.

getPaymentRequests() also accepts optional parameters for pagination.

getPaymentRequests($limit=null, $page=null)

For example:

$response = $api->getPaymentRequests(50, 1);

Get a list of all Payments

try {
    $response = $api->getPayments();
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you an array containing Payments details so far.

getPayments() also accepts optional parameters for pagination.

getPayments($limit=null, $page=null)

For example:

$response = $api->getPayments(50, 1);

Get the details of a Payment

try {
    $response = $api->getPaymentDetails(['PAYMENT ID']);
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you JSON object containing details of the Payment.

Here ['PAYMENT ID'] is the value of 'id' key returned by the getPayments() query.

Create a Gateway Order

try {
    $response = $api->createGatewayOrder(array(
      "name" => "XYZ",
      "email" => "[e-mail]",
      "phone" => "99XXXXXXXX",
      "amount" => "200",
      "transaction_id" => 'TXN_ID', /**transaction_id is unique Id**/
      "currency" => "INR"
    ));
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you JSON object containing details of the order in order key and payments options in payment_options key.

Create a Gateway Order For payment request

try {
    $response = $api->createGatewayOrderForPaymentRequest($payment_request_id, array(
      "name" => "XYZ",
      "email" => "[e-mail]",
      "phone" => "99XXXXXXXX",
    ));
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

$payment_request_id id the id key obtained in createPaymentRequest() method.

This will give you JSON object containing with created order_id key.

Get the details of a Gateway Order

try {
    $response = $api->getGatewayOrder(['ORDER ID']);
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you JSON object containing details of the Gateway Order.

Here ['ORDER ID'] is the value of 'id' key returned by the createGatewayOrder() query.

Get a list of all Gateway Order

try {
    $response = $api->getGatewayOrders();
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you an array containing Gateway Orders details so far.

getGatewayOrders() also accepts optional parameters for pagination.

getGatewayOrders($limit=null, $page=null)

For example:

$response = $api->getGatewayOrders(50, 1);

Create a Refund for a payment

try {
    $response = $api->createRefundForPayment($payment_id, array(
      "type" => "RFD",
      "body" => "XYZ reason of refund",
      "refund_amount" => "10",
      "transaction_id" => "TNX_XYZ"
    ));
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you JSON object containing refund details in refund key.

Required Parameters

• type: Three letter short-code identifying the reason for refund, string type.
• body: Additonal text explaining the refund, string type.
• refund_amount: This field can be used to specify the refund amount, string type.
• transaction_id: To Prevent duplicate case creations due to replay of APIs, string type.

Valid values for type parameter:

• RFD: Duplicate/delayed payment.
• TNR: Product/service no longer available.
• QFL: Customer not satisfied.
• QNR: Product lost/damaged.
• EWN: Digital download issue.
• TAN: Event was canceled/changed.
• PTH: Problem not described above.

Get the details of a Refund

try {
    $response = $api->getRefundDetails(['REFUND ID']);
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you JSON object containing details of the Refund.

Get a list of all Refunds

try {
    $response = $api->getRefunds();
    print_r($response);
}
catch (Exception $e) {
    print('Error: ' . $e->getMessage());
}

This will give you an array containing Refunds details so far.

getRefunds() also accepts optional parameters for pagination.

getRefunds($limit=null, $page=null)

For example:

$response = $api->getRefunds(50, 1);

Common FAQ's

• How to get your client Id and Client secret