You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is the base ruby gem for interacting with the Razorpay API. This is primarily meant for users who wish to perform interactions with the Razorpay API programatically.
|description | string | A brief description of the invoice. |
70
-
|customer_id | string | customer id for which invoice need be raised |
71
-
|customer | object | customer details in a object format |
70
+
|customer_id | string | customer id for which invoice need be raised |
71
+
|draft | string | Invoice is created in draft state when value is set to `1`|
72
+
| customer.name*| object | All parameters listed [here](https://razorpay.com/docs/api/payments/invoices/#create-an-invoice) are supported |
73
+
| line_items | object | All parameters listed [here](https://razorpay.com/docs/api/payments/invoices/#create-an-invoice) are supported |
74
+
75
+
|expire_by | object | Details of the line item that is billed in the invoice. |
76
+
|sms_notify | object | Details of the line item that is billed in the invoice. |
77
+
|email_notify | object | Details of the line item that is billed in the invoice. |
78
+
|partial_payment | boolean | Indicates whether customers can make partial payments on the invoice . Possible values: true - Customer can make partial payments. false (default) - Customer cannot make partial payments. |
79
+
| currency*| string | The currency of the payment (defaults to INR) |
72
80
73
81
**Response:**
74
82
For create invoice response please click [here](https://razorpay.com/docs/api/invoices/#create-an-invoice)
Copy file name to clipboardExpand all lines: documents/customer.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,8 @@ Razorpay::Customer.create({
28
28
| name*| string | Name of the customer |
29
29
| email | string | Email of the customer |
30
30
| contact | string | Contact number of the customer |
31
+
| 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`|
32
+
| gstin | string | Customer's GST number, if available. For example, `29XAbbA4369J1PA`|
Copy file name to clipboardExpand all lines: documents/emandate.md
+20-12Lines changed: 20 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,6 @@ Razorpay::Customer.create({
12
12
"contact": 9123456780,
13
13
"email": "gaurav.kumar@example.com",
14
14
"fail_existing": 0,
15
-
"gstin": "29XAbbA4369J1PA",
16
15
"notes": {
17
16
"notes_key_1": "Tea, Earl Grey, Hot",
18
17
"notes_key_2": "Tea, Earl Grey… decaf."
@@ -28,6 +27,7 @@ Razorpay::Customer.create({
28
27
| email | string | Email of the customer |
29
28
| contact | string | Contact number of the customer |
30
29
| notes | object | A key-value pair |
30
+
| 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`|
31
31
32
32
**Response:**
33
33
```json
@@ -50,9 +50,10 @@ Razorpay::Customer.create({
50
50
### Create order
51
51
52
52
```rb
53
-
Razorpay::Customer.create({
53
+
Razorpay::Order.create({
54
54
"amount": 0,
55
55
"currency": "INR",
56
+
"payment_capture": true,
56
57
"method": "emandate",
57
58
"customer_id": "cust_1Aa00000000001",
58
59
"receipt": "Receipt No. 1",
@@ -70,7 +71,7 @@ Razorpay::Customer.create({
70
71
},
71
72
"bank_account": {
72
73
"beneficiary_name": "Gaurav Kumar",
73
-
"account_number": 1121431121541121,
74
+
"account_number": "1121431121541121",
74
75
"account_type": "savings",
75
76
"ifsc_code": "HDFC0000001"
76
77
}
@@ -86,12 +87,14 @@ Razorpay::Customer.create({
86
87
| currency*| string | Currency of the order. Currently only `INR` is supported. |
87
88
| method*| string | The authorization method. In this case the value will be `emandate`|
88
89
| receipt | string | Your system order reference id. |
90
+
| customer_id*| string | The `customer_id` for the customer you want to charge.|
89
91
| 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. |
90
-
| notes | object | A key-value pair |
91
-
| token | object |A key-value pair |
92
+
| notes | object | A key-value pair |
93
+
| token | object |All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/emandate/create-authorization-transaction/#112-create-an-order) are supported|
92
94
93
95
**Response:**
94
96
Create order response please click [here](https://razorpay.com/docs/api/recurring-payments/emandate/authorization-transaction/#112-create-an-order)
| customer | object | Details of the customer to whom the registrationlink will be sent. |
148
+
| customer*| object | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/emandate/create-authorization-transaction/#121-create-a-registration-link) are supported|
146
149
| type*| string | In this case, the value is `link`. |
147
150
| currency*| string | The 3-letter ISO currency code for the payment. Currently, only `INR` is supported. |
148
151
| amount*| integer | The payment amount in the smallest currency sub-unit. |
149
152
| description*| string | A description that appears on the hosted page. For example, `12:30 p.m. Thali meals (Gaurav Kumar`). |
150
-
| subscription_registration | object | Details of the authorization payment. |
151
-
| notes | object | A key-value pair |
153
+
| subscription_registration | object | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/emandate/create-authorization-transaction/#121-create-a-registration-link) are supported |
154
+
| email_notify | boolean | Email notifications are to be sent by Razorpay (default : 1) |
155
+
| expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
156
+
| receipt | string | Your system order reference id. |
157
+
| notes | object | A key-value pair |
152
158
153
159
**Response:**
154
160
Create registration link response please click [here](https://razorpay.com/docs/api/recurring-payments/emandate/authorization-transaction/#121-create-a-registration-link)
| currency*| string | Currency of the order. Currently only `INR` is supported. |
410
417
| receipt | string | Your system order reference id. |
411
418
| notes | object | A key-value pair |
419
+
| 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. |
0 commit comments