bcgov / namex-payment-api-py-client

BC Registries Names-request payment-support
Apache License 2.0
0 stars 0 forks source link
citz

img

openapi-client

BC Registries Pay API reference documentation

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

Requirements.

Python 2.7 and 3.4+

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 openapi_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 openapi_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost"
)

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.FeesApi(api_client)
    corp_type = 'corp_type_example' # str | Corp Type
filing_type_code = 'filing_type_code_example' # str | Filing type code
jurisdiction = 'jurisdiction_example' # str | Jurisdiction or Province code (optional)
date = 'date_example' # str | Date on which the filing rates are applicable (optional)
priority = 'priority_example' # str | Indicator if priority fees are applicable (optional)

    try:
        # Calculate Fees
        api_response = api_instance.calculate_fees(corp_type, filing_type_code, jurisdiction=jurisdiction, date=date, priority=priority)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FeesApi->calculate_fees: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
FeesApi calculate_fees GET /api/v1/fees/{corp_type}/{filing_type_code} Calculate Fees
InvoicesApi get_invoice GET /api/v1/payment-requests/{payment_identifier}/invoices/{invoice_id} Get Invoice
InvoicesApi get_invoices GET /api/v1/payment-requests/{payment_identifier}/invoices Get Invoices
PaymentsApi create_payment POST /api/v1/payment-requests Create payment records
PaymentsApi get_payment GET /api/v1/payment-requests/{payment_identifier} Get Payment
PaymentsApi update_payment PUT /api/v1/payment-requests/{payment_identifier} Update payment records
ReceiptsApi get_receipt POST /api/v1/payment-requests/{payment_identifier}/receipts Get receipt for the payment
TransactionsApi create_transaction POST /api/v1/payment-requests/{payment_identifier}/transactions Create a transaction
TransactionsApi get_transaction GET /api/v1/payment-requests/{payment_identifier}/transactions/{transaction_identifier} Get Transaction
TransactionsApi get_transactions GET /api/v1/payment-requests/{payment_identifier}/transactions Get Transactions
TransactionsApi update_transaction PUT /api/v1/payment-requests/{payment_identifier}/transactions/{transaction_identifier} Update a transaction
DefaultApi delete_api_v1_payment_requests_payment_identifier DELETE /api/v1/payment-requests/{payment_identifier}

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author