orbipay_paymentsapi_client package

Subpackages

• orbipay_paymentsapi_client.api package
  • Submodules
  • orbipay_paymentsapi_client.api.customer_account_api module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.api.customer_api module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.api.funding_account_api module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.api.payment_api module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.api.payment_authorization_api module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.api.payment_setup_api module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.api.refund_api module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • Module contents
• orbipay_paymentsapi_client.handlers package
  • Submodules
  • orbipay_paymentsapi_client.handlers.add_funding_account_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.cancel_payment_authorization_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.create_customer_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.create_payment_authorization_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.create_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.create_recurring_payment_setup_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.create_refund_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.delete_funding_account_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.delete_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.delete_payment_setup_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.delete_record_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.get_customer_account_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.get_customer_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.get_funding_account_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.get_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.get_payment_setup_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.get_refund_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.record_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.renew_customer_account_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.replace_funding_account_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_customer_accounts_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_customer_accounts_page_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_customers_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_customers_page_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_fee_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_funding_accounts_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_funding_accounts_page_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_payment_setups_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_payments_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.retrieve_refunds_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.simple_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.update_customer_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.update_funding_account_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.update_payment_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.handlers.update_payment_setup_handler module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • Module contents
• orbipay_paymentsapi_client.models package
  • Submodules
  • orbipay_paymentsapi_client.models.add_funding_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.address_vo module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.audit_info_vo module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.cancel_payment_authorization_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.create_customer_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.create_customer_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.create_payment_authorization_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.create_payment_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.create_payment_setup_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.create_refund_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_account_minimal_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_account_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_account_snapshot_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_accounts_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_minimal_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customer_snapshot_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customers_customer_accounts_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customers_funding_accounts_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customers_payment_setups_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customers_payments_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.customers_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.delete_funding_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.delete_payment_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.delete_payment_setup_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.delete_recorded_payment_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.delete_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.error_response_vo module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.error_vo module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.fee_refund_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.fee_refund_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.fee_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.fee_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.funding_account_address module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.funding_account_minimal_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.funding_account_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.funding_account_response_cgen module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.funding_account_snapshot_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.funding_accounts_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.get_recorded_payment_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_auth_customer_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_auth_customer_account_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_auth_customer_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_auth_customer_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_auth_funding_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_auth_funding_account_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_authorization_minimal_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_authorization_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_authorization_snapshot_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_network_response_vo module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_response_cgen module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_schedule_minimal_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_schedule_vo module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_setup_fee_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_setup_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_setup_response_cgen module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payment_setups_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.payments_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.record_payment_customer_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.record_payment_customer_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.record_payment_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.recorded_payment_funding_account module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.recorded_payment_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.recorded_payments_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.refund_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.refunds_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.renew_customer_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.replace_funding_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.resource_audit_vo module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.simple_payment_customer_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.simple_payment_customer_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.simple_payment_customer_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.simple_payment_funding_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.simple_payment_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.simple_payment_response module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.simple_payment_response_cgen module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.source_payment module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.source_payment_customer module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.source_payment_customer_account module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.update_customer_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.update_customer_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.update_funding_account_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.update_payment_funding_account_minimal_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.update_payment_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • orbipay_paymentsapi_client.models.update_payment_setup_request module
    • ## This class subject to change without prior notice, Please dont use this class directly.##
  • Module contents
• orbipay_paymentsapi_client.wrappers package
  • Submodules
  • orbipay_paymentsapi_client.wrappers.address module
  • orbipay_paymentsapi_client.wrappers.audit_info module
  • orbipay_paymentsapi_client.wrappers.base module
  • orbipay_paymentsapi_client.wrappers.customer module
  • orbipay_paymentsapi_client.wrappers.customer_account module
  • orbipay_paymentsapi_client.wrappers.customer_accounts module
  • orbipay_paymentsapi_client.wrappers.customers module
  • orbipay_paymentsapi_client.wrappers.error module
  • orbipay_paymentsapi_client.wrappers.error_response module
  • orbipay_paymentsapi_client.wrappers.fee module
  • orbipay_paymentsapi_client.wrappers.fee_payment module
  • orbipay_paymentsapi_client.wrappers.fee_refund module
  • orbipay_paymentsapi_client.wrappers.funding_account module
  • orbipay_paymentsapi_client.wrappers.funding_accounts module
  • orbipay_paymentsapi_client.wrappers.invocation_context module
  • orbipay_paymentsapi_client.wrappers.payment module
  • orbipay_paymentsapi_client.wrappers.payment_authorization module
  • orbipay_paymentsapi_client.wrappers.payment_network_response module
  • orbipay_paymentsapi_client.wrappers.payment_schedule module
  • orbipay_paymentsapi_client.wrappers.payment_setup module
  • orbipay_paymentsapi_client.wrappers.payment_setups module
  • orbipay_paymentsapi_client.wrappers.payments module
  • orbipay_paymentsapi_client.wrappers.recorded_payment module
  • orbipay_paymentsapi_client.wrappers.recorded_payments module
  • orbipay_paymentsapi_client.wrappers.refund module
  • orbipay_paymentsapi_client.wrappers.refunds module
  • orbipay_paymentsapi_client.wrappers.resource_audit module
  • orbipay_paymentsapi_client.wrappers.simple_payment module
  • orbipay_paymentsapi_client.wrappers.source_payment module
  • Module contents

Submodules

orbipay_paymentsapi_client.api_client module

## This class subject to change without prior notice, Please dont use this class directly.##

class orbipay_paymentsapi_client.api_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None)

Bases: object

Parameters

• configuration – .Configuration object for this client

• header_name – a header to pass when making calls to the API.

• header_value – a header value to pass when making calls to the API.

• cookie – a cookie to include in the header when making calls to the API

ENCODE_TYPE = 'utf-8'

NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}

PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)

VALID_REQUEST_HEADERS = {'X-OPAY-Headers', 'channel', 'client_key', 'idempotent_request_key', 'product', 'requestor', 'requestor_type', 'timestamp', 'trace_id'}

call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async request, set the async_req parameter.

Parameters

• resource_path – Path to method endpoint.

• method – Method to call.

• path_params – Path parameters in the url.

• query_params – Query parameters in the url.

• header_params – Header parameters to be placed in the request header.

• body – Request body.

• post_params – dict Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

• files – dict key -> filename, value -> filepath, for multipart/form-data.

• response_type – Response data type.

• auth_settings – list Auth Settings names for the request.

• async_req – bool execute request asynchronously

• _return_http_data_only – response data without head status code and headers

• collection_formats – dict of collection formats for path, query, header, and post parameters.

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.

compute_opay1_hmac_sha256_hash(path, method, query_params, header_params, form_params, body)

compute_opay2_hmac_sha256_hash(client_key, client_api_key, secret, timestamp)

static decrypt_encoded_data(secret, message)

deserialize(response, response_type)

Deserializes response into an object.

Parameters

• response – RESTResponse object to be deserialized.

• response_type – class literal for deserialized object, or string of class name.

Returns

deserialized object.

static get_connection_timeout_value()

static get_form_params_string(form_params)

static get_header_params_string(params)

static get_query_params_string(params)

static get_read_timeout_value()

static is_string_or_primitive(thing)

static is_valid_header(header)

static parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters

• params – Parameters as dict or list of two-tuples

• collection_formats (dict) – Parameter collection formats

Returns

Parameters as list of tuples, collections formatted

static prepare_post_parameters(post_params=None, files=None)

Builds form parameters.

Parameters

• post_params – Normal form parameters.

• files – File parameters.

Returns

Form parameters with files.

request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date

convert to string in iso8601 format.

If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.

Parameters

obj – The data to serialize.

Returns

The serialized form of data.

static select_header_accept(accepts)

Returns Accept based on an array of accepts provided.

Parameters

accepts – List of headers.

Returns

Accept (e.g. application/json).

static select_header_content_type(content_types)

Returns Content-Type based on an array of content_types provided.

Parameters

content_types – List of content-types.

Returns

Content-Type (e.g. application/json).

set_default_header(header_name, header_value)

update_params_for_auth(headers, querys, auth_settings)

Updates header and query params based on authentication setting.

Parameters

• headers – Header parameters dict to be updated.

• querys – Query parameters tuple list to be updated.

• auth_settings – Authentication setting identifiers list.

property user_agent

User agent for this API client

orbipay_paymentsapi_client.common_util module

## This class subject to change without prior notice, Please dont use this class directly.##

class orbipay_paymentsapi_client.common_util.CommonUtil

Bases: object

NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}

PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)

static deserialize(data, klass, input_type)

static get_masked_properties(data)

static get_sensitive_info()

static invocation_context(headers)

static is_json(json_string)

static mask_dict_data(data, sensitive_info)

static mask_list_data(data, sensitive_info)

static mask_object(data, visible_length)

static mask_string(data, visible_length)

static mask_tuple_data(data, sensitive_info)

static sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date

convert to string in iso8601 format.

If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.

Parameters

obj – The data to serialize.

Returns

The serialized form of data.

static time_stamp()

orbipay_paymentsapi_client.configuration module

## This class subject to change without prior notice, Please dont use this class directly.##

class orbipay_paymentsapi_client.configuration.Configuration

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually.

auth_settings()

Gets Auth Settings dict for api client.

Returns

The Auth Settings information dict.

property debug

Debug status

Type

bool

static default_api_client()

get_api_key_with_prefix(identifier)

Gets API key (with prefix if set).

Parameters

identifier – The identifier of apiKey.

Returns

The token for api key authentication.

get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns

The token for basic HTTP authentication.

property logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

Type

str

property logger_format

The logger format.

The logger_formatter will be updated when sets logger_format. :type: str

static to_debug_report()

Gets the essential information for debugging.

Returns

The report for debugging.

class orbipay_paymentsapi_client.configuration.TypeWithDefault(name, bases, dct)

Bases: type

set_default(default)

orbipay_paymentsapi_client.logger_util module

orbipay_paymentsapi_client.logger_util.log_debug(message)

orbipay_paymentsapi_client.logger_util.log_error(message)

orbipay_paymentsapi_client.logger_util.log_info(message)

orbipay_paymentsapi_client.logger_util.log_warn(message)

orbipay_paymentsapi_client.orbipay_api_exception module

exception orbipay_paymentsapi_client.orbipay_api_exception.OrbipayApiException(http_status_code=None, reason=None, api_exception=None, args=None)

Bases: Exception

property error_response

property http_status_code

property invocation_context

property is_timed_out

property reason

orbipay_paymentsapi_client.rest module

## This class subject to change without prior notice, Please dont use this class directly.##

exception orbipay_paymentsapi_client.rest.ApiException(status=None, reason=None, http_resp=None, masked_authorization_string=None, is_timed_out=None)

Bases: Exception

class orbipay_paymentsapi_client.rest.RESTClientObject(configuration, pools_size=4, maxsize=None)

Bases: object

delete(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

get(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

head(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

options(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

patch(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

post(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

put(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None, masked_authorization_string=None)

Perform requests.

Parameters

• method – http request method

• url – http request url

• query_params – query parameters in the url

• headers – http request headers

• body – request json body, for application/json

• post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data

• _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• masked_authorization_string – masked authorization string.

class orbipay_paymentsapi_client.rest.RESTResponse(resp)

Bases: io.IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

Module contents