razorpay 2.4.1 → 3.0.0

data/documents/registerEmandate.md

@@ -0,0 +1,445 @@
+## Register emandate and charge first payment together
+
+```rb
+require "razorpay"
+Razorpay.setup('key_id', 'key_secret')
+```
+
+### Create customer
+
+```rb
+para_attr = {
+  "name": "Gaurav Kumar",
+  "contact": 9123456780,
+  "email": "gaurav.kumar@example.com",
+  "fail_existing": 0,
+  "gstin": "29XAbbA4369J1PA",
+  "notes": {
+    "notes_key_1": "Tea, Earl Grey, Hot",
+    "notes_key_2": "Tea, Earl Grey… decaf."
+  }
+}
+Razorpay::Customer.create(para_attr)
+```
+**Parameters:**
+
+| Name          | Type        | Description                                 |
+|---------------|-------------|---------------------------------------------|
+| name*          | string      | Name of the customer                        |
+| email        | string      | Email of the customer                       |
+| contact      | string      | Contact number of the customer              |
+| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `0` or `1`|
+| notes         | object      | A key-value pair                            |
+
+**Response:**
+```json
+{
+  "id": "cust_1Aa00000000003",
+  "entity": "customer",
+  "name": "Gaurav Kumar",
+  "email": "Gaurav.Kumar@example.com",
+  "contact": "9000000000",
+  "gstin": null,
+  "notes": {
+    "notes_key_1": "Tea, Earl Grey, Hot",
+    "notes_key_2": "Tea, Earl Grey… decaf."
+  },
+  "created_at": 1582033731
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Create order
+
+```rb
+para_attr = {
+  "amount": 100,
+  "currency": "INR",
+  "method": "emandate",
+  "receipt": "Receipt No. 5",
+  "notes": {
+    "note_key 1": "Beam me up Scotty",
+    "note_key 2": "Engage"
+  },
+  "token": {
+    "first_payment_amount": 10000,
+    "auth_type": "netbanking",
+    "max_amount": 9999900,
+    "expire_at": 4102444799,
+    "notes": {
+      "note_key 1": "Tea, Earl Grey… decaf.",
+      "note_key 2": "Tea. Earl Gray. Hot."
+    },
+    "bank_account": {
+      "beneficiary_name": "Gaurav Kumar",
+      "account_number": 11214311215411,
+      "account_type": "savings",
+      "ifsc_code": "HDFC0001233"
+    }
+  }
+}
+Razorpay::Order.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| amount*   | integer      | The amount to be captured (should be equal to the authorized amount, in paise) |
+| currency*   | string  | The currency of the payment (defaults to INR)  |
+| customerId*   | string      | The id of the customer to be fetched |
+| method*      | string  | Payment method used to make the registration transaction. Possible value is `emandate`.  |
+| receipt      | string  | Your system order reference id.  |
+| payment_capture  | boolean  | Indicates whether payment status should be changed to captured automatically or not. Possible values: true - Payments are captured automatically. false - Payments are not captured automatically. |
+| token  | object  | All keys listed [here](https://razorpay.com/docs/api/recurring-payments/emandate/auto-debit/#112-create-an-order) are supported |
+| notes | object  | A key-value pair  |
+
+**Response:**
+For create order response please click [here](https://razorpay.com/docs/api/recurring-payments/emandate/auto-debit/#112-create-an-order)
+
+-------------------------------------------------------------------------------------------------------
+
+### Create an Authorization Payment
+
+Please refer this [doc](https://razorpay.com/docs/api/recurring-payments/emandate/auto-debit/#113-create-an-authorization-payment) for authorization payment
+
+-----------------------------------------------------------------------------------------------------
+
+### Create registration link
+
+```rb
+para_attr = {
+  "customer": {
+    "name": "Gaurav Kumar",
+    "email": "gaurav.kumar@example.com",
+    "contact": 9123456780
+  },
+  "type": "link",
+  "amount": 100,
+  "currency": "INR",
+  "description": "Registration Link for Gaurav Kumar",
+  "subscription_registration": {
+    "first_payment_amount": 100,
+    "method": "emandate",
+    "auth_type": "netbanking",
+    "max_amount": 50000,
+    "expire_at": 1634215992,
+    "bank_account": {
+      "beneficiary_name": "Gaurav Kumar",
+      "account_number": 11214311215411,
+      "account_type": "savings",
+      "ifsc_code": "HDFC0001233"
+    }
+  },
+  "receipt": "Receipt No. 5",
+  "email_notify": 1,
+  "sms_notify": 1,
+  "expire_by": 1634215992,
+  "notes": {
+    "note_key 1": "Beam me up Scotty",
+    "note_key 2": "Tea. Earl Gray. Hot."
+  }
+}
+Razorpay::SubscriptionRegistration.create(para_attr)
+```
+
+**Parameters:**
+
+| Name            | Type    | Description                                                   |
+|-----------------|---------|---------------------------------------------------------------|
+| customer   | object      | Details of the customer to whom the registration link will be sent. |
+| type*  | object | the value is `link`. |
+| amount*   | integer      | The amount to be captured (should be equal to the authorized amount, in paise) |
+| currency*   | string  | The currency of the payment (defaults to INR)  |
+| description*  | string      | A brief description of the payment.   |
+| subscription_registration   | object  | All keys listed [here](https://razorpay.com/docs/api/recurring-payments/emandate/auto-debit/#121-create-a-registration-link) are supported  |
+| receipt      | string  | Your system order reference id.  |
+| sms_notify  | boolean  | SMS notifications are to be sent by Razorpay (default : 1)  |
+| email_notify | boolean  | Email notifications are to be sent by Razorpay (default : 1)  |
+| expire_by    | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
+| notes | object  | A key-value pair  |
+
+**Response:**
+For create registration link response please click [here](https://razorpay.com/docs/api/recurring-payments/emandate/auto-debit/#12-using-a-registration-link)
+-------------------------------------------------------------------------------------------------------
+
+## Create an order to charge the customer
+
+```rb
+para_attr ={
+  "amount": "100",
+  "currency": "INR",
+  "receipt": "Receipt No. 1",
+  "notes": {
+    "key1": "value3",
+    "key2": "value2"
+  }
+}
+Razorpay::Order.create(para_attr)
+```
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| amount*   | integer      | The amount to be captured (should be equal to the authorized amount, in paise) |
+| currency*   | string  | The currency of the payment (defaults to INR)  |
+| receipt      | string  | Your system order reference id.  |
+| payment_capture  | boolean  | Indicates whether payment status should be changed to captured automatically or not. Possible values: true - Payments are captured automatically. false - Payments are not captured automatically. |
+| notes | object  | A key-value pair  |
+
+**Response:**
+```json
+{
+   "id":"order_1Aa00000000002",
+   "entity":"order",
+   "amount":1000,
+   "amount_paid":0,
+   "amount_due":1000,
+   "currency":"INR",
+   "receipt":"Receipt No. 1",
+   "offer_id":null,
+   "status":"created",
+   "attempts":0,
+   "notes":{
+      "notes_key_1":"Tea, Earl Grey, Hot",
+      "notes_key_2":"Tea, Earl Grey… decaf."
+   },
+   "created_at":1579782776
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+## Create a recurring payment
+
+```rb
+para_attr = {
+  "email": "gaurav.kumar@example.com",
+  "contact": 9123456789,
+  "amount": 1000,
+  "currency": "INR",
+  "recurring": 1,
+  "description": "Creating recurring payment for Gaurav Kumar",
+  "notes": {
+    "key1": "value3",
+    "key2": "value2"
+  }
+}
+Razorpay::Payment.createRecurringPayment(para_attr)
+```
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| email*   | string      | The customer's email address |
+| contact*   | string      | The customer's phone number |
+| amount*   | integer      | The amount to be captured (should be equal to the authorized amount, in paise) |
+| currency*   | string  | The currency of the payment (defaults to INR)  |
+| orderId*   | string      | The id of the order to be fetched |
+| customerId*   | string      | The id of the customer to be fetched |
+| tokenId*   | string      | The id of the token to be fetched |
+| recurring*   | boolean      | Possible values is `0` or `1` |
+| description  | string      | A brief description of the payment.   |
+| notes | object  | A key-value pair  |
+
+**Response:**
+```json
+{
+  "razorpay_payment_id" : "pay_1Aa00000000001",
+  "razorpay_order_id" : "order_1Aa00000000001",
+  "razorpay_signature" : "9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d"
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+## Send/Resend notifications
+
+```rb
+invoiceId = "inv_JDdNb4xdf4gxQ7"
+
+medium = "email" 
+
+Razorpay::Invoice.notifyBy(invoiceId, medium)
+```
+**Parameters:**
+
+| Name            | Type    |Description      |
+|-----------------|---------|------------------------------------------------------------------------------|
+| invoiceId*   | string      | The id of the invoice to be fetched |
+| medium*   | string      | Possible values are `sms` or `email` |
+
+**Response:**
+```json
+{
+    "success": true
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+## Cancel registration link
+
+```rb
+Razorpay::Invoice.cancel(invoiceId);
+```
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| invoiceId*   | string      | The id of the invoice to be fetched |
+
+**Response:**
+```json
+{
+    "id": "inv_FHrfRupD2ouKIt",
+    "entity": "invoice",
+    "receipt": "Receipt No. 1",
+    "invoice_number": "Receipt No. 1",
+    "customer_id": "cust_BMB3EwbqnqZ2EI",
+    "customer_details": {
+        "id": "cust_BMB3EwbqnqZ2EI",
+        "name": "Gaurav Kumar",
+        "email": "gaurav.kumar@example.com",
+        "contact": "9123456780",
+        "gstin": null,
+        "billing_address": null,
+        "shipping_address": null,
+        "customer_name": "Gaurav Kumar",
+        "customer_email": "gaurav.kumar@example.com",
+        "customer_contact": "9123456780"
+    },
+    "order_id": "order_FHrfRw4TZU5Q2L",
+    "line_items": [],
+    "payment_id": null,
+    "status": "cancelled",
+    "expire_by": 4102444799,
+    "issued_at": 1595491479,
+    "paid_at": null,
+    "cancelled_at": 1595491488,
+    "expired_at": null,
+    "sms_status": "sent",
+    "email_status": "sent",
+    "date": 1595491479,
+    "terms": null,
+    "partial_payment": false,
+    "gross_amount": 100,
+    "tax_amount": 0,
+    "taxable_amount": 0,
+    "amount": 100,
+    "amount_paid": 0,
+    "amount_due": 100,
+    "currency": "INR",
+    "currency_symbol": "₹",
+    "description": "Registration Link for Gaurav Kumar",
+    "notes": {
+        "note_key 1": "Beam me up Scotty",
+        "note_key 2": "Tea. Earl Gray. Hot."
+    },
+    "comment": null,
+    "short_url": "https://rzp.io/i/QlfexTj",
+    "view_less": true,
+    "billing_start": null,
+    "billing_end": null,
+    "type": "link",
+    "group_taxes_discounts": false,
+    "created_at": 1595491480,
+    "idempotency_key": null
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+## Fetch token by payment id
+
+```rb
+paymentId = "pay_FHf9a7AO0iXM9I"
+
+Razorpay::Payment.fetch(paymentId)
+```
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| paymentId*   | string      | The id of the payment to be fetched |
+
+**Response:**
+For fetch token by payment id response please click [here](https://razorpay.com/docs/api/recurring-payments/emandate/auto-debit/#21-fetch-token-by-payment-id)
+
+-------------------------------------------------------------------------------------------------------
+
+## Fetch tokens by customer id
+
+```rb
+customerId = "cust_1Aa00000000004"
+
+Razorpay::Customer.fetchTokens(customerId)
+```
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| customerId*   | string      | The id of the customer to be fetched |
+
+**Response:**
+```json
+{
+  "entity": "collection",
+  "count": 1,
+  "items": [
+    {
+      "id": "token_FHf94Uym9tdYFJ",
+      "entity": "token",
+      "token": "2wDPM7VAlXtjAR",
+      "bank": "HDFC",
+      "wallet": null,
+      "method": "emandate",
+      "vpa": null,
+      "recurring": true,
+      "recurring_details": {
+        "status": "confirmed",
+        "failure_reason": null
+      },
+      "auth_type": "netbanking",
+      "mrn": null,
+      "used_at": 1595447381,
+      "created_at": 1595447381,
+      "bank_details": {
+        "beneficiary_name": "Gaurav Kumar",
+        "account_number": "1121431121541121",
+        "ifsc": "HDFC0000001",
+        "account_type": "savings"
+      },
+      "max_amount": 9999900,
+      "expired_at": 1689971140,
+      "dcc_enabled": false
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+## Delete tokens
+
+```rb
+customerId = "cust_1Aa00000000004"
+
+tokenId = "token_Hxe0skTXLeg9pF"
+
+Razorpay::fetch(customerId).deleteToken(tokenId)
+```
+**Parameters:**
+
+| Name            | Type    | Description                                                                  |
+|-----------------|---------|------------------------------------------------------------------------------|
+| customerId*   | string      | The id of the customer to be fetched |
+| tokenId*   | string      | The id of the token to be fetched |
+
+**Response:**
+```json
+{
+    "deleted": true
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+**PN: * indicates mandatory fields**
+<br>
+<br>
+**For reference click [here](https://razorpay.com/docs/api/recurring-payments/emandate/auto-debit/)**