Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/binance/binance-pay-connector-python
A lightweight library that works as a connector to Binance pay public API
https://github.com/binance/binance-pay-connector-python
binance binance-api binance-pay
Last synced: 3 months ago
JSON representation
A lightweight library that works as a connector to Binance pay public API
- Host: GitHub
- URL: https://github.com/binance/binance-pay-connector-python
- Owner: binance
- Created: 2021-10-20T06:02:37.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-23T21:22:24.000Z (over 1 year ago)
- Last Synced: 2024-09-18T20:54:22.264Z (5 months ago)
- Topics: binance, binance-api, binance-pay
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 15
- Watchers: 6
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Binance Pay Public API Connector Python
[](https://www.python.org/downloads/release/python-360/)
[](https://opensource.org/licenses/MIT)
This is a lightweight library that works as a connector to [Binance Pay public API](https://developers.binance.com/docs/binance-pay/introduction)
## Installation
```bash
pip install binance-pay-connector
```
## Documentation
[https://binance-pay-connector-python.readthedocs.io](https://binance-pay-connector-python.readthedocs.io)
## RESTful APIs
Usage examples:
```python
from binance.pay.merchant import Merchant as Client
# Setup merchant API from https://merchant.binance.com/en/dashboard/developers
client = Client(key='', secret='')
response = client.get_order(merchantTradeNo="")
# Get an order details
print(response)
```
Please find [examples](https://github.com/binance/binance-pay-connector-python/tree/master/examples/pay/merchant) folder to check for more endpoints.
### Optional parameters
PEP8 suggests _lowercase with words separated by underscores_, but for this connector,
the methods' optional parameters should follow their exact naming as in the API documentation.
```python
# Recognised parameter name
response = client.get_order(merchantTradeNo="2223")
# Unrecognised parameter name
response = client.get_order(merchant_trade_no="2223")
```
### Display logs
Setting the log level to `DEBUG` will log the request URL, payload and response text.
### Error
If a request has a parameter that is not provided but required from server, this library will throw an exception `binance.pay.error.ParameterRequiredError`, except the endpoint that is for creating order. `POST /binancepay/openapi/v2/order` that used to create order has complicate parameter strucuture, the library doesn't any mandatory parameter. Please see the example file for how to place an order.
## Test Case
```python
# In case packages are not installed yet
pip install -r requirements/requirements-test.txt
pytest
```
## Contributing
Contributions are welcome.
If you've found a bug within this project, please open an issue to discuss what you would like to change.
If it's an issue with the API, please open a topic at [Binance Developer Community](https://dev.binance.vision)