loko-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2024-08-22
• Package version: 1.0.0
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://lokopay.io

Requirements.

Python 3.7+

Installation & Usage

pip install

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

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:

import loko_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import loko_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import loko_client
from loko_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.lokopay.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = loko_client.Configuration(
    host = "https://api.lokopay.io/v1"
)

# 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: publishableKeyAuth
configuration.api_key['publishableKeyAuth'] = os.environ["API_KEY"]

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


# Enter a context with an instance of the API client
with loko_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = loko_client.CustomerWalletsApi(api_client)
    create_customer_wallet_request = loko_client.CreateCustomerWalletRequest() # CreateCustomerWalletRequest | 

    try:
        # Create a customer wallet
        api_response = api_instance.create_customer_wallet(create_customer_wallet_request)
        print("The response of CustomerWalletsApi->create_customer_wallet:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CustomerWalletsApi->create_customer_wallet: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.lokopay.io/v1

Class	Method	HTTP request	Description
CustomerWalletsApi	create_customer_wallet	POST /customer_wallets	Create a customer wallet
NetworkfeesApi	get_network_fees	GET /networkfees	Get network fees
PaymentsApi	cancel_payment	POST /payments/{id}/cancel	Cancel payment
PaymentsApi	confirm_payment	POST /payments/{id}/confirm	Confirm payment
PaymentsApi	create_payment	POST /payments	Create a payment
PaymentsApi	get_payment	GET /payments/{id}	Get payment detail
PaymentsApi	get_payments	GET /payments	Get payments
PaymentsApi	refund_payment	POST /payments/{id}/refund	Refund payment
PayoutsApi	cancel_payout	POST /payouts/{id}/cancel	Cancel payout
PayoutsApi	confirm_payout	POST /payouts/{id}/confirm	Confirm payout
PayoutsApi	create_payout	POST /payouts	Create a payout
PayoutsApi	get_payout	GET /payouts/{id}	Get payout detail
PayoutsApi	get_payouts	GET /payouts	Get payouts

Documentation For Models

• BlockchainTransactionDetail
• ConfirmPaymentRequest
• ConfirmPayoutRequest
• CreateCustomerWalletRequest
• CreatePaymentRequest
• CreatePayoutRequest
• CryptoCurrency
• CustomerWallet
• DestinationNetworkDetail
• ErrorResponse
• GeneralResponse
• GetNetworkFees200Response
• GetPaymentsResponse
• GetPayoutsResponse
• Order
• OrderItem
• Payment
• PaymentCustomer
• Payout
• SuccessResponse
• TransferWithNativeToken
• WalletAddress

Documentation For Authorization

Authentication schemes defined for the API:

publishableKeyAuth

• Type: API key
• API key parameter name: loko-publishable-key
• Location: HTTP header

Author

dev@lokopay.io