Metadata-Version: 2.4
Name: ravex_partner_api
Version: 1.0.0
Summary: Ravex Partner API
Home-page: 
Author: Ravex Support
Author-email: Ravex Support <support@ravex.com>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Ravex Partner API
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# ravex-partner-api
Business-facing API for airtime, data, bills, betting, giftcards, and bank transfers.

## Wallet Model

Each business has two wallets:
- **NGN wallet** — powers all transactional services (airtime, data, electricity, cable, bet funding, giftcard buy/sell, bank transfer)
- **USD wallet** — reserved for the Dollar Card service (coming soon). Funded only by converting from the NGN wallet at the admin-configured rate. USD cannot be converted back to NGN.

Use `GET /balance` to check both wallet balances. Use `POST /wallet/convert-to-usd` to convert NGN → USD.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.25.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import ravex_partner_api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import ravex_partner_api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ravex_partner_api
from ravex_partner_api.rest import ApiException
from pprint import pprint

```

## Documentation for API Endpoints

All URIs are relative to *https://api.ravexapp.com/partner/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------


## Documentation For Models

 - [BalanceResponse](docs/BalanceResponse.md)
 - [BalanceResponseData](docs/BalanceResponseData.md)
 - [ServicesResponse](docs/ServicesResponse.md)
 - [ServicesResponseData](docs/ServicesResponseData.md)
 - [ServicesResponseDataServicesInner](docs/ServicesResponseDataServicesInner.md)
 - [TokenResponse](docs/TokenResponse.md)
 - [TokenResponseData](docs/TokenResponseData.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)

<a id="hmacAuth"></a>
### hmacAuth

- **Type**: API key
- **API key parameter name**: X-Ravex-Signature
- **Location**: HTTP header


## Author



