btcpayserver/btcpay-python
btcpayserver/btcpay-python
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jeff Vandrew Jr 2019-07-24 13:38:17 -04:00 committed by GitHub
parent 820ab072ea
commit b18607fb1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -57,6 +57,13 @@ fetched_invoice = client.get_invoice(<invoice-id>)
```
The `fetched_invoice` above will be a dictionary of all invoice data from the Bitpay API. For instance, you can check the payment status with `fetched_invoice['status']`.
### Get a list of invoices matching certain parameters
```python
invoice_list = client.get_invoices(status='confirmed')
```
You can search by `status`, `order_id`, `date_start`, `date_end`, etc. See the method for a full list of parameters that can be passed to the method.
### Get rates
```python
client.get_rates()