Merge pull request #145 from razorpay/payment_link

add new end point to create paymentlink

Author: neera11

razorpay/__init__.py

@@ -3,6 +3,7 @@
 from .resources import Payment
 from .resources import Refund
 from .resources import Invoice
+from .resources import PaymentLink
 from .resources import Customer
 from .resources import Card
 from .resources import Token
@@ -22,6 +23,7 @@
         'Order',
         'Client',
         'Invoice',
+        'PaymentLink',
         'Utility',
         'Customer',
         'Card',

razorpay/constants/url.py

@@ -2,6 +2,7 @@ class URL(object):
     BASE_URL = 'https://api.razorpay.com/v1'
     ORDER_URL = "/orders"
     INVOICE_URL = "/invoices"
+    PAYMENT_LINK_URL = "/payment_links"
     PAYMENTS_URL = "/payments"
     REFUNDS_URL = "/refunds"
     CARD_URL = "/cards"

razorpay/resources/__init__.py

@@ -2,6 +2,7 @@
 from .refund import Refund
 from .order import Order
 from .invoice import Invoice
+from .payment_link import PaymentLink
 from .customer import Customer
 from .card import Card
 from .token import Token
@@ -12,19 +13,19 @@
 from .subscription import Subscription
 from .settlement import Settlement
 
-
 __all__ = [
-        'Payment',
-        'Refund',
-        'Order',
-        'Invoice',
-        'Customer',
-        'Card',
-        'Token',
-        'Transfer',
-        'VirtualAccount',
-        'Addon',
-        'Plan',
-        'Subscription',
-        'Settlement',
+    'Payment',
+    'Refund',
+    'Order',
+    'Invoice',
+    'PaymentLink',
+    'Customer',
+    'Card',
+    'Token',
+    'Transfer',
+    'VirtualAccount',
+    'Addon',
+    'Plan',
+    'Subscription',
+    'Settlement',
 ]

razorpay/resources/payment_link.py

@@ -0,0 +1,61 @@
+from .base import Resource
+from ..constants.url import URL
+import warnings
+
+
+class PaymentLink(Resource):
+    def __init__(self, client=None):
+        super(PaymentLink, self).__init__(client)
+        self.base_url = URL.PAYMENT_LINK_URL
+
+    def fetch_all(self, data={}, **kwargs):  # pragma: no cover
+        warnings.warn("Will be Deprecated in next release", DeprecationWarning)
+        return self.all(data, **kwargs)
+
+    def all(self, data={}, **kwargs):
+        """"
+        Fetch all Payment link entities
+
+        Returns:
+            Dictionary of Payment link data
+        """
+        return super(PaymentLink, self).all(data, **kwargs)
+
+    def fetch(self, payment_link_id, data={}, **kwargs):
+        """"
+        Fetch Payment link for given Id
+
+        Args:
+            payment_link_id : Id for which Payment link object has to be retrieved
+
+        Returns:
+            Payment link dict for given payment_link_id Id
+        """
+        return super(PaymentLink, self).fetch(payment_link_id, data, **kwargs)
+
+    def create(self, data={}, **kwargs):
+        """"
+        Create Payment link from given dict
+
+        Args:
+            data : Dictionary having keys using which Payment link have to be created
+
+        Returns:
+            Payment link Dict which was created
+        """
+        url = self.base_url
+        return self.post_url(url, data, **kwargs)
+
+    def cancel(self, payment_link_id, **kwargs):
+        """"
+        Cancel an unpaid Payment link with given ID via API
+        It can only be called on an Payment link that is not in the paid state.
+
+        Args:
+            payment_link_id : Id for cancel the Payment link
+        Returns:
+            The response for the API will be the Payment link entity, similar to create/update API response, with status attribute's value as cancelled
+        """
+        url = "{}/{}/cancel".format(self.base_url, payment_link_id)
+        return self.post_url(url, {}, **kwargs)
+