diff --git a/documents/card.md b/documents/card.md index 15f2b79..eb46179 100644 --- a/documents/card.md +++ b/documents/card.md @@ -6,7 +6,7 @@ client.customer.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." @@ -21,7 +21,7 @@ client.customer.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:** @@ -121,8 +121,8 @@ client.registration_link.create({ "expire_at":1644737663 }, "receipt":"Receipt No. #11", - "email_notify":1, - "sms_notify":1, + "email_notify": True, + "sms_notify": True, "expire_by":1644737663, "notes":{ "note_key 1":"Beam me up Scotty", @@ -141,8 +141,8 @@ client.registration_link.create({ | 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 (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 | @@ -279,7 +279,7 @@ client.payment.createRecurring({ "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", @@ -298,7 +298,7 @@ client.payment.createRecurring({ | 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 | @@ -581,7 +581,7 @@ client.card.requestCardReference({"number":"4854980604708430"}) | Name | Type | Description | |-------------|---------|------------------------------------------------------------------------------| | number* | string | The card number whose PAR or network reference id should be retrieved. | -| tokenised | string | Determines if the card is saved as a token. Possible value is `true` or `false` | +| tokenised | string | Determines if the card is saved as a token. Possible value is `True` or `False` | **Response:** ```json diff --git a/documents/customer.md b/documents/customer.md index 6df896e..aa9933a 100644 --- a/documents/customer.md +++ b/documents/customer.md @@ -6,7 +6,7 @@ client.customer.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", @@ -22,7 +22,7 @@ client.customer.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 | diff --git a/documents/emandate.md b/documents/emandate.md index 755b759..591039f 100644 --- a/documents/emandate.md +++ b/documents/emandate.md @@ -6,7 +6,7 @@ client.customer.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", @@ -22,7 +22,7 @@ client.customer.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:** @@ -126,8 +126,8 @@ client.registration_link.create({ }, "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." @@ -145,7 +145,8 @@ client.registration_link.create({ | 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) | +| sms_notify | boolean | SMS 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 | @@ -430,7 +431,7 @@ client.payment.createRecurring({ "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", @@ -450,7 +451,7 @@ client.payment.createRecurring({ | 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:
* `1` - Recurring is enabled.* `0` - Recurring is not enabled.| +| recurring* | string | Determines if recurring payment is enabled or not. Possible values:
* `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. | diff --git a/documents/invoice.md b/documents/invoice.md index 8a2f5bf..6aa6a97 100644 --- a/documents/invoice.md +++ b/documents/invoice.md @@ -39,8 +39,8 @@ client.invoice.create({ "quantity": 1 } ], - "sms_notify": 1, - "email_notify": 1, + "sms_notify": True, + "email_notify": True, "currency": "USD", "expire_by": 1589765167 }) diff --git a/documents/order.md b/documents/order.md index fb9695d..1b7c26d 100644 --- a/documents/order.md +++ b/documents/order.md @@ -275,7 +275,7 @@ client.order.edit(orderId,{ ### View RTO/Risk Reasons ```py -orderId = "order_DaaS6LOUAASb7Y"; +orderId = "order_DaaS6LOUAASb7Y" client.order.viewRtoReview(orderId) ``` diff --git a/documents/papernach.md b/documents/papernach.md index fcc5c7d..1a0931f 100644 --- a/documents/papernach.md +++ b/documents/papernach.md @@ -6,7 +6,7 @@ client.customer.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", @@ -23,7 +23,7 @@ client.customer.create({ | email | string | Email of the customer | | contact | string | Contact number of the customer | | notes | object | A key-value pair | -| 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`| **Response:** ```json @@ -188,8 +188,8 @@ client.registration_link.create({ "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", @@ -647,7 +647,7 @@ client.payment.createRecurring({ "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", @@ -667,7 +667,7 @@ client.payment.createRecurring({ | 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:
* `1` - Recurring is enabled.* `0` - Recurring is not enabled.| +| recurring* | string | Determines if recurring payment is enabled or not. Possible values:
* `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. | diff --git a/documents/payment.md b/documents/payment.md index 63661f8..5e809b6 100644 --- a/documents/payment.md +++ b/documents/payment.md @@ -410,19 +410,30 @@ client.order.create({ ```py client.payment.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 + } }) ``` @@ -498,7 +509,7 @@ client.payment.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", @@ -525,7 +536,7 @@ client.payment.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/` | @@ -573,7 +584,7 @@ client.payment.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/` | diff --git a/documents/paymentLink.md b/documents/paymentLink.md index 2360664..b599196 100644 --- a/documents/paymentLink.md +++ b/documents/paymentLink.md @@ -65,10 +65,10 @@ client.payment_link.create({ | Name | Type | Description | |-----------------|---------|------------------------------------------------------------------------------| -|upi_link* | boolean | boolean Must be set to true // to creating UPI Payment Link only | +|upi_link* | boolean | boolean Must be set to `True` // to creating UPI Payment Link only | |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values: true - Customer can make partial payments. false (default) - Customer cannot make partial payments. // UPI Payment Link is not supported partial payment | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values: `True` - Customer can make partial payments. `False` (default) - Customer cannot make partial payments. // UPI Payment Link is not supported partial payment | |description | string | A brief description of the Payment Link | |first_min_partial_amount | integer |Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. // UPI Payment Link is not supported partial payment | |reference_id | string | Reference number tagged to a Payment Link. | @@ -78,7 +78,7 @@ client.payment_link.create({ |notes | json object | Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty” | | callback_url | string | If specified, adds a redirect URL to the Payment Link. Once customers completes the payment, they are redirected to the specified URL. | | callback_method | string | If callback_url parameter is passed, callback_method must be passed with the value `get`. | -| reminder_enable | boolean | Used to send reminders for the Payment Link. Possible values is `true` or `false` | +| reminder_enable | boolean | Used to send reminders for the Payment Link. Possible values is `True` or `False` | **Response:** For create payment link response please click [here](https://razorpay.com/docs/api/payment-links/#create-payment-link) @@ -138,7 +138,7 @@ client.payment_link.edit(paymentLinkId, { | Name | Type | Description | |-----------------|---------|------------------------------------------------------------------------------| | paymentLinkId* | string | The unique identifier of the Payment Link that needs to be updated. | -| accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values: true - Customer can make partial payments. false (default) - Customer cannot make partial payments. | +| accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values: `True` - Customer can make partial payments. `False` (default) - Customer cannot make partial payments. | | reference_id | string | Adds a unique reference number to an existing link. | | expire_by | integer | Timestamp, in Unix format, when the payment links should expire. | | notes | string | object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”. | @@ -310,7 +310,7 @@ client.payment_link.create({ |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | |description | string | A brief description of the Payment Link | -|reference_id | string | AReference number tagged to a Payment Link. | +|reference_id | string | A Reference number tagged to a Payment Link. | |customer | array | name, email, contact | |expire_by | integer | Timestamp, in Unix, at which the Payment Link will expire. By default, a Payment Link will be valid for six months from the date of creation. | |notify | object | sms or email (boolean) | @@ -379,13 +379,13 @@ client.payment_link.create({ | Name | Type | Description | |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments. `False` (default) - Customer cannot make partial payments. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | |expire_by | integer | Timestamp, in Unix, at which the Payment Link will expire. By default, a Payment Link will be valid for six months from the date of creation. | |notify | object | sms or email (boolean) | -|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as false | +|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as `False` | **Response:** ```json @@ -483,7 +483,7 @@ client.payment_link.create({ | Name | Type | Description | |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments.`False` (default) - Customer cannot make partial payments. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | @@ -567,7 +567,7 @@ client.payment_link.create({ |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments.`False` (default) - Customer cannot make partial payments. | |first_min_partial_amount | integer |Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. // UPI Payment Link is not supported partial payment | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | @@ -655,12 +655,12 @@ client.payment_link.create({ |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments.`False` (default) - Customer cannot make partial payments. | |first_min_partial_amount | integer |Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. // UPI Payment Link is not supported partial payment | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | |notify | object | sms or email (boolean) | -|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as false | +|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as `False` | |options* | array | Options to customize Checkout. Parent parameter under which the checkout and prefill child parameters must be passed.| **Response:** @@ -690,10 +690,10 @@ client.payment_link.create({ "options": { "checkout": { "method": { - "netbanking": "1", - "card": "1", - "upi": "0", - "wallet": "0" + "netbanking": True, + "card": True, + "upi": False, + "wallet": False } } } @@ -706,12 +706,12 @@ client.payment_link.create({ |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments.`False` (default) - Customer cannot make partial payments. | |first_min_partial_amount | integer |Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. // UPI Payment Link is not supported partial payment | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | |notify | object | sms or email (boolean) | -|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as false | +|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as `False` | |options* | object | Options to display or hide payment methods on the Checkout section. Parent parameter under which the checkout and method child parameters must be passed.| **Response:** @@ -778,8 +778,8 @@ client.payment_link.create({ "options": { "checkout": { "readonly": { - "email": "1", - "contact": "1" + "email": True, + "contact": True } } } @@ -792,12 +792,12 @@ client.payment_link.create({ |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments.`False` (default) - Customer cannot make partial payments. | |first_min_partial_amount | integer |Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. // UPI Payment Link is not supported partial payment | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | |notify | object | sms or email (boolean) | -|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as false | +|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as `False` | |options* | object | Options to set contact and email as read-only fields on Checkout. Parent parameter under which the checkout and readonly child parameters must be passed.| **Response:** @@ -877,12 +877,12 @@ client.payment_link.create({ |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments.false (default) - Customer cannot make partial payments. | |first_min_partial_amount | integer |Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. // UPI Payment Link is not supported partial payment | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | |notify | object | sms or email (boolean) | -|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as false | +|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as `False` | |options* | object | Options to show or hide the top bar. Parent parameter under which the checkout and theme child parameters must be passed.| **Response:** @@ -964,12 +964,12 @@ client.payment_link.create({ |-----------------|---------|------------------------------------------------------------------------------| |amount* | integer | Amount to be paid using the Payment Link. | |currency | string | A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. | -|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:true - Customer can make partial payments.false (default) - Customer cannot make partial payments. | +|accept_partial | boolean | Indicates whether customers can make partial payments using the Payment Link. Possible values:`True` - Customer can make partial payments.`False` (default) - Customer cannot make partial payments. | |first_min_partial_amount | integer |Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. // UPI Payment Link is not supported partial payment | |description | string | A brief description of the Payment Link | |customer | object | name, email, contact | |notify | object | sms or email (boolean) | -|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as false | +|reminder_enable | boolean | To disable reminders for a Payment Link, pass reminder_enable as `False` | |options* | object | Parent parameter under which the hosted_page and label child parameters must be passed.| **Response:** diff --git a/documents/registerEmandate.md b/documents/registerEmandate.md index 7643841..cca3589 100644 --- a/documents/registerEmandate.md +++ b/documents/registerEmandate.md @@ -6,7 +6,7 @@ client.customer.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", @@ -22,7 +22,7 @@ client.customer.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:** @@ -127,8 +127,8 @@ client.registration_link.create({ }, "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." @@ -147,9 +147,9 @@ client.registration_link.create({ | 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/#12-using-a-registration-link) are supported | | 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.| -| 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) | +| 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.| +| 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 | @@ -215,7 +215,7 @@ client.payment.createRecurring({ "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", @@ -234,7 +234,7 @@ client.payment.createRecurring({ | 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 | diff --git a/documents/registerNach.md b/documents/registerNach.md index f1d74c5..afd1419 100644 --- a/documents/registerNach.md +++ b/documents/registerNach.md @@ -6,7 +6,7 @@ client.customer.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", @@ -22,7 +22,7 @@ client.customer.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:** @@ -187,8 +187,8 @@ client.payment.createRecurring({ } }, "receipt": "Receipt No. 5", - "email_notify": 1, - "sms_notify": 1, + "email_notify": True, + "sms_notify": True, "expire_by": 1634215992, "notes": { "note_key 1": "Beam me up Scotty", @@ -208,8 +208,8 @@ client.payment.createRecurring({ | description* | string | A brief description of the payment. | | subscription_registration | object | All keys listed [here](https://razorpay.com/docs/api/recurring-payments/paper-nach/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 | @@ -362,7 +362,7 @@ client.payment.createRecurring({ "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", @@ -381,7 +381,7 @@ client.payment.createRecurring({ | 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 | array | A key-value pair | diff --git a/documents/subscription.md b/documents/subscription.md index cd41069..6fafc58 100644 --- a/documents/subscription.md +++ b/documents/subscription.md @@ -5,7 +5,7 @@ ```py client.subscription.create({ "plan_id": "plan_7wAosPWtrkhqZw", - "customer_notify": 1, + "customer_notify": True, "quantity": 5, "total_count": 6, "start_at": 1495995837, @@ -81,7 +81,7 @@ client.subscription.create({ "total_count": 12, "quantity": 1, "expire_by": 1633237807, - "customer_notify": 1, + "customer_notify": True, "addons": [ { "item": { @@ -211,6 +211,8 @@ client.subscription.all(options) ### Fetch particular subscription ```py +subscriptionId = "sub_00000000000001" + client.subscription.fetch(subscriptionId) ``` @@ -259,6 +261,11 @@ client.subscription.fetch(subscriptionId) ### Cancel particular subscription ```py +subscriptionId = "sub_00000000000001" +options = { + "cancel_at_cycle_end": True +} + client.subscription.cancel(subscriptionId,options) ``` @@ -267,7 +274,7 @@ client.subscription.cancel(subscriptionId,options) | Name | Type | Description | |-------|-----------|--------------------------------------------------| | subscriptionId* | string | The id of the subscription to be cancelled | -| cancel_at_cycle_end | boolean | Possible values:
0 (default): Cancel the subscription immediately.
1: Cancel the subscription at the end of the current billing cycle. | +| cancel_at_cycle_end | boolean | Possible values:
False (default): Cancel the subscription immediately.
True: Cancel the subscription at the end of the current billing cycle. | **Response:** ```json @@ -307,6 +314,18 @@ client.subscription.cancel(subscriptionId,options) ### Update particular subscription ```py +subscriptionId = "sub_00000000000001" + +options = { + "plan_id":"plan_00000000000002", + "offer_id":"offer_JHD834hjbxzhd38d", + "quantity":5, + "remaining_count":5, + "start_at":1496000432, + "schedule_change_at":"now", + "customer_notify": True +} + client.subscription.update(subscriptionId,options) ``` @@ -356,6 +375,8 @@ client.subscription.update(subscriptionId,options) ### Fetch details of pending update ```py +subscriptionId = "sub_00000000000001" + client.subscription.pending_update(subscriptionId) ``` @@ -403,6 +424,8 @@ client.subscription.pending_update(subscriptionId) ### Cancel a update ```py +var subscriptionId = "sub_00000000000001" + client.subscription.cancel_scheduled_changes(subscriptionId) ``` @@ -450,6 +473,8 @@ client.subscription.cancel_scheduled_changes(subscriptionId) ### Pause a subscription ```py +subscriptionId = "sub_00000000000001" + client.subscription.pause(subscriptionId,{ "pause_at" : "now" }) @@ -501,6 +526,8 @@ client.subscription.pause(subscriptionId,{ ### Resume a subscription ```py +subscriptionId = "sub_00000000000001" + client.subscription.resume(subscriptionId,{ "resume_at" : "now" }) @@ -552,6 +579,8 @@ client.subscription.resume(subscriptionId,{ ### Fetch all invoices for a subscription ```py +subscriptionId = "sub_00000000000001" + client.invoice.all({ 'subscription_id':subscriptionId }) @@ -654,6 +683,9 @@ client.invoice.all({ ### Delete offer linked to a subscription ```py +subscriptionId = "sub_00000000000001" +offerId = "offer__00000000000001" + client.subscription.delete_offer(subscriptionId, offerId) ``` diff --git a/documents/transfer.md b/documents/transfer.md index f547b46..cfb5ed5 100644 --- a/documents/transfer.md +++ b/documents/transfer.md @@ -16,7 +16,7 @@ client.payment.fetch(paymentId,{ "linked_account_notes": [ "branch" ], - "on_hold": 1, + "on_hold": True, "on_hold_until": 1671222870 } ] @@ -86,7 +86,7 @@ client.order.create({ "linked_account_notes": [ "branch" ], - "on_hold": 1, + "on_hold": True, "on_hold_until": 1671222870 }, { @@ -100,7 +100,7 @@ client.order.create({ "linked_account_notes": [ "branch" ], - "on_hold": 0 + "on_hold": True } ] }) @@ -504,7 +504,7 @@ client.transfer.all({ ```py client.payment.refund(paymentId,{ "amount" : 100, - "reverse_all" : 1 + "reverse_all" : True }) ``` @@ -514,7 +514,7 @@ client.payment.refund(paymentId,{ |---------------|-------------|---------------------------------------------| | paymentId* | string | The id of the payment to be fetched | | amount* | integer | The amount to be captured (should be equal to the authorized amount, in paise) | -| reverse_all | boolean | Reverses transfer made to a linked account. Possible values:
* `1` - Reverses transfer made to a linked account.
* `0` - Does not reverse transfer made to a linked account.| +| reverse_all | boolean | Reverses transfer made to a linked account. Possible values:
* `True` - Reverses transfer made to a linked account.
* `False` - Does not reverse transfer made to a linked account.| **Response:** ```json @@ -635,13 +635,15 @@ client.transfer.reverse(transferId,{ ### Hold settlements for transfers ```py +paymentId = "pay_00000000000001" + client.payment.transfer(paymentId,{ "transfers": [ { "amount": 100, "account": "acc_CMaomTz4o0FOFz", "currency": "INR", - "on_hold": 1 + "on_hold": True } ] }) @@ -695,7 +697,7 @@ client.payment.transfer(paymentId,{ ### Modify settlement hold for transfers ```py client.transfer.edit(transferId,{ - "on_hold": "1", + "on_hold": True, "on_hold_until": "1679691505" }) ``` @@ -705,7 +707,7 @@ client.transfer.edit(transferId,{ | Name | Type | Description | |---------------|-------------|---------------------------------------------| | transferId* | string | The id of the payment to be fetched | -| on_hold* | boolean | Possible values is `0` or `1` | +| on_hold* | boolean | Possible values is `True` or `False` | | on_hold_until | integer | Timestamp, in Unix, that indicates until when the settlement of the transfer must be put on hold | **Response:** diff --git a/documents/upi.md b/documents/upi.md index a4aa0dd..0224f33 100644 --- a/documents/upi.md +++ b/documents/upi.md @@ -6,7 +6,7 @@ client.customer.create({ "name": "Gaurav Kumar", "contact": 9123456780, "email": "gaurav.kumar@example.com", - "fail_existing": 0, + "fail_existing": "1", "notes": { "notes_key_1": "Tea, Earl Grey, Hot", "notes_key_2": "Tea, Earl Grey… decaf." @@ -21,7 +21,7 @@ client.customer.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`|x` +| 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:** @@ -124,8 +124,8 @@ client.registration_link.create({ }, "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." @@ -143,8 +143,8 @@ client.registration_link.create({ | 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/upi/create-authorization-transaction/#121-create-a-registration-link) are supported | -| 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 | array | A key-value pair | @@ -483,7 +483,7 @@ client.payment.createRecurring({ "order_id": "order_1Aa00000000002", "customer_id": "cust_1Aa00000000001", "token": "token_1Aa00000000001", - "recurring": "1", + "recurring": True, "description": "Creating recurring payment for Gaurav Kumar", }) ``` @@ -499,7 +499,7 @@ client.payment.createRecurring({ | 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:
* `1` - Recurring is enabled.* `0` - Recurring is not enabled.| +| recurring* | string | Determines if recurring payment is enabled or not. Possible values:
* `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. |