payment link end point #233

neera11 · 2021-07-15T10:05:36Z

No description provided.

isaumya · 2021-07-16T07:11:18Z

Hey @neera11,
so if I am using this Razorpay PHP client to greater standard Payment Links, so, do I have to change the structure of the data that is passed? For example, current as per the readme example, it is stayed that I have to call the client the following way to create a payment link:

$link  = $api->invoice->create(
	arary(
		'type' => 'link', 
		'amount' => 500, 
		'description' => 'For XYZ purpose', 
		'customer' => array(
			'email' => 'test@test.test'
		)
	)
);

So, do I have to make any changes to this structure if I am only generating standard payment links?

neera11 · 2021-07-16T08:08:53Z

Hi @isaumya
No need to pass type in Payment link call
with invoice we were passing type as "link"

For payment link data will be

$orderData = json_encode(
[
'amount' => 98765,
'description' => 'For XYZ purpose',
'customer' => array('email' => 'test@test.test')
]);

$link = $api->payment_link->create($orderData, 'application/json' );

isaumya · 2021-07-16T08:51:20Z

Hi @neera11,
Thanks for your reply. So, no we need to pass application/json as a second parameter to the create() function? As this was not there before.

I will highly recommend you to update the readme.md file with example of the new way of calling the API.

So, just to be clear, currently, I am doing the following for generating payment link:

// Include the composer autoload file
require_once( __DIR__ . '/../vendor/autoload.php' );

// Use Razorpay API
use Razorpay\Api\Api;

/**
 * Function to generate Razorpay Payment Link
 * @var $payment_dtls Array
 * @return $link Object
 */
function generate_payment_link( $payment_dtls ) {
  // Initiate New API
  $api = new Api( 'rzp_live_123456', 'abc123' );

  // Create Payment Link
  $link = $api->invoice->create(
    [
      'type'            =>  'link',
      'amount'          =>  ( $payment_dtls['amount'] * 100 ),
      'currency'        =>  $payment_dtls['currency'],
      'customer_id'     =>  $payment_dtls['cust_id'], // Customer ID
      'description'     =>  $payment_dtls['description'],
      'reminder_enable' =>  true,
      'expire_by'       =>  strtotime( $payment_dtls['expiry'] ) // Payment link will expire in X time from generation 
    ]
  );

  // Return the payment link details send by Razorpay after payment link creation
  return $link;
}

and once this new version of the package is released, it would done as following:

// Include the composer autoload file
require_once( __DIR__ . '/../vendor/autoload.php' );

// Use Razorpay API
use Razorpay\Api\Api;

/**
 * Function to generate Razorpay Payment Link
 * @var $payment_dtls Array
 * @return $link Object
 */
function generate_payment_link( $payment_dtls ) {
  // Initiate New API
  $api = new Api( 'rzp_live_123456', 'abc123' );

  // Create Payment Link
  $link = $api->payment_link->create(
    json_encode(
      [
        'amount'          =>  ( $payment_dtls['amount'] * 100 ),
        'currency'        =>  $payment_dtls['currency'],
        'customer_id'     =>  $payment_dtls['cust_id'], // Customer ID
        'description'     =>  $payment_dtls['description'],
        'reminder_enable' =>  true,
        'expire_by'       =>  strtotime( $payment_dtls['expiry'] ) // Payment link will expire in X time from generation 
      ]
    ),
    'application/json'
  );

  // Return the payment link details send by Razorpay after payment link creation
  return $link;
}

Right? Or I am missing/misunderstanding something here?

neera11 · 2021-07-16T10:07:10Z

Hi @isaumya
You are using correctly , we need to pass second parameter as 'application/json'
Is it woking fine for you
or you getting any error?
Will mention all these dependencies in readme.md file also

isaumya · 2021-07-16T10:15:13Z

Hi @neera11,
I haven't tested the above code, I just modified the code to show you. I am not sure if I can test it until you guys release the update and I update the package via composer. I've running v2.7.0

isaumya · 2021-07-20T12:26:08Z

Hey @neera11,
You still haven't updated the readme file which still suggests users to create the payment link in the old ways.

neera11 · 2021-07-20T18:03:54Z

Hi @isaumya
sorry for the delay
I have updated readme file. Please check

isaumya · 2021-07-20T18:05:14Z

Thanks, @neera11. Yes, I have checked. Now I am waiting for this PR to be accepted and pushing a new release with this code so that I can update the dependency and use the new methods.

isaumya · 2021-08-13T16:45:08Z

Hey @neera11,
When is this getting released in a new version of the PHP client? As we have to update to the new endpoint by Aug 15, right? So, not many days left.

abhayp · 2021-08-26T12:00:37Z

src/Entity.php

+     * @param string $contentType
+     * @return Payment_link
+     */
+    protected function create($attributes = null, $contentType= 'application/x-www-form-urlencoded')


Any reason why default content type is 'application/x-www-form-urlencoded'?

we are passing default as "application/x-www-form-urlencoded" and in case of payment link we need to pass "application/json" for that taking $contentType variable and passing default value as "application/x-www-form-urlencoded"

I dont think clients should pass content type separately. Idea of sdk is using the functions without knowing the internals. it should be just paymentlink->create(attributes) imo. content type if required can be passed internally to the generic function

@chirag-patel-rp

@neera11 yes we should not explicitly pass content type. The idea of SDK is to abstract out common things and only allow users to make changes in the input values, also check other APIs implemented, I don’t see anywhere we passed explicitly content type="application/json"
// @abhayp

abhayp · 2021-08-26T12:00:55Z

src/Entity.php

    {
        $entityUrl = $this->getEntityUrl();

-        return $this->request('POST', $entityUrl, $attributes);
+        return $this->request('POST', $entityUrl, $attributes,$contentType);


formatting issue, space after comma

ok will do that

src/Request.php

abhayp · 2021-08-26T12:01:42Z

src/Request.php

    {
+
+            $ContentTypeHeader = array('Content-Type' => $contentType );
+            self::$headers = array_merge(self::$headers, $ContentTypeHeader);


formatting issue need extra line

@abhayp @sofiya02 can we ask each developer to use the same code editor and have some linters in place, to avoid such issues in the code review

abhayp · 2021-08-26T12:03:21Z

src/Entity.php

+     *
+     * @param array $attributes 
+     * @param string $contentType
+     * @return Payment_link


this is not payment link class. why these comments?

abhayp · 2021-08-26T12:05:53Z

src/Request.php

@@ -153,12 +151,17 @@ protected function throwServerError($body, $httpStatusCode)
            $httpStatusCode);
    }

-    protected function getRequestHeaders()
+    protected function getRequestHeaders($contentType = 'application/x-www-form-urlencoded')


we are using only one content type everywhere? payment links will work with this content type?

What was the default content type before? if we start passing default content type as above for all apis, will there be any issues for other functionalities?

@abhayp, All of other RZP API is accepting POST request with Content-Type: application/x-www-form-urlencoded then why payment Links not ?

all out apis are json rest apis. we shouldnt ideally support application/x-www-form-urlencoded for json request. but since legacy code base is like that, we cannot remove it. for new ones we should enforce application/json

we can release the new SDK version with application/json @ramth05 do you see any challenges or drawbacks?
Anyway we want to move to application/json

@chirag-patel-rp , don't see any issue as all our API supporting application/json and no changes required by enduser . The only thing is that all the API end points we should test it before release new version. and if there is any corner case it should be handled.

isaumya · 2021-09-09T14:43:07Z

@abhayp, @chirag-patel-rp please hurry up on pushing this release to the SDK as my account has been upgraded to using the new API and all of my automation system which is using the SDK might fail as I am not using the new API for payment link generation.

chirag-patel-rp · 2021-09-10T09:35:52Z

@isaumya contenty type relate comment is still not resolved
@neera11 any update on that?

neera11 · 2021-09-11T11:27:18Z

@chirag-patel-rp @isaumya I have added content type related issue

abhayp · 2021-09-14T15:45:29Z

src/Request.php

    {
+        if(isset($additionHeader)){


dont check isset. it will always return true since the variable is set. check if(empty(additionHeader) === false please

abhayp · 2021-09-14T15:45:58Z

src/Request.php

@@ -153,12 +152,18 @@ protected function throwServerError($body, $httpStatusCode)
            $httpStatusCode);
    }

-    protected function getRequestHeaders()
+    protected function getRequestHeaders($additionHeader)


add param type. this should always be an array. empty array for non pl

abhayp · 2021-09-14T15:48:04Z

src/Entity.php

@@ -7,12 +7,19 @@
 class Entity extends Resource implements ArrayableInterface
 {
    protected $attributes = array();
-
+    private $additionHeader;


follow how attributes are done please. this should be initialized as empty array

abhayp · 2021-09-14T15:49:14Z

src/Entity.php

-
-        return $this->request('POST', $entityUrl, $attributes);
+        
+        return $this->request('POST', $entityUrl, $attributes, $this->additionHeader);


additional header is passed here. cannot see the function param in request function

abhayp · 2021-09-14T15:52:56Z

src/Entity.php

@@ -83,10 +90,9 @@ protected function request($method, $relativeUrl, $data = null)
    {
        $request = new Request();

-        $response = $request->request($method, $relativeUrl, $data);
+        $response = $request->request($method, $relativeUrl, $data, $this->additionHeader);


why pass the additional header from create function if u are referencing this here

abhayp · 2021-09-14T15:53:55Z

src/Request.php

@@ -37,7 +37,7 @@ class Request
     * @return array Response data in array format. Not meant
     * to be used directly
     */
-    public function request($method, $url, $data = array())
+    public function request($method, $url, $data = array(),$additionHeader)


initialize as empty array please ..just like data

abhayp

lgtm

ramth05 · 2021-09-16T13:26:10Z

README.md

+
+$link  = $api->payment_link->fetch('plink_GiwM9xbIZqbkJp'); // fetch payment link with id
+
+$data = json_encode(


@neera11, why we need to pass data as JSON for this entity only?

yep..should be array. @neera11

ramth05 · 2021-09-16T13:45:26Z

src/Payment_link.php

+use Requests;
+
+
+class Payment_link extends Entity


@neera11 , why it's Payment_link not PaymentLink

neera11 · 2021-09-23T07:28:16Z

Hi @isaumya

We have updated the paymentlink.
Now you don't need to pass second parameter as application/json while creating new paymentlink and also no need to pass data in json format.
just use as below
$link = $api->payment_link->create(array('amount' => 98765,'description' => 'For XYZ purpose', 'customer' => array('email' => 'test@test.test'))); // create payment link

Thank you

isaumya · 2021-09-23T07:36:03Z

Hi @neera11,
Thank you so much for letting me know and also for releasing the update.
Just have one small request, in the readme file for each call, please mention the respective API doc link for that call so that users can easily see what are the list of arguments that they can pass to that call. As in your example, you may have used a few parameters while I might use parameters like currency, cusermeID etc. So, if you guys provide a link to the API docs, users can easily see what they can pass to that call.

P.S.; Also in a future release, try testing your codebase in PHP 8, there are a few minor warnings in PHP 8 for the codebase.

neera11 added 3 commits March 11, 2021 15:30

added new end point to create payment link

9243312

added new file payment_link

69e8090

removed unwanted comments

59eca60

neera11 changed the title ~~payment end point~~ payment link end point Jul 15, 2021

neera11 requested review from abhayp and SushanthGunjal July 15, 2021 10:06

neera11 force-pushed the payment-link branch from d1a3ba2 to b19f502 Compare July 20, 2021 10:39

neera11 force-pushed the payment-link branch from b19f502 to 09979d6 Compare July 20, 2021 18:00

neera11 force-pushed the payment-link branch from 09979d6 to 76a2156 Compare July 21, 2021 14:43

abhayp reviewed Aug 26, 2021

View reviewed changes

src/Request.php Show resolved Hide resolved

abhayp reviewed Aug 26, 2021

View reviewed changes

neera11 force-pushed the payment-link branch from 76a2156 to 084b808 Compare August 31, 2021 06:01

neera11 force-pushed the payment-link branch 3 times, most recently from e1b4300 to 53f3d9c Compare September 9, 2021 14:35

neera11 force-pushed the payment-link branch from 53f3d9c to ec60b44 Compare September 11, 2021 11:29

abhayp reviewed Sep 14, 2021

View reviewed changes

neera11 force-pushed the payment-link branch 2 times, most recently from b914963 to dce1111 Compare September 15, 2021 10:31

updated changes and version of sdk in Changelog.md

5ed1c1b

neera11 force-pushed the payment-link branch from dce1111 to 5ed1c1b Compare September 15, 2021 20:07

abhayp approved these changes Sep 16, 2021

View reviewed changes

neera11 merged commit f562c91 into master Sep 16, 2021

ramth05 reviewed Sep 16, 2021

View reviewed changes

src/Payment_link.php

use Requests;

class Payment_link extends Entity

Copy link

Contributor

ramth05 Sep 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@neera11 , why it's Payment_link not PaymentLink


		return $this->request('POST', $entityUrl, $attributes);

		return $this->request('POST', $entityUrl, $attributes, $this->additionHeader);


		$link = $api->payment_link->fetch('plink_GiwM9xbIZqbkJp'); // fetch payment link with id

		$data = json_encode(

payment link end point #233

payment link end point #233

Conversation

neera11 commented Jul 15, 2021

isaumya commented Jul 16, 2021

neera11 commented Jul 16, 2021

isaumya commented Jul 16, 2021

neera11 commented Jul 16, 2021 • edited

isaumya commented Jul 16, 2021

isaumya commented Jul 20, 2021

neera11 commented Jul 20, 2021

isaumya commented Jul 20, 2021

isaumya commented Aug 13, 2021

Choose a reason for hiding this comment

neera11 Aug 26, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chirag-patel-rp Sep 8, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neera11 Aug 26, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

isaumya commented Sep 9, 2021

chirag-patel-rp commented Sep 10, 2021

neera11 commented Sep 11, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abhayp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neera11 commented Sep 23, 2021

isaumya commented Sep 23, 2021

neera11 commented Jul 16, 2021 •

edited

neera11 Aug 26, 2021 •

edited

chirag-patel-rp Sep 8, 2021 •

edited

neera11 Aug 26, 2021 •

edited