Metadata-Version: 2.4
Name: sirako_sdk
Version: 1.0.0
Summary: Sirako Merchant SDK API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Sirako Merchant SDK API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# sirako-sdk
Public endpoints for third-party merchant integrations.
Authenticate every request with the `X-API-Key` header.


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.24.0-SNAPSHOT
- 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 sirako_sdk
```

### 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 sirako_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import sirako_sdk
from sirako_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dev-sirako.fidelity-market.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sirako_sdk.Configuration(
    host = "https://dev-sirako.fidelity-market.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with sirako_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sirako_sdk.MerchantPayInApi(api_client)
    x_api_key = 'x_api_key_example' # str | 
    payment_id = 'payment_id_example' # str | 

    try:
        # Read a merchant pay-in
        api_response = api_instance.get_payment(x_api_key, payment_id)
        print("The response of MerchantPayInApi->get_payment:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MerchantPayInApi->get_payment: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://dev-sirako.fidelity-market.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*MerchantPayInApi* | [**get_payment**](docs/MerchantPayInApi.md#get_payment) | **GET** /api/v1/payments/{paymentId} | Read a merchant pay-in
*MerchantPayInApi* | [**get_payment_options**](docs/MerchantPayInApi.md#get_payment_options) | **GET** /api/v1/payments/options | Get available payment operators for a country
*MerchantPayInApi* | [**initiate**](docs/MerchantPayInApi.md#initiate) | **POST** /api/v1/payments/initiate | Initiate a merchant pay-in
*MerchantPayInApi* | [**submit_otp**](docs/MerchantPayInApi.md#submit_otp) | **POST** /api/v1/payments/{paymentId}/actions/otp | Submit a required OTP action


## Documentation For Models

 - [Customer](docs/Customer.md)
 - [MerchantPaymentRequest](docs/MerchantPaymentRequest.md)
 - [MerchantPaymentResponse](docs/MerchantPaymentResponse.md)
 - [NextAction](docs/NextAction.md)
 - [OtpActionRequest](docs/OtpActionRequest.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="apiKeyAuth"></a>
### apiKeyAuth

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


## Author




