diff --git a/documents/card.md b/documents/card.md
index bb30cfb..17d097a 100644
--- a/documents/card.md
+++ b/documents/card.md
@@ -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."
@@ -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:**
@@ -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",
@@ -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 |
@@ -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",
@@ -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 |
diff --git a/documents/customer.md b/documents/customer.md
index 8b687ed..3d9c0c9 100644
--- a/documents/customer.md
+++ b/documents/customer.md
@@ -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",
@@ -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 |
diff --git a/documents/emandate.md b/documents/emandate.md
index a070962..884ad4d 100644
--- a/documents/emandate.md
+++ b/documents/emandate.md
@@ -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",
@@ -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 |
@@ -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."
@@ -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 |
@@ -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",
@@ -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:
* `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 c37c710..125e1bb 100644
--- a/documents/invoice.md
+++ b/documents/invoice.md
@@ -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
})
diff --git a/documents/order.md b/documents/order.md
index 9f3d16d..3e416d3 100644
--- a/documents/order.md
+++ b/documents/order.md
@@ -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. |
diff --git a/documents/papernach.md b/documents/papernach.md
index 871208a..a06d2f6 100644
--- a/documents/papernach.md
+++ b/documents/papernach.md
@@ -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",
@@ -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:**
@@ -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",
@@ -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 |
@@ -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",
@@ -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:
* `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 25badb1..f479d37 100644
--- a/documents/payment.md
+++ b/documents/payment.md
@@ -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
+ }
})
```
@@ -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",
@@ -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/` |
@@ -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/` |
diff --git a/documents/registerEmandate.md b/documents/registerEmandate.md
index 6244da3..5caf201 100644
--- a/documents/registerEmandate.md
+++ b/documents/registerEmandate.md
@@ -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",
@@ -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:**
@@ -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."
@@ -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 |
@@ -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",
@@ -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 |
diff --git a/documents/registerNach.md b/documents/registerNach.md
index ba4ed28..44c8ccd 100644
--- a/documents/registerNach.md
+++ b/documents/registerNach.md
@@ -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",
@@ -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:**
@@ -187,8 +187,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",
@@ -208,8 +208,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/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 @@ 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",
@@ -381,7 +381,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 |
diff --git a/documents/subscription.md b/documents/subscription.md
index b6254f7..d7620cb 100644
--- a/documents/subscription.md
+++ b/documents/subscription.md
@@ -7,7 +7,7 @@ instance.subscriptions.create({
"plan_id":"plan_00000000000001",
"total_count":6,
"quantity": 1,
- "customer_notify":1,
+ "customer_notify": true,
"start_at":1580453311,
"expire_by":1580626111,
"addons":[
@@ -84,7 +84,7 @@ instance.subscriptions.create({
"quantity": 1,
"start_at": 1561852800,
"expire_by": 1561939199,
- "customer_notify": 1,
+ "customer_notify": true,
"addons": [
{
"item": {
@@ -263,7 +263,12 @@ instance.subscriptions.fetch(subscriptionId)
### Cancel particular subscription
```js
-instance.subscriptions.cancel(subscriptionId,options)
+var subscriptionId = "sub_00000000000001";
+var options = {
+ "cancel_at_cycle_end": true
+}
+
+instance.subscriptions.cancel(subscriptionId,options);
```
**Parameters:**
@@ -271,7 +276,7 @@ instance.subscriptions.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
@@ -311,7 +316,18 @@ instance.subscriptions.cancel(subscriptionId,options)
### Update particular subscription
```js
-instance.subscriptions.update(subscriptionId,options)
+var subscriptionId = "sub_00000000000001";
+var options = {
+ "plan_id":"plan_00000000000002",
+ "offer_id":"offer_JHD834hjbxzhd38d",
+ "quantity":5,
+ "remaining_count":5,
+ "start_at":1496000432,
+ "schedule_change_at":"now",
+ "customer_notify": true
+}
+
+instance.subscriptions.update(subscriptionId,options);
```
**Parameters:**
@@ -658,7 +674,10 @@ instance.invoices.all({
### Delete offer linked to a subscription
```js
-instance.subscriptions.deleteOffer(subscriptionId, offerId)
+var subscriptionId = "sub_00000000000001";
+var offerId = "offer__00000000000001";
+
+instance.subscriptions.deleteOffer(subscriptionId, offerId);
```
**Parameters:**
diff --git a/documents/transfer.md b/documents/transfer.md
index 7ea2142..30c6a31 100644
--- a/documents/transfer.md
+++ b/documents/transfer.md
@@ -91,7 +91,7 @@ instance.orders.create({
"linked_account_notes": [
"branch"
],
- "on_hold": 1,
+ "on_hold": true,
"on_hold_until": 1671222870
},
{
@@ -105,7 +105,7 @@ instance.orders.create({
"linked_account_notes": [
"branch"
],
- "on_hold": 0
+ "on_hold": true
}
]
})
@@ -556,7 +556,7 @@ instance.transfers.fetchSettlements()
```js
instance.payments.refund(paymentId,{
"amount" : 100,
- "reverse_all" : 1
+ "reverse_all" : true
})
```
@@ -566,7 +566,7 @@ instance.payments.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
@@ -769,7 +769,7 @@ instance.payments.transfer(paymentId,{
### Modify settlement hold for transfers
```js
instance.transfers.edit(transferId,{
- "on_hold": "1",
+ "on_hold": true,
"on_hold_until": "1679691505"
})
```
@@ -779,7 +779,7 @@ instance.transfers.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 8bf70ac..216d2c7 100644
--- a/documents/upi.md
+++ b/documents/upi.md
@@ -20,7 +20,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:**
@@ -121,8 +121,8 @@ instance.subscriptions.createRegistrationLink({
"expire_at": 1634215992
},
"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",
@@ -480,7 +480,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",
@@ -500,7 +500,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:
* `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. |