razorpay 1.0.1

Razorpay Python Client

# Razorpay Python Client

[](https://pypi.python.org/pypi/razorpay) [](https://travis-ci.org/razorpay/razorpay-python) [](https://coveralls.io/github/razorpay/razorpay-python?branch=master) [](https://opensource.org/licenses/MIT)

Python bindings for interacting with the Razorpay API

This is primarily meant for merchants who wish to perform interactions with the Razorpay API programatically.

## Installation

```sh
$ pip install razorpay
```

## Usage

You need to setup your key and secret using the following:
You can find your API keys at <https://dashboard.razorpay.com/#/app/keys>.

```py
import razorpay
client = razorpay.Client(auth=("<YOUR_API_KEY>", "<YOUR_API_SECRET>"))
```

## App Details

After setting up client, you can set your app details before making any request
to Razorpay using the following:

```py
client.set_app_details({"title" : "<YOUR_APP_TITLE>", "version" : "<YOUR_APP_VERSION>"})
```

For example, you can set the title to `Django` and version to `1.8.17`. Please ensure
that both app title and version are strings.

### Payments

- Fetch all payments

```py
client.payment.all()
```

- Fetch a particular payment

```py
client.payment.fetch("<PAYMENT_ID>")
```

- Capture a payment

```py
client.payment.capture("<PAYMENT_ID>", "<AMOUNT>")
Note: <AMOUNT> should be same as the original amount while creating the payment
```

- Refund a payment

```py
client.payment.refund("<PAYMENT_ID>", "<AMOUNT>")
# for full refund

client.payment.refund("<PAYMENT_ID>", "<AMOUNT_TO_BE_REFUNDED>")
# for particular amount

Note: <AMOUNT_TO_BE_REFUNDED> should be equal/less than the original amount
```

### Refunds

- fetch a particular refund

```py
client.refund.fetch("<refund_id>")
```

- fetch all refunds

```py
client.refund.all()
```

### Orders

- Create a new order

```py
client.order.create(data=DATA)
DATA should contain these keys
amount : amount of order
currency : currency of order
receipt : receipt id of order
payment_capture : 1 if capture should be done automatically or else 0
notes(optional) : optional notes for order
```

- fetch a particular order

```py
client.order.fetch("<ORDER_ID>")
```

- fetch all orders

```py
client.order.all()
```

- fetch Payments of order

```py
client.order.payments("<ORDER_ID>")
```

### Invoices

- Create a new invoice

```py
client.invoice.create(data=DATA)
```
For List of params refer to this :-
https://docs.razorpay.com/v1/page/invoices#v1invoices


- fetch a particular invoice

```py
client.invoice.fetch("<INVOICE_ID>")
```

- fetch all invoices

```py
client.invoice.all()
```

### Card

- fetch a particular card data

```py
client.card.fetch(card_id=card_id)
```

### Customer

- fetch a particular customer Info

```py
client.customer.fetch(customer_id=customer_id)
```

- Create a customer

```py
client.customer.create(data=data)
```

- Edit a customer info

```py
client.customer.edit(customer_id=customer_id, data=data)
```

### Token

- fetch a token associated with a customer

```py
client.token.fetch(customer_id=customer_id, token_id=token_id)
```

- fetch all tokens associated with customer

```py
client.token.all(customer_id=customer_id)
```

- Delete a given token assicated with a customer

```py
client.token.delete(customer_id=customer_id, token_id=token_id)
```

### Utility

- Verify Payment Signature

```py
params_dict should have razorpay_order_id, razorpay_payment_id, razorpay_signature
which are received with the cord callback
client.utility.verify_payment_signature(params_dict)
```

- fetch all tokens associated with customer

```py
client.token.all(customer_id=customer_id)
```

- Delete a given token assicated with a customer

```py
client.token.delete(customer_id=customer_id, token_id=token_id)
```


## Bugs? Feature requests? Pull requests?

All of those are welcome. You can [file issues][issues] or [submit pull requests][pulls] in this repository.

[issues]: https://github.com/razorpay/razorpay-python/issues
[pulls]: https://github.com/razorpay/razorpay-python/pulls