Skip to content

fix: Boolean correction in doc #449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ankitdas13 merged 2 commits into from
Jul 7, 2025
Merged

fix: Boolean correction in doc #449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81e650f
fix: Boolean correction in doc
ankitdas13 Jun 26, 2025
dc8a313
fail existing value correction
ankitdas13 Jul 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions documents/card.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ instance.customers.create({
"name": "Gaurav Kumar",
"email": "gaurav.kumar@example.com",
"contact": "9123456780",
"fail_existing": "0",
"fail_existing": "1",
"notes":{
"note_key_1": "September",
"note_key_2": "Make it so."
Expand All @@ -21,7 +21,7 @@ instance.customers.create({
| 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`|
| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `1` or `0`|
| notes | object | A key-value pair |

**Response:**
Expand Down Expand Up @@ -124,8 +124,8 @@ instance.subscriptions.createRegistrationLink({
"expire_at": 1609423824
},
"receipt": "Receipt No. 1",
"email_notify": 1,
"sms_notify": 1,
"email_notify": true,
"sms_notify": true,
"expire_by": 1580479824,
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
Expand All @@ -145,8 +145,8 @@ instance.subscriptions.createRegistrationLink({
| description* | string | A brief description of the payment. |
| subscription_registration | object | All keys listed [here](https://razorpay.com/docs/api/recurring-payments/cards/authorization-transaction/#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) |
| sms_notify | boolean | SMS notifications are to be sent by Razorpay |
| email_notify | boolean | Email notifications are to be sent by Razorpay |
| expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
| notes | object | A key-value pair |

Expand Down Expand Up @@ -283,7 +283,7 @@ instance.payments.createRecurringPayment({
"order_id": "order_IDts8IQBJT40aQ",
"customer_id": "cust_Hwq7Ba6TDXl1ga",
"token": "token_1Aa00000000001",
"recurring": 1,
"recurring": true,
"description": "Creating recurring payment for Gaurav Kumar",
"notes": {
"note_key 1": "Beam me up Scotty",
Expand All @@ -302,7 +302,7 @@ instance.payments.createRecurringPayment({
| 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` |
| recurring* | boolean | Possible values is `true` or `false` |
| description | string | A brief description of the payment. |
| notes | object | A key-value pair |

Expand Down
4 changes: 2 additions & 2 deletions documents/customer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ instance.customers.create({
"name": "Gaurav Kumar",
"contact": 9123456780,
"email": "gaurav.kumar@example.com",
"fail_existing": 0,
"fail_existing": "1",
"gstin": "29XAbbA4369J1PA",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
Expand All @@ -22,7 +22,7 @@ instance.customers.create({
| 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`|
| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `1` or `0`|
| gstin | string | Customer's GST number, if available. For example, 29XAbbA4369J1PA |
| notes | object | A key-value pair |

Expand Down
14 changes: 7 additions & 7 deletions documents/emandate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ instance.customers.create({
"name": "Gaurav Kumar",
"contact": 9123456780,
"email": "gaurav.kumar@example.com",
"fail_existing": 0,
"fail_existing": "1",
"gstin": "29XAbbA4369J1PA",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
Expand All @@ -21,7 +21,7 @@ instance.customers.create({
|---------------|-------------|---------------------------------------------|
| name* | string | Name of the customer |
| email | string | Email 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`|
| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `1` or `0`|
| contact | string | Contact number of the customer |
| notes | object | A key-value pair |

Expand Down Expand Up @@ -124,8 +124,8 @@ instance.subscriptions.createRegistrationLink({
},
"receipt": "Receipt no. 1",
"expire_by": 1880480689,
"sms_notify": 1,
"email_notify": 1,
"sms_notify": true,
"email_notify": true,
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Tea. Earl Gray. Hot."
Expand All @@ -143,7 +143,7 @@ instance.subscriptions.createRegistrationLink({
| amount* | integer | The payment amount in the smallest currency sub-unit. |
| description* | string | A description that appears on the hosted page. For example, `12:30 p.m. Thali meals (Gaurav Kumar`). |
| subscription_registration | array | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/emandate/create-authorization-transaction/#121-create-a-registration-link) are supported |
| email_notify | boolean | Email notifications are to be sent by Razorpay (default : 1) |
| email_notify | boolean | Email notifications are to be sent by Razorpay (default : true) |
| expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
| receipt | string | Your system order reference id. |
| notes | array | A key-value pair |
Expand Down Expand Up @@ -453,7 +453,7 @@ instance.payments.createRecurringPayment({
"order_id": "order_1Aa00000000002",
"customer_id": "cust_1Aa00000000001",
"token": "token_1Aa00000000001",
"recurring": "1",
"recurring": true,
"description": "Creating recurring payment for Gaurav Kumar",
"notes": {
"note_key 1": "Beam me up Scotty",
Expand All @@ -473,7 +473,7 @@ instance.payments.createRecurringPayment({
| order_id* | string | The unique identifier of the order created. |
| customer_id* | string | The `customer_id` for the customer you want to charge. |
| token* | string | The `token_id` generated when the customer successfully completes the authorization payment. Different payment instruments for the same customer have different `token_id`.|
| recurring* | string | Determines if recurring payment is enabled or not. Possible values:<br>* `1` - Recurring is enabled.* `0` - Recurring is not enabled.|
| recurring* | string | Determines if recurring payment is enabled or not. Possible values:<br>* `true` - Recurring is enabled.* `false` - Recurring is not enabled.|
| description | string | A user-entered description for the payment.|
| notes | object | Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. |

Expand Down
4 changes: 2 additions & 2 deletions documents/invoice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ instance.invoice.create({
"quantity": 1
}
],
"sms_notify": 1,
"email_notify": 1,
"sms_notify": true,
"email_notify": true,
"currency": "USD",
"expire_by": 1589765167
})
Expand Down
2 changes: 1 addition & 1 deletion documents/order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ instance.orders.create({
| currency* | string | The currency in which the transaction should be made. default value is `INR`|
| receipt | string | Your receipt id for this order should be passed here. Maximum length of 40 characters. |
| notes | array | Key-value pair that can be used to store additional information about the entity.|
| rto_review | boolean | Identifier to mark the order eligible for RTO risk prediction. Possible values is `0` or `1` |
| rto_review | boolean | Identifier to mark the order eligible for RTO risk prediction. Possible values is `true` or `false` |
| line_items | array | All keys listed [here](https://razorpay.com/docs/payments/magic-checkout/rto-intelligence/#step-1-create-an-order) are supported |
| line_items_total | integer | Sum of offer_price for all line items added in the cart in paise. |
| shipping_fee | integer | Shipping fee charged on the line items in paisa. |
Expand Down
16 changes: 8 additions & 8 deletions documents/papernach.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ instance.customers.create({
"name": "Gaurav Kumar",
"contact": 9123456780,
"email": "gaurav.kumar@example.com",
"fail_existing": 0,
"fail_existing": "1",
"gstin": "29XAbbA4369J1PA",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
Expand All @@ -22,7 +22,7 @@ instance.customers.create({
| 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`|
| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `1` or `0`|
| notes | object | A key-value pair |

**Response:**
Expand Down Expand Up @@ -193,8 +193,8 @@ instance.subscriptions.createRegistrationLink({
"max_amount": 50000
},
"receipt": "Receipt No. 1",
"sms_notify": 1,
"email_notify": 1,
"sms_notify": true,
"email_notify": true,
"expire_by": 1647483647,
"notes": {
"note_key 1": "Beam me up Scotty",
Expand All @@ -212,8 +212,8 @@ instance.subscriptions.createRegistrationLink({
| amount* | integer | The payment amount in the smallest currency sub-unit. |
| description* | string | A description that appears on the hosted page. For example, `12:30 p.m. Thali meals (Gaurav Kumar`). |
| subscription_registration | array | All parameters listed [here](https://razorpay.com/docs/api/payments/recurring-payments/paper-nach/create-authorization-transaction/#121-create-a-registration-link) |
| 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) |
| sms_notify | boolean | SMS notifications are to be sent by Razorpay (default : true) |
| email_notify | boolean | Email notifications are to be sent by Razorpay (default : true) |
| expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
| receipt | string | Your system order reference id. |
| notes | array | A key-value pair |
Expand Down Expand Up @@ -632,7 +632,7 @@ instance.payments.createRecurringPayment({
"order_id": "order_1Aa00000000002",
"customer_id": "cust_1Aa00000000001",
"token": "token_1Aa00000000001",
"recurring": "1",
"recurring": true,
"description": "Creating recurring payment for Gaurav Kumar",
"notes": {
"note_key 1": "Beam me up Scotty",
Expand All @@ -652,7 +652,7 @@ instance.payments.createRecurringPayment({
| order_id* | string | The unique identifier of the order created. |
| customer_id* | string | The `customer_id` for the customer you want to charge. |
| token* | string | The `token_id` generated when the customer successfully completes the authorization payment. Different payment instruments for the same customer have different `token_id`.|
| recurring* | string | Determines if recurring payment is enabled or not. Possible values:<br>* `1` - Recurring is enabled.* `0` - Recurring is not enabled.|
| recurring* | string | Determines if recurring payment is enabled or not. Possible values:<br>* `true` - Recurring is enabled.* `false` - Recurring is not enabled.|
| description | string | A user-entered description for the payment.|
| notes | object | Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. |

Expand Down
43 changes: 27 additions & 16 deletions documents/payment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,19 +500,30 @@ instance.orders.create({

```js
instance.payments.createPaymentJson({
"amount": 100,
"currency": "INR",
"order_id": "order_EAkbvXiCJlwhHR",
"email": "gaurav.kumar@example.com",
"contact": 9090909090,
"method": "card",
"card":{
"number": 4111111111111111,
"name": "Gaurav",
"expiry_month": 11,
"expiry_year": 23,
"cvv": 100
}
"amount": 100,
"currency": "INR",
"contact": "9000090000",
"email": "gaurav.kumar@example.com",
"order_id": "order_DPzFe1Q1dEOKed",
"method": "card",
"card": {
"number": "4386289407660153",
"name": "Gaurav",
"expiry_month": 11,
"expiry_year": 30,
"cvv": 100
},
"authentication": {
"authentication_channel": "browser"
},
"browser": {
"java_enabled": false,
"javascript_enabled": false,
"timezone_offset": 11,
"color_depth": 23,
"screen_width": 23,
"screen_height": 100
}
})
```

Expand Down Expand Up @@ -705,7 +716,7 @@ instance.payments.createUpi({
"contact": "9123456789",
"method": "upi",
"customer_id": "cust_EIW4T2etiweBmG",
"save": 1,
"save": true,
"ip": "192.168.0.103",
"referer": "http",
"user_agent": "Mozilla/5.0",
Expand All @@ -732,7 +743,7 @@ instance.payments.createUpi({
| contact* | string | Contact number of the customer |
| notes | array | A key-value pair |
| description | string | Descriptive text of the payment. |
| save | boolean | Specifies if the VPA should be stored as tokens.Possible value is `0`, `1` |
| save | boolean | Specifies if the VPA should be stored as tokens.Possible value is `true`, `false` |
| callback_url | string | URL where Razorpay will submit the final payment status. |
| ip* | string | The client's browser IP address. For example `117.217.74.98` |
| referer* | string | Value of `referer` header passed by the client's browser. For example, `https://example.com/` |
Expand Down Expand Up @@ -780,7 +791,7 @@ instance.payments.createUpi({
| contact* | string | Contact number of the customer |
| notes | array | A key-value pair |
| description | string | Descriptive text of the payment. |
| save | boolean | Specifies if the VPA should be stored as tokens.Possible value is `0`, `1` |
| save | boolean | Specifies if the VPA should be stored as tokens.Possible value is `true`, `false` |
| callback_url | string | URL where Razorpay will submit the final payment status. |
| ip* | string | The client's browser IP address. For example `117.217.74.98` |
| referer* | string | Value of `referer` header passed by the client's browser. For example, `https://example.com/` |
Expand Down
16 changes: 8 additions & 8 deletions documents/registerEmandate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ instance.customers.create({
"name": "Gaurav Kumar",
"contact": 9123456780,
"email": "gaurav.kumar@example.com",
"fail_existing": 0,
"fail_existing": "1",
"gstin": "29XAbbA4369J1PA",
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
Expand All @@ -21,7 +21,7 @@ instance.customers.create({
| 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`|
| fail_existing | string | If a customer with the same details already exists, the request throws an exception by default. Possible value is `1` or `0`|
| notes | object | A key-value pair |

**Response:**
Expand Down Expand Up @@ -126,8 +126,8 @@ instance.subscriptions.createRegistrationLink({
},
"receipt": "Receipt no. 1",
"expire_by": 1880480689,
"sms_notify": 1,
"email_notify": 1,
"sms_notify": true,
"email_notify": true,
"notes": {
"note_key 1": "Beam me up Scotty",
"note_key 2": "Tea. Earl Gray. Hot."
Expand All @@ -146,8 +146,8 @@ instance.subscriptions.createRegistrationLink({
| 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) |
| sms_notify | boolean | SMS notifications are to be sent by Razorpay (default : true) |
| email_notify | boolean | Email notifications are to be sent by Razorpay (default : true) |
| expire_by | integer | The timestamp, in Unix format, till when the customer can make the authorization payment. |
| notes | object | A key-value pair |

Expand Down Expand Up @@ -213,7 +213,7 @@ instance.payments.createRecurringPayment({
"order_id": "order_1Aa00000000002",
"customer_id": "cust_1Aa00000000001",
"token": "token_1Aa00000000001",
"recurring": "1",
"recurring": true,
"description": "Creating recurring payment for Gaurav Kumar",
"notes": {
"note_key 1": "Beam me up Scotty",
Expand All @@ -232,7 +232,7 @@ instance.payments.createRecurringPayment({
| 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` |
| recurring* | boolean | Possible values is `true` or `false` |
| description | string | A brief description of the payment. |
| notes | object | A key-value pair |

Expand Down
Loading
Loading