Skip to content

order doc correction #205

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 1, 2022
Merged

order doc correction #205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27eb2ed
order doc correction
ankitdas13 Jun 14, 2022
89680fc
added partial payment param
ankitdas13 Jun 30, 2022
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
99 changes: 59 additions & 40 deletions documents/order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ client.order.create({
"amount": 50000,
"currency": "INR",
"receipt": "receipt#1",
"partial_payment":False,
"notes": {
"key1": "value3",
"key2": "value2"
Expand Down Expand Up @@ -61,6 +62,9 @@ client.order.all(option)
| skip | integer | number of orders to be skipped (default: 0) |
| authorized | boolean | Orders for which orders are currently in authorized state. |
| receipt | string | Orders with the provided value for receipt. |
| expand[] | string | Used to retrieve additional information about the payment. Possible value is `payments`,`payments.card`,`transfers` or `virtual_account` |
| authorized | boolean | Possible value is `0` or `1` |


**Response:**

Expand Down Expand Up @@ -103,25 +107,29 @@ client.order.fetch(orderId)

```json
{
"id":"order_DaaS6LOUAASb7Y",
"entity":"order",
"amount":2200,
"amount_paid":0,
"amount_due":2200,
"currency":"INR",
"receipt":"Receipt #211",
"status":"attempted",
"attempts":1,
"notes":[],
"created_at":1572505143
"id": "order_Jc81IZnaXSMLFh",
"entity": "order",
"amount": 50000,
"amount_paid": 50000,
"amount_due": 0,
"currency": "INR",
"receipt": null,
"offer_id": null,
"status": "paid",
"attempts": 1,
"notes": {
"notes_key_1": "value1",
"notes_key_2": "value2"
},
"created_at": 1654064215
}
```
-------------------------------------------------------------------------------------------------------

### Fetch payments for an order

```py
client.order.payment(orderId)
client.order.payments(orderId)
```
**Parameters**

Expand All @@ -132,35 +140,46 @@ client.order.payment(orderId)
**Response:**
```json
{
"entity":"collection",
"count":1,
"items":[
"entity": "collection",
"count": 1,
"items": [
{
"id":"pay_DaaSOvhgcOfzgR",
"entity":"payment",
"amount":2200,
"currency":"INR",
"status":"captured",
"order_id":"order_DaaS6LOUAASb7Y",
"invoice_id":null,
"international":false,
"method":"card",
"amount_refunded":0,
"refund_status":null,
"captured":true,
"description":"Beans in every imaginable flavour",
"card_id":"card_DZon6fd8J3IcA2",
"bank":null,
"wallet":null,
"vpa":null,
"email":"gaurav.kumar@example.com",
"contact":"+919999999988",
"notes":[],
"fee":44,
"tax":0,
"error_code":null,
"error_description":null,
"created_at":1572505160
"id": "pay_Jc81alhu5LmAUI",
"entity": "payment",
"amount": 50000,
"currency": "INR",
"status": "captured",
"order_id": "order_Jc81IZnaXSMLFh",
"invoice_id": "inv_Jc81IWvxf4TT1F",
"international": false,
"method": "upi",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": "Order # 2",
"card_id": null,
"bank": null,
"wallet": null,
"vpa": "success@razorpay",
"email": "sofiya.shaikh2@razorpay.com",
"contact": "+919702219003",
"customer_id": "cust_JR4BVKjKyJ7enk",
"token_id": "token_Jc81b6OBfodoi6",
"notes": {
"opencart_order_id": "2"
},
"fee": 1180,
"tax": 180,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"rrn": "001000100002",
"upi_transaction_id": "npci_txn_id_for_Jc81alhu5LmAUI"
},
"created_at": 1654064232
}
]
}
Expand Down