PaymentApi.md

hyperstack.PaymentApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method	HTTP request	Description
get_details	GET /billing/payment/payment-details	GET: View payment details
post_payment	POST /billing/payment/payment-initiate	POST: Initiate payment

get_details

PaymentDetailsResponse get_details()

GET: View payment details

Example

• Api Key Authentication (apiKey):
• Api Key Authentication (accessToken):

import hyperstack
from hyperstack.models.payment_details_response import PaymentDetailsResponse
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/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: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

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

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

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

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.PaymentApi(api_client)

    try:
        # GET: View payment details
        api_response = api_instance.get_details()
        print("The response of PaymentApi->get_details:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_details: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PaymentDetailsResponse

Authorization

apiKey, accessToken

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_payment

PaymentInitiateResponse post_payment(payload)

POST: Initiate payment

Example

• Api Key Authentication (apiKey):
• Api Key Authentication (accessToken):

import hyperstack
from hyperstack.models.payment_initiate_payload import PaymentInitiatePayload
from hyperstack.models.payment_initiate_response import PaymentInitiateResponse
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/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: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

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

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

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

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.PaymentApi(api_client)
    payload = hyperstack.PaymentInitiatePayload() # PaymentInitiatePayload | 

    try:
        # POST: Initiate payment
        api_response = api_instance.post_payment(payload)
        print("The response of PaymentApi->post_payment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->post_payment: %s\n" % e)

Parameters

Name	Type	Description	Notes
payload	PaymentInitiatePayload

Return type

PaymentInitiateResponse

Authorization

apiKey, accessToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]