orbipay_paymentsapi_client.wrappers package¶

created_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Customer.

Return type

property custom_fields¶

Gets the custom_fields of this Customer. # noqa: E501 The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests. # noqa: E501

Returns: The custom_fields of this Customer.
Return type: dict(str, str)

property customer_accounts¶

Gets the customer_accounts of this Customer. # noqa: E501

Returns: The customer_accounts of this Customer.
Return type: CustomerAccounts

property customer_reference¶

Gets the customer_reference of this Customer. # noqa: E501 The unique identifier in the client system for the customer. # noqa: E501

Returns: The customer_reference of this Customer.
Return type: str

property date_of_birth¶

Gets the date_of_birth of this Customer. # noqa: E501 The date of birth of the customer. It should be in the full-date format as per ISO8601, namely, YYYY-MM-DD. # noqa: E501

Returns: The date_of_birth of this Customer.
Return type: str

property email¶

Gets the email of this Customer. # noqa: E501 The email address of the customer to which notifications from EBPP will be sent. This will default to the registered_email while creating a customer. # noqa: E501

Returns: The email of this Customer.
Return type: str

property first_name¶

Gets the first_name of this Customer. # noqa: E501 The first name of the customer. Either first_name or last_name is required to create a customer. # noqa: E501

Returns: The first_name of this Customer.
Return type: str

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of Customer.
Return type: Customer

property funding_accounts¶

Gets the funding_accounts of this Customer. # noqa: E501

Returns: The funding_accounts of this Customer.
Return type: FundingAccounts

property gender¶

Gets the gender of this Customer. # noqa: E501 The gender of the customer. # noqa: E501

Returns: The gender of this Customer.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Customer.

Return type

property home_phone¶

Gets the home_phone of this Customer. # noqa: E501 The home phone number of the customer. # noqa: E501

Returns: The home_phone of this Customer.
Return type: str

property id¶

Gets the id of this Customer. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id of this Customer.
Return type: str

property id_customer¶

Gets the id_customer of this Customer. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this Customer.
Return type: str

property last_name¶

Gets the last_name of this Customer. # noqa: E501 The last name of the customer. Either first_name or last_name is required to create a customer. # noqa: E501

Returns: The last_name of this Customer.
Return type: str

property locale¶

Gets the locale of this Customer. # noqa: E501 The language in which the customer wants the alerts and notifications from EBPP. This is to be specified in the format, < ISO-639-1 language code >_< ISO ALPHA-2 Country Code >. For e.g., en_US indicates the language preference as US English, which is also the default value. # noqa: E501

Returns: The locale of this Customer.
Return type: str

property middle_name¶

Gets the middle_name of this Customer. # noqa: E501 The middle name of the customer. # noqa: E501

Returns: The middle_name of this Customer.
Return type: str

property mobile_phone¶

Gets the mobile_phone of this Customer. # noqa: E501 The mobile phone number of the customer. # noqa: E501

Returns: The mobile_phone of this Customer.
Return type: str

property payment_setups¶

Gets the payment_setups of this Customer. # noqa: E501

Returns: The payment_setups of this Customer.
Return type: PaymentSetups

property payments¶

Gets the payments of this Customer. # noqa: E501

Returns: The payments of this Customer.
Return type: Payments

property registered_email¶

Gets the registered_email of this Customer. # noqa: E501 The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in EBPP. # noqa: E501

Returns: The registered_email of this Customer.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Customer.

Return type

property ssn¶

Gets the ssn of this Customer. # noqa: E501 The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. # noqa: E501

Returns: The ssn of this Customer.
Return type: str

property status¶

Gets the status of this Customer. # noqa: E501 The status of the customer in EBPP. # noqa: E501

Returns: The status of this Customer.
Return type: str

swagger_types = {'address': 'Address', 'audit_info': 'AuditInfo', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer_accounts': 'CustomerAccounts', 'customer_reference': 'str', 'date_of_birth': 'str', 'email': 'str', 'first_name': 'str', 'funding_accounts': 'FundingAccounts', 'gender': 'str', 'home_phone': 'str', 'id': 'str', 'id_customer': 'str', 'last_name': 'str', 'locale': 'str', 'middle_name': 'str', 'mobile_phone': 'str', 'payment_setups': 'PaymentSetups', 'payments': 'Payments', 'registered_email': 'str', 'ssn': 'str', 'status': 'str', 'url': 'str', 'work_phone': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

update(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Customer.

Return type

updated_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Customer.

Return type

property url¶

Gets the url of this Customer. # noqa: E501 This URL fetches the Customer details. # noqa: E501

Returns: The url of this Customer.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of Customer.
Return type: Customer

with_accounts(customer_accounts=None)¶

Parameters: customer_accounts – The customer_accounts is of type CustomerAccounts.
Returns: The Instance of Customer.
Return type: Customer

with_address(address=None)¶

Parameters: address – The address is of type Address.
Returns: The Instance of Customer.
Return type: Customer

with_contact_info(email=None, home_phone=None, work_phone=None, mobile_phone=None)¶

Parameters

email – The email is of type str.
home_phone – The home_phone is of type str.
work_phone – The work_phone is of type str.
mobile_phone – The mobile_phone is of type str.

Returns

The Instance of Customer.

Return type

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of Customer.
Return type: Customer

with_details(first_name=None, last_name=None, middle_name=None, date_of_birth=None, ssn=None, gender=None, registered_email=None)¶

Parameters

first_name – The first_name is of type str.
last_name – The last_name is of type str.
middle_name – The middle_name is of type str.
date_of_birth – The date_of_birth is of type str.
ssn – The ssn is of type str.
gender – The gender is of type str.
registered_email – The registered_email is of type str.

Returns

The Instance of Customer.

Return type

with_locale(locale=None)¶

Parameters: locale – The locale is of type str.
Returns: The Instance of Customer.
Return type: Customer

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of Customer.
Return type: Customer

with_reference(customer_reference=None)¶

Parameters: customer_reference – The customer_reference is of type str.
Returns: The Instance of Customer.
Return type: Customer

with_status(status=None)¶

Parameters: status – The status is of type str.
Returns: The Instance of Customer.
Return type: Customer

property work_phone¶

Gets the work_phone of this Customer. # noqa: E501 The work phone number of the customer. # noqa: E501

Returns: The work_phone of this Customer.
Return type: str

class orbipay_paymentsapi_client.wrappers.customer.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.customer_account module¶

class orbipay_paymentsapi_client.wrappers.customer_account.CustomerAccount(id_customer_account=None)¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property account_holder_name¶

Gets the account_holder_name of this CustomerAccount. # noqa: E501 The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this CustomerAccount.
Return type: str

property account_number¶

Gets the account_number of this CustomerAccount. # noqa: E501 The number or reference that a customer uses to identify the customer’s account. # noqa: E501

Returns: The account_number of this CustomerAccount.
Return type: str

property address¶

Gets the address of this CustomerAccount. # noqa: E501

Returns: The address of this CustomerAccount.
Return type: Address

attribute_map = {'account_holder_name': 'account_holder_name', 'account_number': 'account_number', 'address': 'address', 'audit_info': 'audit_info', 'comments': 'comments', 'current_balance': 'current_balance', 'current_statement_balance': 'current_statement_balance', 'custom_fields': 'custom_fields', 'customer_account_reference': 'customer_account_reference', 'id': 'id', 'id_customer': 'id_customer', 'id_customer_account': 'id_customer_account', 'minimum_payment_due': 'minimum_payment_due', 'nickname': 'nickname', 'past_amount_due': 'past_amount_due', 'payment_due_date': 'payment_due_date', 'statement_date': 'statement_date', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this CustomerAccount. # noqa: E501

Returns: The audit_info of this CustomerAccount.
Return type: AuditInfo

property comments¶

Gets the comments of this CustomerAccount. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this CustomerAccount.
Return type: str

property current_balance¶

Gets the current_balance of this CustomerAccount. # noqa: E501 The current balance on the customer’s account with the biller. # noqa: E501

Returns: The current_balance of this CustomerAccount.
Return type: str

property current_statement_balance¶

Gets the current_statement_balance of this CustomerAccount. # noqa: E501 The balance on the customer’s account with the biller as reported on the last statement. # noqa: E501

Returns: The current_statement_balance of this CustomerAccount.
Return type: str

property custom_fields¶

Gets the custom_fields of this CustomerAccount. # noqa: E501 The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests. # noqa: E501

Returns: The custom_fields of this CustomerAccount.
Return type: dict(str, str)

property customer_account_reference¶

Gets the customer_account_reference of this CustomerAccount. # noqa: E501 The unique identifier in the client system for the customer account. # noqa: E501

Returns: The customer_account_reference of this CustomerAccount.
Return type: str

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of CustomerAccount.

Return type

property id¶

Gets the id of this CustomerAccount. # noqa: E501 Id is a unique identifier assigned to the customer account in EBPP. # noqa: E501

Returns: The id of this CustomerAccount.
Return type: str

property id_customer¶

Gets the id_customer of this CustomerAccount. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this CustomerAccount.
Return type: str

property id_customer_account¶

Gets the id_customer_account of this CustomerAccount. # noqa: E501 The unique identifier assigned by EBPP to the Customer Account. # noqa: E501

Returns: The id_customer_account of this CustomerAccount.
Return type: str

property minimum_payment_due¶

Gets the minimum_payment_due of this CustomerAccount. # noqa: E501 The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account. # noqa: E501

Returns: The minimum_payment_due of this CustomerAccount.
Return type: str

property nickname¶

Gets the nickname of this CustomerAccount. # noqa: E501 The nickname by which a customer might want to identify the account. # noqa: E501

Returns: The nickname of this CustomerAccount.
Return type: str

property past_amount_due¶

Gets the past_amount_due of this CustomerAccount. # noqa: E501 The amount that is due from the past bills/statements on the customer’s account with the biller. # noqa: E501

Returns: The past_amount_due of this CustomerAccount.
Return type: str

property payment_due_date¶

Gets the payment_due_date of this CustomerAccount. # noqa: E501 The date by which the customer needs to clear the dues against the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_due_date of this CustomerAccount.
Return type: str

renew(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of CustomerAccount.

Return type

renewed_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of CustomerAccount.

Return type

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of CustomerAccount.

Return type

property statement_date¶

Gets the statement_date of this CustomerAccount. # noqa: E501 The date on which the biller generates the statement for the customer’s account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The statement_date of this CustomerAccount.
Return type: str

property status¶

Gets the status of this CustomerAccount. # noqa: E501 The status of the customer’s account in EBPP. # noqa: E501

Returns: The status of this CustomerAccount.
Return type: str

swagger_types = {'account_holder_name': 'str', 'account_number': 'str', 'address': 'Address', 'audit_info': 'AuditInfo', 'comments': 'str', 'current_balance': 'str', 'current_statement_balance': 'str', 'custom_fields': 'dict(str, str)', 'customer_account_reference': 'str', 'id': 'str', 'id_customer': 'str', 'id_customer_account': 'str', 'minimum_payment_due': 'str', 'nickname': 'str', 'past_amount_due': 'str', 'payment_due_date': 'str', 'statement_date': 'str', 'status': 'str', 'url': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property url¶

Gets the url of this CustomerAccount. # noqa: E501 This URL fetches the Account details. # noqa: E501

Returns: The url of this CustomerAccount.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

with_address(address=None)¶

Parameters: address – The address is of type Address.
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

with_balances(current_balance=None, current_statement_balance=None)¶

Parameters

current_balance – The current_balance is of type str.
current_statement_balance – The current_statement_balance is of type str.

Returns

The Instance of CustomerAccount.

Return type

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

with_details(account_holder_name=None, nickname=None, account_number=None, minimum_payment_due=None, past_amount_due=None, payment_due_date=None, statement_date=None)¶

Parameters

account_holder_name – The account_holder_name is of type str.
nickname – The nickname is of type str.
account_number – The account_number is of type str.
minimum_payment_due – The minimum_payment_due is of type str.
past_amount_due – The past_amount_due is of type str.
payment_due_date – The payment_due_date is of type str.
statement_date – The statement_date is of type str.

Returns

The Instance of CustomerAccount.

Return type

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

with_reference(customer_account_reference=None)¶

Parameters: customer_account_reference – The customer_account_reference is of type str.
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

with_status(status=None)¶

Parameters: status – The status is of type str.
Returns: The Instance of CustomerAccount.
Return type: CustomerAccount

class orbipay_paymentsapi_client.wrappers.customer_account.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.customer_accounts module¶

class orbipay_paymentsapi_client.wrappers.customer_accounts.CustomerAccounts¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property account_number¶

Gets the account_number of this CustomerAccounts. # noqa: E501 The Account Number to get details of. # noqa: E501

Returns: The account_number of this CustomerAccounts.
Return type: str

attribute_map = {'account_number': 'account_number', 'from_index': 'from_index', 'has_more_results': 'has_more_results', 'id_customer': 'id_customer', 'list': 'list', 'page_size': 'page_size', 'query_id': 'query_id', 'status': 'status', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

find_by(filter_parameters=None)¶

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of CustomerAccounts.
Return type: CustomerAccounts

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of CustomerAccounts.
Return type: CustomerAccounts

property from_index¶

Gets the from_index of this CustomerAccounts. # noqa: E501 The id of the object before which the previous set of objects are to be retrieved. # noqa: E501

Returns: The from_index of this CustomerAccounts.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of CustomerAccounts.

Return type

CustomerAccounts

get_page(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of CustomerAccounts.

Return type

CustomerAccounts

property has_more_results¶

Gets the has_more_results of this CustomerAccounts. # noqa: E501 true if there are more results or pages # noqa: E501

Returns: The has_more_results of this CustomerAccounts.
Return type: str

property id_customer¶

Gets the id_customer of this CustomerAccounts. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this CustomerAccounts.
Return type: str

property list¶

Gets the list of this CustomerAccounts. # noqa: E501

Returns: The list of this CustomerAccounts.
Return type: list[CustomerAccount]

property page_size¶

Gets the page_size of this CustomerAccounts. # noqa: E501 The maximum number of objects returned in the query. # noqa: E501

Returns: The page_size of this CustomerAccounts.
Return type: str

property query_id¶

Gets the query_id of this CustomerAccounts. # noqa: E501 The query id of the object. # noqa: E501

Returns: The query_id of this CustomerAccounts.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of CustomerAccounts.

Return type

CustomerAccounts

set_list(list=None)¶

Parameters: list – The list is of type list[CustomerAccount].
Returns: The Instance of CustomerAccounts.
Return type: CustomerAccounts

property status¶

Gets the status of this CustomerAccounts. # noqa: E501 The status of the customer’s account in EBPP. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The status of this CustomerAccounts.
Return type: list[str]

swagger_types = {'account_number': 'str', 'from_index': 'str', 'has_more_results': 'str', 'id_customer': 'str', 'list': 'list[CustomerAccount]', 'page_size': 'str', 'query_id': 'str', 'status': 'list[str]', 'to_index': 'str', 'total_results_count': 'str', 'url': 'str'}¶

to_dict()¶: Returns the model properties as a dict

property to_index¶

Gets the to_index of this CustomerAccounts. # noqa: E501 The id of the object after which the next set of objects are to be retrieved. # noqa: E501

Returns: The to_index of this CustomerAccounts.
Return type: str

to_str()¶: Returns the string representation of the model

property total_results_count¶

Gets the total_results_count of this CustomerAccounts. # noqa: E501 total number of Customer accounts of customer available with matching criteria # noqa: E501

Returns: The total_results_count of this CustomerAccounts.
Return type: str

property url¶

Gets the url of this CustomerAccounts. # noqa: E501 This URL fetches the next or previous set of customer accounts, based on the presence of after_object or before_object parameter. # noqa: E501

Returns: The url of this CustomerAccounts.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of CustomerAccounts.
Return type: CustomerAccounts

class orbipay_paymentsapi_client.wrappers.customer_accounts.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.customers module¶

class orbipay_paymentsapi_client.wrappers.customers.Customers¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property account_number¶

Gets the account_number of this Customers. # noqa: E501 Customer Account Number of the customer to get details of. # noqa: E501

Returns: The account_number of this Customers.
Return type: str

attribute_map = {'account_number': 'account_number', 'customer_reference': 'customer_reference', 'email': 'email', 'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'page_size': 'page_size', 'query_id': 'query_id', 'ssn': 'ssn', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property customer_reference¶

Gets the customer_reference of this Customers. # noqa: E501 Unique ID assigned by the biller/client system for a given customer. # noqa: E501

Returns: The customer_reference of this Customers.
Return type: str

property email¶

Gets the email of this Customers. # noqa: E501 This field contains the customer’s email address within EBPP. # noqa: E501

Returns: The email of this Customers.
Return type: str

find_by(filter_parameters=None)¶

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of Customers.
Return type: Customers

property from_index¶

Gets the from_index of this Customers. # noqa: E501 The id of the object before which the previous set of objects are to be retrieved. # noqa: E501

Returns: The from_index of this Customers.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Customers.

Return type

Customers

get_page(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Customers.

Return type

Customers

property has_more_results¶

Gets the has_more_results of this Customers. # noqa: E501 true if there are more results or pages # noqa: E501

Returns: The has_more_results of this Customers.
Return type: str

property list¶

Gets the list of this Customers. # noqa: E501

Returns: The list of this Customers.
Return type: list[Customer]

property page_size¶

Gets the page_size of this Customers. # noqa: E501 The maximum number of objects returned in the query. # noqa: E501

Returns: The page_size of this Customers.
Return type: str

property query_id¶

Gets the query_id of this Customers. # noqa: E501 The query id of the object. # noqa: E501

Returns: The query_id of this Customers.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Customers.

Return type

Customers

property ssn¶

Gets the ssn of this Customers. # noqa: E501 The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business. # noqa: E501

Returns: The ssn of this Customers.
Return type: str

swagger_types = {'account_number': 'str', 'customer_reference': 'str', 'email': 'str', 'from_index': 'str', 'has_more_results': 'str', 'list': 'list[Customer]', 'page_size': 'str', 'query_id': 'str', 'ssn': 'str', 'to_index': 'str', 'total_results_count': 'str', 'url': 'str'}¶

to_dict()¶: Returns the model properties as a dict

property to_index¶

Gets the to_index of this Customers. # noqa: E501 The id of the object after which the next set of objects are to be retrieved. # noqa: E501

Returns: The to_index of this Customers.
Return type: str

to_str()¶: Returns the string representation of the model

property total_results_count¶

Gets the total_results_count of this Customers. # noqa: E501 The total number of customers available matching the search criteria. # noqa: E501

Returns: The total_results_count of this Customers.
Return type: str

property url¶

Gets the url of this Customers. # noqa: E501 This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter. # noqa: E501

Returns: The url of this Customers.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of Customers.
Return type: Customers

class orbipay_paymentsapi_client.wrappers.customers.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.error module¶

class orbipay_paymentsapi_client.wrappers.error.Error¶

Bases: object

attribute_map = {'code': 'code', 'field': 'field', 'message': 'message'}¶

property code¶

Gets the code of this Error. # noqa: E501 A string indicating error # noqa: E501

Returns: The code of this Error.
Return type: str

property field¶

Gets the field of this Error. # noqa: E501 Refers to the field in the request, if the error is specific to it. # noqa: E501

Returns: The field of this Error.
Return type: str

property message¶

Gets the message of this Error. # noqa: E501 A human-readable message providing more details about the error. # noqa: E501

Returns: The message of this Error.
Return type: str

swagger_types = {'code': 'str', 'field': 'str', 'message': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

class orbipay_paymentsapi_client.wrappers.error.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.error_response module¶

class orbipay_paymentsapi_client.wrappers.error_response.ErrorResponse¶

Bases: object

attribute_map = {'errors': 'errors'}¶

property errors¶

Gets the errors of this ErrorResponse. # noqa: E501

Returns: The errors of this ErrorResponse.
Return type: list[Error]

swagger_types = {'errors': 'list[Error]'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

class orbipay_paymentsapi_client.wrappers.error_response.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.fee module¶

class orbipay_paymentsapi_client.wrappers.fee.Fee(fee_amount=None)¶

Bases: object

attribute_map = {'fee_amount': 'fee_amount', 'fee_type': 'fee_type', 'id': 'id', 'url': 'url'}¶

property fee_amount¶

Gets the fee_amount of this Fee. # noqa: E501 The fee amount upto 2 decimal places. # noqa: E501

Returns: The fee_amount of this Fee.
Return type: str

property fee_type¶

Gets the fee_type of this Fee. # noqa: E501 The way the fee is being charged to the customer. Fee could be added to the amount being paid, or, it could be charged separately by the biller. The fee_type would default to add_to_principal if the fee is not configured for the client in EBPP. # noqa: E501

Returns: The fee_type of this Fee.
Return type: str

property id¶

Gets the id of this Fee. # noqa: E501 The unique identifier assigned by EBPP to the fee. In case of split fee. # noqa: E501

Returns: The id of this Fee.
Return type: str

swagger_types = {'fee_amount': 'str', 'fee_type': 'str', 'id': 'str', 'url': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property url¶

Gets the url of this Fee. # noqa: E501 This URL fetches the details of fee as a payment resource. In case of split fee. # noqa: E501

Returns: The url of this Fee.
Return type: str

class orbipay_paymentsapi_client.wrappers.fee.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.fee_payment module¶

class orbipay_paymentsapi_client.wrappers.fee_payment.FeePayment(id_fee=None)¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property amount¶

Gets the amount of this FeePayment. # noqa: E501 The amount being paid. In case the payment_amount_type is ‘discounted_amount’, ‘penalty_amount’ or ‘other’, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. # noqa: E501

Returns: The amount of this FeePayment.
Return type: str

attribute_map = {'amount': 'amount', 'audit_info': 'audit_info', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'confirmation_number': 'confirmation_number', 'currency_code3d': 'currency_code3d', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'deleted': 'deleted', 'expected_payment_settlement_date': 'expected_payment_settlement_date', 'fee': 'fee', 'funding_account': 'funding_account', 'id': 'id', 'id_customer': 'id_customer', 'id_fee': 'id_fee', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_entry_date': 'payment_entry_date', 'payment_method': 'payment_method', 'payment_network_response': 'payment_network_response', 'payment_notification_email': 'payment_notification_email', 'payment_reference': 'payment_reference', 'payment_request_date': 'payment_request_date', 'payment_return_date': 'payment_return_date', 'payment_schedule_type': 'payment_schedule_type', 'return_code': 'return_code', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this FeePayment. # noqa: E501

Returns: The audit_info of this FeePayment.
Return type: AuditInfo

property card_cvv_number¶

Gets the card_cvv_number of this FeePayment. # noqa: E501 This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account. # noqa: E501

Returns: The card_cvv_number of this FeePayment.
Return type: str

property comments¶

Gets the comments of this FeePayment. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this FeePayment.
Return type: str

property confirmation_number¶

Gets the confirmation_number of this FeePayment. # noqa: E501 The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this FeePayment.
Return type: str

property currency_code3d¶

Gets the currency_code3d of this FeePayment. # noqa: E501 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD. # noqa: E501

Returns: The currency_code3d of this FeePayment.
Return type: str

property custom_fields¶

Gets the custom_fields of this FeePayment. # noqa: E501 The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. # noqa: E501

Returns: The custom_fields of this FeePayment.
Return type: dict(str, str)

property customer¶

Gets the customer of this FeePayment. # noqa: E501

Returns: The customer of this FeePayment.
Return type: Customer

property customer_account¶

Gets the customer_account of this FeePayment. # noqa: E501

Returns: The customer_account of this FeePayment.
Return type: CustomerAccount

property deleted¶

Gets the deleted of this FeePayment. # noqa: E501 The status of payment which says whether the payment is deleted or not # noqa: E501

Returns: The deleted of this FeePayment.
Return type: str

property expected_payment_settlement_date¶

Gets the expected_payment_settlement_date of this FeePayment. # noqa: E501 The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The expected_payment_settlement_date of this FeePayment.
Return type: str

property fee¶

Gets the fee of this FeePayment. # noqa: E501

Returns: The fee of this FeePayment.
Return type: Fee

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of FeePayment.
Return type: FeePayment

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of FeePayment.
Return type: FeePayment

from_account(funding_account=None)¶

Parameters: funding_account – The funding_account is of type FundingAccount.
Returns: The Instance of FeePayment.
Return type: FeePayment

property funding_account¶

Gets the funding_account of this FeePayment. # noqa: E501

Returns: The funding_account of this FeePayment.
Return type: FundingAccount

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FeePayment.

Return type

FeePayment

property id¶

Gets the id of this FeePayment. # noqa: E501 The unique identifier assigned by Orbipay to the payment. # noqa: E501

Returns: The id of this FeePayment.
Return type: str

property id_customer¶

Gets the id_customer of this FeePayment. # noqa: E501 The unique identifier assigned by OrbiPay to the customer. # noqa: E501

Returns: The id_customer of this FeePayment.
Return type: str

property id_fee¶

Gets the id_fee of this FeePayment. # noqa: E501 The unique identifier assigned by OrbiPay to the FeePayment. # noqa: E501

Returns: The id_fee of this FeePayment.
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this FeePayment. # noqa: E501 The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. # noqa: E501

Returns: The payment_amount_type of this FeePayment.
Return type: str

property payment_date¶

Gets the payment_date of this FeePayment. # noqa: E501 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_date of this FeePayment.
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this FeePayment. # noqa: E501 The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_entry_date of this FeePayment.
Return type: str

property payment_method¶

Gets the payment_method of this FeePayment. # noqa: E501 The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this FeePayment.
Return type: str

property payment_network_response¶

Gets the payment_network_response of this FeePayment. # noqa: E501

Returns: The payment_network_response of this FeePayment.
Return type: PaymentNetworkResponse

property payment_notification_email¶

Gets the payment_notification_email of this FeePayment. # noqa: E501 The email address to which notifications for the payment will be sent. The notifications will be sent to the customer’s email in case this is not provided. # noqa: E501

Returns: The payment_notification_email of this FeePayment.
Return type: str

property payment_reference¶

Gets the payment_reference of this FeePayment. # noqa: E501 The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this FeePayment.
Return type: str

property payment_request_date¶

Gets the payment_request_date of this FeePayment. # noqa: E501 The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. # noqa: E501

Returns: The payment_request_date of this FeePayment.
Return type: str

property payment_return_date¶

Gets the payment_return_date of this FeePayment. # noqa: E501 The date on which the ACH returns is received by Orbipay. # noqa: E501

Returns: The payment_return_date of this FeePayment.
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this FeePayment. # noqa: E501 The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this FeePayment.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of FeePayment.

Return type

FeePayment

property return_code¶

Gets the return_code of this FeePayment. # noqa: E501 The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. # noqa: E501

Returns: The return_code of this FeePayment.
Return type: str

property status¶

Gets the status of this FeePayment. # noqa: E501 The status of the payment. # noqa: E501

Returns: The status of this FeePayment.
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'Customer', 'customer_account': 'CustomerAccount', 'deleted': 'str', 'expected_payment_settlement_date': 'str', 'fee': 'Fee', 'funding_account': 'FundingAccount', 'id': 'str', 'id_customer': 'str', 'id_fee': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponse', 'payment_notification_email': 'str', 'payment_reference': 'str', 'payment_request_date': 'str', 'payment_return_date': 'str', 'payment_schedule_type': 'str', 'return_code': 'str', 'status': 'str', 'url': 'str'}¶

to_account(customer_account=None)¶

Parameters: customer_account – The customer_account is of type CustomerAccount.
Returns: The Instance of FeePayment.
Return type: FeePayment

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property url¶

Gets the url of this FeePayment. # noqa: E501 This URL fetches the details of payment. # noqa: E501

Returns: The url of this FeePayment.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of FeePayment.
Return type: FeePayment

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of FeePayment.
Return type: FeePayment

with_details(payment_amount_type=None, amount=None, payment_date=None, payment_request_date=None, card_cvv_number=None)¶

Parameters

payment_amount_type – The payment_amount_type is of type str.
amount – The amount is of type str.
payment_date – The payment_date is of type str.
payment_request_date – The payment_request_date is of type str.
card_cvv_number – The card_cvv_number is of type str.

Returns

The Instance of FeePayment.

Return type

FeePayment

with_fee(fee=None)¶

Parameters: fee – The fee is of type Fee.
Returns: The Instance of FeePayment.
Return type: FeePayment

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of FeePayment.
Return type: FeePayment

with_reference(payment_reference=None)¶

Parameters: payment_reference – The payment_reference is of type str.
Returns: The Instance of FeePayment.
Return type: FeePayment

with_status(status=None)¶

Parameters: status – The status is of type str.
Returns: The Instance of FeePayment.
Return type: FeePayment

class orbipay_paymentsapi_client.wrappers.fee_payment.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.fee_refund module¶

class orbipay_paymentsapi_client.wrappers.fee_refund.FeeRefund(fee_refund_amount=None)¶

Bases: object

attribute_map = {'fee_refund_amount': 'fee_refund_amount', 'fee_type': 'fee_type'}¶

property fee_refund_amount¶

Gets the fee_refund_amount of this FeeRefund. # noqa: E501 The refunded fee amount upto 2 decimal places. # noqa: E501

Returns: The fee_refund_amount of this FeeRefund.
Return type: str

property fee_type¶

Gets the fee_type of this FeeRefund. # noqa: E501 The way the fee is being charged to the customer. Fee could be added to the amount being paid, or, it could be charged separately by the biller. The fee_type would default to add_to_principal if the fee is not configured for the client in EBPP. # noqa: E501

Returns: The fee_type of this FeeRefund.
Return type: str

swagger_types = {'fee_refund_amount': 'str', 'fee_type': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

class orbipay_paymentsapi_client.wrappers.fee_refund.FinalClass(name, bases, classdict)¶: Bases: type

orbipay_paymentsapi_client.wrappers.funding_account module¶

class orbipay_paymentsapi_client.wrappers.funding_account.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.funding_account.FundingAccount(id_funding_account=None)¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property aba_routing_number¶

Gets the aba_routing_number of this FundingAccount. # noqa: E501 The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this FundingAccount.
Return type: str

property account_holder_name¶

Gets the account_holder_name of this FundingAccount. # noqa: E501 The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this FundingAccount.
Return type: str

property account_holder_type¶

Gets the account_holder_type of this FundingAccount. # noqa: E501 The type of ownership for the funding account. This is applicable only in the case of bank accounts and it is defaults to personal. # noqa: E501

Returns: The account_holder_type of this FundingAccount.
Return type: str

property account_number¶

Gets the account_number of this FundingAccount. # noqa: E501 The number or reference that a customer uses to identify the funding account. In case of Apple Pay, this is the device-specific account number of the card. # noqa: E501

Returns: The account_number of this FundingAccount.
Return type: str

property account_subtype¶

Gets the account_subtype of this FundingAccount. # noqa: E501 The sub type of the funding account. This is derived by Orbipay in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account. # noqa: E501

Returns: The account_subtype of this FundingAccount.
Return type: str

property account_type¶

Gets the account_type of this FundingAccount. # noqa: E501 The type of the funding account. # noqa: E501

Returns: The account_type of this FundingAccount.
Return type: str

property ach_eligible_flag¶

Gets the ach_eligible_flag of this FundingAccount. # noqa: E501 Indicates if the funding account can be debited vide ACH, in case the funding account is a Demand Deposit Account (DDA). # noqa: E501

Returns: The ach_eligible_flag of this FundingAccount.
Return type: str

property address¶

Gets the address of this FundingAccount. # noqa: E501

Returns: The address of this FundingAccount.
Return type: Address

property atm_eligible_flag¶

Gets the atm_eligible_flag of this FundingAccount. # noqa: E501 Indicates if the funding account can be debited vide the ATM Rail network, in case the funding account is a Debit Card. # noqa: E501

Returns: The atm_eligible_flag of this FundingAccount.
Return type: str

attribute_map = {'aba_routing_number': 'aba_routing_number', 'account_holder_name': 'account_holder_name', 'account_holder_type': 'account_holder_type', 'account_number': 'account_number', 'account_subtype': 'account_subtype', 'account_type': 'account_type', 'ach_eligible_flag': 'ach_eligible_flag', 'address': 'address', 'atm_eligible_flag': 'atm_eligible_flag', 'audit_info': 'audit_info', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'currency_code3d': 'currency_code3d', 'custom_fields': 'custom_fields', 'deleted': 'deleted', 'device_manufacturer_id': 'device_manufacturer_id', 'display_text': 'display_text', 'expiry_date': 'expiry_date', 'id': 'id', 'id_customer': 'id_customer', 'id_funding_account': 'id_funding_account', 'issuer_name': 'issuer_name', 'nickname': 'nickname', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this FundingAccount. # noqa: E501

Returns: The audit_info of this FundingAccount.
Return type: AuditInfo

property card_cvv_number¶

Gets the card_cvv_number of this FundingAccount. # noqa: E501 This is never returned by Orbipay. This needs to be passed to Orbipay when adding or editing a card funding account. # noqa: E501

Returns: The card_cvv_number of this FundingAccount.
Return type: str

property comments¶

Gets the comments of this FundingAccount. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this FundingAccount.
Return type: str

create(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FundingAccount.

Return type

created_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of FundingAccount.

Return type

property currency_code3d¶

Gets the currency_code3d of this FundingAccount. # noqa: E501 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD. # noqa: E501

Returns: The currency_code3d of this FundingAccount.
Return type: str

property custom_fields¶

Gets the custom_fields of this FundingAccount. # noqa: E501 The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. # noqa: E501

Returns: The custom_fields of this FundingAccount.
Return type: dict(str, str)

delete(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FundingAccount.

Return type

property deleted¶

Gets the deleted of this FundingAccount. # noqa: E501 The status of funding account which says whether the funding account is deleted or not # noqa: E501

Returns: The deleted of this FundingAccount.
Return type: str

deleted_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of FundingAccount.

Return type

property device_manufacturer_id¶

Gets the device_manufacturer_id of this FundingAccount. # noqa: E501 This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier. # noqa: E501

Returns: The device_manufacturer_id of this FundingAccount.
Return type: str

property display_text¶

Gets the display_text of this FundingAccount. # noqa: E501 UI representation of the account. # noqa: E501

Returns: The display_text of this FundingAccount.
Return type: str

property expiry_date¶

Gets the expiry_date of this FundingAccount. # noqa: E501 The expiry date for the card. This is to be in the format MM/YY. # noqa: E501

Returns: The expiry_date of this FundingAccount.
Return type: str

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FundingAccount.

Return type

property id¶

Gets the id of this FundingAccount. # noqa: E501 Id is a unique identifier assigned to the funding account in Orbipay. A new Id is generated for the funding account when the account number is updated. # noqa: E501

Returns: The id of this FundingAccount.
Return type: str

property id_customer¶

Gets the id_customer of this FundingAccount. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this FundingAccount.
Return type: str

property id_funding_account¶

Gets the id_funding_account of this FundingAccount. # noqa: E501 The unique identifier assigned by EBPP to the Funding Account. # noqa: E501

Returns: The id_funding_account of this FundingAccount.
Return type: str

property issuer_name¶

Gets the issuer_name of this FundingAccount. # noqa: E501 The name of the authority that has issued the account. This is relevant only in the case of bank accounts. # noqa: E501

Returns: The issuer_name of this FundingAccount.
Return type: str

property nickname¶

Gets the nickname of this FundingAccount. # noqa: E501 The nickname by which a customer might want to identify the account. # noqa: E501

Returns: The nickname of this FundingAccount.
Return type: str

replace(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FundingAccount.

Return type

replaced_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of FundingAccount.

Return type

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of FundingAccount.

Return type

property status¶

Gets the status of this FundingAccount. # noqa: E501 The status of the funding account in Orbipay. # noqa: E501

Returns: The status of this FundingAccount.
Return type: str

swagger_types = {'aba_routing_number': 'str', 'account_holder_name': 'str', 'account_holder_type': 'str', 'account_number': 'str', 'account_subtype': 'str', 'account_type': 'str', 'ach_eligible_flag': 'str', 'address': 'Address', 'atm_eligible_flag': 'str', 'audit_info': 'AuditInfo', 'card_cvv_number': 'str', 'comments': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'deleted': 'str', 'device_manufacturer_id': 'str', 'display_text': 'str', 'expiry_date': 'str', 'id': 'str', 'id_customer': 'str', 'id_funding_account': 'str', 'issuer_name': 'str', 'nickname': 'str', 'status': 'str', 'url': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

update(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FundingAccount.

Return type

updated_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of FundingAccount.

Return type

property url¶

Gets the url of this FundingAccount. # noqa: E501 This URL fetches the funding account details. # noqa: E501

Returns: The url of this FundingAccount.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

with_address(address=None)¶

Parameters: address – The address is of type Address.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of FundingAccount.
Return type: FundingAccount

with_details(account_holder_name=None, nickname=None, account_number=None, account_subtype=None, aba_routing_number=None, card_cvv_number=None, expiry_date=None, account_holder_type=None)¶

Parameters

account_holder_name – The account_holder_name is of type str.
nickname – The nickname is of type str.
account_number – The account_number is of type str.
account_subtype – The account_subtype is of type str.
aba_routing_number – The aba_routing_number is of type str.
card_cvv_number – The card_cvv_number is of type str.
expiry_date – The expiry_date is of type str.
account_holder_type – The account_holder_type is of type str.

Returns

The Instance of FundingAccount.

Return type

with_device_manufacturer_id(device_manufacturer_id=None)¶

Parameters: device_manufacturer_id – The device_manufacturer_id is of type str.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

with_display_text(display_text=None)¶

Parameters: display_text – The display_text is of type str.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

with_recorded_details(account_number=None, issuer_name=None)¶

Parameters

account_number – The account_number is of type str.
issuer_name – The issuer_name is of type str.

Returns

The Instance of FundingAccount.

Return type

with_status(status=None)¶

Parameters: status – The status is of type str.
Returns: The Instance of FundingAccount.
Return type: FundingAccount

orbipay_paymentsapi_client.wrappers.funding_accounts module¶

class orbipay_paymentsapi_client.wrappers.funding_accounts.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.funding_accounts.FundingAccounts¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property aba_routing_number¶

Gets the aba_routing_number of this FundingAccounts. # noqa: E501 The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this FundingAccounts.
Return type: str

property account_number¶

Gets the account_number of this FundingAccounts. # noqa: E501 The Account Number to get details of. # noqa: E501

Returns: The account_number of this FundingAccounts.
Return type: str

property account_subtype¶

Gets the account_subtype of this FundingAccounts. # noqa: E501 The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account. # noqa: E501

Returns: The account_subtype of this FundingAccounts.
Return type: str

property account_type¶

Gets the account_type of this FundingAccounts. # noqa: E501 The type of the funding account. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The account_type of this FundingAccounts.
Return type: list[str]

attribute_map = {'aba_routing_number': 'aba_routing_number', 'account_number': 'account_number', 'account_subtype': 'account_subtype', 'account_type': 'account_type', 'from_index': 'from_index', 'has_more_results': 'has_more_results', 'id_customer': 'id_customer', 'list': 'list', 'page_size': 'page_size', 'query_id': 'query_id', 'status': 'status', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

find_by(filter_parameters=None)¶

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of FundingAccounts.
Return type: FundingAccounts

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of FundingAccounts.
Return type: FundingAccounts

property from_index¶

Gets the from_index of this FundingAccounts. # noqa: E501 The id of the object before which the previous set of objects are to be retrieved. # noqa: E501

Returns: The from_index of this FundingAccounts.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FundingAccounts.

Return type

FundingAccounts

get_page(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of FundingAccounts.

Return type

FundingAccounts

property has_more_results¶

Gets the has_more_results of this FundingAccounts. # noqa: E501 true if there are more results or pages # noqa: E501

Returns: The has_more_results of this FundingAccounts.
Return type: str

property id_customer¶

Gets the id_customer of this FundingAccounts. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this FundingAccounts.
Return type: str

property list¶

Gets the list of this FundingAccounts. # noqa: E501

Returns: The list of this FundingAccounts.
Return type: list[FundingAccount]

property page_size¶

Gets the page_size of this FundingAccounts. # noqa: E501 The maximum number of objects returned in the query. # noqa: E501

Returns: The page_size of this FundingAccounts.
Return type: str

property query_id¶

Gets the query_id of this FundingAccounts. # noqa: E501 The query id of the object. # noqa: E501

Returns: The query_id of this FundingAccounts.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of FundingAccounts.

Return type

FundingAccounts

property status¶

Gets the status of this FundingAccounts. # noqa: E501 The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The status of this FundingAccounts.
Return type: list[str]

swagger_types = {'aba_routing_number': 'str', 'account_number': 'str', 'account_subtype': 'str', 'account_type': 'list[str]', 'from_index': 'str', 'has_more_results': 'str', 'id_customer': 'str', 'list': 'list[FundingAccount]', 'page_size': 'str', 'query_id': 'str', 'status': 'list[str]', 'to_index': 'str', 'total_results_count': 'str', 'url': 'str'}¶

to_dict()¶: Returns the model properties as a dict

property to_index¶

Gets the to_index of this FundingAccounts. # noqa: E501 The id of the object after which the next set of objects are to be retrieved. # noqa: E501

Returns: The to_index of this FundingAccounts.
Return type: str

to_str()¶: Returns the string representation of the model

property total_results_count¶

Gets the total_results_count of this FundingAccounts. # noqa: E501 The total number of funding accounts of the customer matching the search criteria. # noqa: E501

Returns: The total_results_count of this FundingAccounts.
Return type: str

property url¶

Gets the url of this FundingAccounts. # noqa: E501 This URL fetches the next or previous set of funding accounts, based on the presence of after_object or before_object parameter. # noqa: E501

Returns: The url of this FundingAccounts.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of FundingAccounts.
Return type: FundingAccounts

orbipay_paymentsapi_client.wrappers.invocation_context module¶

class orbipay_paymentsapi_client.wrappers.invocation_context.InvocationContext(secret=None, idempotent_request_key=None, x_opay_headers=None, api_key=None, auth_scheme=None, trace_id=None)¶

Bases: object

property api_key¶

attribute_map = {'api_key': 'api_key', 'auth_scheme': 'auth_scheme', 'channel': 'channel', 'client_key': 'client_key', 'idempotent_request_key': 'idempotent_request_key', 'product': 'product', 'request_uuid': 'request_uuid', 'requestor': 'requestor', 'requestor_type': 'requestor_type', 'response_codes': 'response_codes', 'response_text': 'response_text', 'secret': 'secret', 'timestamp': 'timestamp', 'trace_id': 'trace_id', 'x_opay_headers': 'x_opay_headers'}¶

property auth_scheme¶

property channel¶

property client_key¶

property idempotent_request_key¶

property product¶

property request_uuid¶

property requestor¶

property requestor_type¶

property response_codes¶

property response_text¶

property secret¶

swagger_types = {'api_key': 'String', 'auth_scheme': 'String', 'channel': 'str', 'client_key': 'str', 'idempotent_request_key': 'str', 'product': 'str', 'request_uuid': 'str', 'requestor': 'str', 'requestor_type': 'str', 'response_codes': 'str', 'response_text': 'str', 'secret': 'String', 'timestamp': 'str', 'trace_id': 'str', 'x_opay_headers': 'str'}¶

property timestamp¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property trace_id¶

property x_opay_headers¶

orbipay_paymentsapi_client.wrappers.payment module¶

class orbipay_paymentsapi_client.wrappers.payment.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.payment.Payment(id_payment=None)¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property amount¶

Gets the amount of this Payment. # noqa: E501 The amount being paid. In case the payment_amount_type is ‘discounted_amount’, ‘penalty_amount’ or ‘other’, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. # noqa: E501

Returns: The amount of this Payment.
Return type: str

attribute_map = {'amount': 'amount', 'audit_info': 'audit_info', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'confirmation_number': 'confirmation_number', 'currency_code3d': 'currency_code3d', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'deleted': 'deleted', 'expected_payment_settlement_date': 'expected_payment_settlement_date', 'fee': 'fee', 'funding_account': 'funding_account', 'id': 'id', 'id_customer': 'id_customer', 'id_payment': 'id_payment', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_entry_date': 'payment_entry_date', 'payment_method': 'payment_method', 'payment_network_response': 'payment_network_response', 'payment_notification_email': 'payment_notification_email', 'payment_reference': 'payment_reference', 'payment_request_date': 'payment_request_date', 'payment_return_date': 'payment_return_date', 'payment_schedule_type': 'payment_schedule_type', 'return_code': 'return_code', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this Payment. # noqa: E501

Returns: The audit_info of this Payment.
Return type: AuditInfo

property card_cvv_number¶

Gets the card_cvv_number of this Payment. # noqa: E501 This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment with a card funding account. # noqa: E501

Returns: The card_cvv_number of this Payment.
Return type: str

property comments¶

Gets the comments of this Payment. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this Payment.
Return type: str

property confirmation_number¶

Gets the confirmation_number of this Payment. # noqa: E501 The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this Payment.
Return type: str

create(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Payment.

Return type

created_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Payment.

Return type

property currency_code3d¶

Gets the currency_code3d of this Payment. # noqa: E501 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD. # noqa: E501

Returns: The currency_code3d of this Payment.
Return type: str

property custom_fields¶

Gets the custom_fields of this Payment. # noqa: E501 The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. # noqa: E501

Returns: The custom_fields of this Payment.
Return type: dict(str, str)

property customer¶

Gets the customer of this Payment. # noqa: E501

Returns: The customer of this Payment.
Return type: Customer

property customer_account¶

Gets the customer_account of this Payment. # noqa: E501

Returns: The customer_account of this Payment.
Return type: CustomerAccount

delete(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Payment.

Return type

property deleted¶

Gets the deleted of this Payment. # noqa: E501 The status of payment which says whether the payment is deleted or not # noqa: E501

Returns: The deleted of this Payment.
Return type: str

deleted_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Payment.

Return type

property expected_payment_settlement_date¶

Gets the expected_payment_settlement_date of this Payment. # noqa: E501 The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The expected_payment_settlement_date of this Payment.
Return type: str

property fee¶

Gets the fee of this Payment. # noqa: E501

Returns: The fee of this Payment.
Return type: Fee

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of Payment.
Return type: Payment

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of Payment.
Return type: Payment

from_account(funding_account=None)¶

Parameters: funding_account – The funding_account is of type FundingAccount.
Returns: The Instance of Payment.
Return type: Payment

property funding_account¶

Gets the funding_account of this Payment. # noqa: E501

Returns: The funding_account of this Payment.
Return type: FundingAccount

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Payment.

Return type

property id¶

Gets the id of this Payment. # noqa: E501 The unique identifier assigned by Orbipay to the payment. # noqa: E501

Returns: The id of this Payment.
Return type: str

property id_customer¶

Gets the id_customer of this Payment. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this Payment.
Return type: str

property id_payment¶

Gets the id_payment of this Payment. # noqa: E501 The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id_payment of this Payment.
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this Payment. # noqa: E501 The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. # noqa: E501

Returns: The payment_amount_type of this Payment.
Return type: str

property payment_date¶

Gets the payment_date of this Payment. # noqa: E501 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_date of this Payment.
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this Payment. # noqa: E501 The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_entry_date of this Payment.
Return type: str

property payment_method¶

Gets the payment_method of this Payment. # noqa: E501 The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this Payment.
Return type: str

property payment_network_response¶

Gets the payment_network_response of this Payment. # noqa: E501

Returns: The payment_network_response of this Payment.
Return type: PaymentNetworkResponse

property payment_notification_email¶

Gets the payment_notification_email of this Payment. # noqa: E501 The email address to which notifications for the payment will be sent. The notifications will be sent to the customer’s email in case this is not provided. # noqa: E501

Returns: The payment_notification_email of this Payment.
Return type: str

property payment_reference¶

Gets the payment_reference of this Payment. # noqa: E501 The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this Payment.
Return type: str

property payment_request_date¶

Gets the payment_request_date of this Payment. # noqa: E501 The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. # noqa: E501

Returns: The payment_request_date of this Payment.
Return type: str

property payment_return_date¶

Gets the payment_return_date of this Payment. # noqa: E501 The date on which the ACH returns is received by Orbipay. # noqa: E501

Returns: The payment_return_date of this Payment.
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this Payment. # noqa: E501 The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this Payment.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Payment.

Return type

property return_code¶

Gets the return_code of this Payment. # noqa: E501 The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. # noqa: E501

Returns: The return_code of this Payment.
Return type: str

property status¶

Gets the status of this Payment. # noqa: E501 The status of the payment. # noqa: E501

Returns: The status of this Payment.
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'Customer', 'customer_account': 'CustomerAccount', 'deleted': 'str', 'expected_payment_settlement_date': 'str', 'fee': 'Fee', 'funding_account': 'FundingAccount', 'id': 'str', 'id_customer': 'str', 'id_payment': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponse', 'payment_notification_email': 'str', 'payment_reference': 'str', 'payment_request_date': 'str', 'payment_return_date': 'str', 'payment_schedule_type': 'str', 'return_code': 'str', 'status': 'str', 'url': 'str'}¶

to_account(customer_account=None)¶

Parameters: customer_account – The customer_account is of type CustomerAccount.
Returns: The Instance of Payment.
Return type: Payment

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

update(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Payment.

Return type

updated_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Payment.

Return type

property url¶

Gets the url of this Payment. # noqa: E501 This URL fetches the details of payment. # noqa: E501

Returns: The url of this Payment.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of Payment.
Return type: Payment

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of Payment.
Return type: Payment

with_details(payment_amount_type=None, amount=None, payment_date=None, payment_request_date=None, card_cvv_number=None)¶

Parameters

payment_amount_type – The payment_amount_type is of type str.
amount – The amount is of type str.
payment_date – The payment_date is of type str.
payment_request_date – The payment_request_date is of type str.
card_cvv_number – The card_cvv_number is of type str.

Returns

The Instance of Payment.

Return type

with_fee(fee=None)¶

Parameters: fee – The fee is of type Fee.
Returns: The Instance of Payment.
Return type: Payment

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of Payment.
Return type: Payment

with_payment_notification_email(payment_notification_email=None)¶

Parameters: payment_notification_email – The payment_notification_email is of type str.
Returns: The Instance of Payment.
Return type: Payment

with_reference(payment_reference=None)¶

Parameters: payment_reference – The payment_reference is of type str.
Returns: The Instance of Payment.
Return type: Payment

with_status(status=None)¶

Parameters: status – The status is of type str.
Returns: The Instance of Payment.
Return type: Payment

orbipay_paymentsapi_client.wrappers.payment_network_response module¶

class orbipay_paymentsapi_client.wrappers.payment_network_response.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.payment_network_response.PaymentNetworkResponse¶

Bases: object

attribute_map = {'payment_auth_code': 'payment_auth_code', 'payment_response_code': 'payment_response_code', 'payment_response_msg': 'payment_response_msg'}¶

property payment_auth_code¶

Gets the payment_auth_code of this PaymentNetworkResponse. # noqa: E501 The Auth Code returned by the card gateway. This is relevant only for card payments. # noqa: E501

Returns: The payment_auth_code of this PaymentNetworkResponse.
Return type: str

property payment_response_code¶

Gets the payment_response_code of this PaymentNetworkResponse. # noqa: E501 This is the ACH return code in the case of a returned payment over the NACHA ACH network. In the case of declined card payment, it’s the decline code received from the card issuer or the card processor. In the case of a card chargeback, it’s the chargeback code received from the card network. # noqa: E501

Returns: The payment_response_code of this PaymentNetworkResponse.
Return type: str

property payment_response_msg¶

Gets the payment_response_msg of this PaymentNetworkResponse. # noqa: E501 The text describing the appropriate code captured in the payment_response_code as received from the corresponding payment network. # noqa: E501

Returns: The payment_response_msg of this PaymentNetworkResponse.
Return type: str

swagger_types = {'payment_auth_code': 'str', 'payment_response_code': 'str', 'payment_response_msg': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

orbipay_paymentsapi_client.wrappers.payment_schedule module¶

class orbipay_paymentsapi_client.wrappers.payment_schedule.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.payment_schedule.PaymentSchedule(payment_recurring_type=None, payment_recurring_count=None, payment_amount_type=None, payment_start_date=None, payment_end_date=None, payment_limit_amount=None, payment_plan_id=None, payment_defer_days=None)¶

Bases: object

attribute_map = {'payment_amount_type': 'payment_amount_type', 'payment_defer_days': 'payment_defer_days', 'payment_end_date': 'payment_end_date', 'payment_limit_amount': 'payment_limit_amount', 'payment_plan_id': 'payment_plan_id', 'payment_recurring_count': 'payment_recurring_count', 'payment_recurring_type': 'payment_recurring_type', 'payment_start_date': 'payment_start_date'}¶

property payment_amount_type¶

Gets the payment_amount_type of this PaymentSchedule. # noqa: E501 The amount type that is used to set the amount for payments created as part of a recurring payment or autopay setup. In the case of a recurring payment setup, the payment amount can be specified by the customer. In that case, the payment_amount_type should not be sent as it would default to ‘other’. In the case of an autopay setup, the payment amount type is mandatory and it cannot be specified as ‘other’. In this case, the payment amount should not be sent. # noqa: E501

Returns: The payment_amount_type of this PaymentSchedule.
Return type: str

property payment_defer_days¶

Gets the payment_defer_days of this PaymentSchedule. # noqa: E501 The number of days from the bill due date that the customer wishes to delay the autopay payment by. By default an autopay payment is drafted on the bill due date. # noqa: E501

Returns: The payment_defer_days of this PaymentSchedule.
Return type: str

property payment_end_date¶

Gets the payment_end_date of this PaymentSchedule. # noqa: E501 The date by which the last payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This cannot be specified for autopay setups. # noqa: E501

Returns: The payment_end_date of this PaymentSchedule.
Return type: str

property payment_limit_amount¶

Gets the payment_limit_amount of this PaymentSchedule. # noqa: E501 The upper limit for the payment amount in the case of recurring or autopay payments. Any amount above the limit will not be paid automatically as part of recurring payments and autopay. # noqa: E501

Returns: The payment_limit_amount of this PaymentSchedule.
Return type: str

property payment_plan_id¶

Gets the payment_plan_id of this PaymentSchedule. # noqa: E501 The reference to the payment plan, offered by the biller, that is used to set up the recurring payment. The list of payment plans offered is published as part of the biller set-up. # noqa: E501

Returns: The payment_plan_id of this PaymentSchedule.
Return type: str

property payment_recurring_count¶

Gets the payment_recurring_count of this PaymentSchedule. # noqa: E501 The maximum number of payments that can be created as part of a recurring payment setup. This cannot be specified for autopay setups. # noqa: E501

Returns: The payment_recurring_count of this PaymentSchedule.
Return type: str

property payment_recurring_type¶

Gets the payment_recurring_type of this PaymentSchedule. # noqa: E501 The frequency of the payments created as part of a payment setup. This is applicable only for recurring payment setup, in which case it is mandatory. # noqa: E501

Returns: The payment_recurring_type of this PaymentSchedule.
Return type: str

property payment_start_date¶

Gets the payment_start_date of this PaymentSchedule. # noqa: E501 The date on which the first payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This is mandatory for recurring payment setup. This cannot be specified for autopay setups. # noqa: E501

Returns: The payment_start_date of this PaymentSchedule.
Return type: str

swagger_types = {'payment_amount_type': 'str', 'payment_defer_days': 'str', 'payment_end_date': 'str', 'payment_limit_amount': 'str', 'payment_plan_id': 'str', 'payment_recurring_count': 'str', 'payment_recurring_type': 'str', 'payment_start_date': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

with_payment_limit_amount(payment_limit_amount=None)¶

Parameters: payment_limit_amount – The payment_limit_amount is of type str.
Returns: The Instance of PaymentSchedule.
Return type: PaymentSchedule

orbipay_paymentsapi_client.wrappers.payment_setup module¶

class orbipay_paymentsapi_client.wrappers.payment_setup.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.payment_setup.PaymentSetup(id_payment_setup=None)¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property amount¶

Gets the amount of this PaymentSetup. # noqa: E501 The amount being paid. In case the payment_amount_type is ‘discounted_amount’, ‘penalty_amount’ or ‘other’, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. # noqa: E501

Returns: The amount of this PaymentSetup.
Return type: str

attribute_map = {'amount': 'amount', 'audit_info': 'audit_info', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'confirmation_number': 'confirmation_number', 'currency_code3d': 'currency_code3d', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'deleted': 'deleted', 'fee': 'fee', 'funding_account': 'funding_account', 'id': 'id', 'id_customer': 'id_customer', 'id_payment_setup': 'id_payment_setup', 'next_payment_date': 'next_payment_date', 'payment_method': 'payment_method', 'payment_network_response': 'payment_network_response', 'payment_schedule': 'payment_schedule', 'payment_setup_entry_date': 'payment_setup_entry_date', 'payment_setup_reference': 'payment_setup_reference', 'payment_setup_schedule_type': 'payment_setup_schedule_type', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this PaymentSetup. # noqa: E501

Returns: The audit_info of this PaymentSetup.
Return type: AuditInfo

property card_cvv_number¶

Gets the card_cvv_number of this PaymentSetup. # noqa: E501 This is never returned by Orbipay. This needs to be passed to Orbipay when making or editing a payment setup with a card funding account. # noqa: E501

Returns: The card_cvv_number of this PaymentSetup.
Return type: str

property comments¶

Gets the comments of this PaymentSetup. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this PaymentSetup.
Return type: str

property confirmation_number¶

Gets the confirmation_number of this PaymentSetup. # noqa: E501 The confirmation number or reference provided to the customer for the payment setup. # noqa: E501

Returns: The confirmation_number of this PaymentSetup.
Return type: str

create(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of PaymentSetup.

Return type

created_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of PaymentSetup.

Return type

property currency_code3d¶

Gets the currency_code3d of this PaymentSetup. # noqa: E501 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD. # noqa: E501

Returns: The currency_code3d of this PaymentSetup.
Return type: str

property custom_fields¶

Gets the custom_fields of this PaymentSetup. # noqa: E501 The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests. # noqa: E501

Returns: The custom_fields of this PaymentSetup.
Return type: dict(str, str)

property customer¶

Gets the customer of this PaymentSetup. # noqa: E501

Returns: The customer of this PaymentSetup.
Return type: Customer

property customer_account¶

Gets the customer_account of this PaymentSetup. # noqa: E501

Returns: The customer_account of this PaymentSetup.
Return type: CustomerAccount

delete(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of PaymentSetup.

Return type

property deleted¶

Gets the deleted of this PaymentSetup. # noqa: E501 The status of payment which says whether the payment is deleted or not # noqa: E501

Returns: The deleted of this PaymentSetup.
Return type: str

deleted_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of PaymentSetup.

Return type

property fee¶

Gets the fee of this PaymentSetup. # noqa: E501

Returns: The fee of this PaymentSetup.
Return type: Fee

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

from_account(funding_account=None)¶

Parameters: funding_account – The funding_account is of type FundingAccount.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

property funding_account¶

Gets the funding_account of this PaymentSetup. # noqa: E501

Returns: The funding_account of this PaymentSetup.
Return type: FundingAccount

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of PaymentSetup.

Return type

property id¶

Gets the id of this PaymentSetup. # noqa: E501 The unique identifier assigned by Orbipay to the payment setup. # noqa: E501

Returns: The id of this PaymentSetup.
Return type: str

property id_customer¶

Gets the id_customer of this PaymentSetup. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this PaymentSetup.
Return type: str

property id_payment_setup¶

Gets the id_payment_setup of this PaymentSetup. # noqa: E501 The unique identifier assigned by EBPP to the payment setup. # noqa: E501

Returns: The id_payment_setup of this PaymentSetup.
Return type: str

property next_payment_date¶

Gets the next_payment_date of this PaymentSetup. # noqa: E501 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The next_payment_date of this PaymentSetup.
Return type: str

property payment_method¶

Gets the payment_method of this PaymentSetup. # noqa: E501 The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this PaymentSetup.
Return type: str

property payment_network_response¶

Gets the payment_network_response of this PaymentSetup. # noqa: E501

Returns: The payment_network_response of this PaymentSetup.
Return type: PaymentNetworkResponse

property payment_schedule¶

Gets the payment_schedule of this PaymentSetup. # noqa: E501

Returns: The payment_schedule of this PaymentSetup.
Return type: PaymentSchedule

property payment_setup_entry_date¶

Gets the payment_setup_entry_date of this PaymentSetup. # noqa: E501 The date on which the payment setup is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_setup_entry_date of this PaymentSetup.
Return type: str

property payment_setup_reference¶

Gets the payment_setup_reference of this PaymentSetup. # noqa: E501 The unique identifier in the client system for the payment setup. # noqa: E501

Returns: The payment_setup_reference of this PaymentSetup.
Return type: str

property payment_setup_schedule_type¶

Gets the payment_setup_schedule_type of this PaymentSetup. # noqa: E501 The schedule type for the payment setup. # noqa: E501

Returns: The payment_setup_schedule_type of this PaymentSetup.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of PaymentSetup.

Return type

property status¶

Gets the status of this PaymentSetup. # noqa: E501 The status of the payment. # noqa: E501

Returns: The status of this PaymentSetup.
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'Customer', 'customer_account': 'CustomerAccount', 'deleted': 'str', 'fee': 'Fee', 'funding_account': 'FundingAccount', 'id': 'str', 'id_customer': 'str', 'id_payment_setup': 'str', 'next_payment_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponse', 'payment_schedule': 'PaymentSchedule', 'payment_setup_entry_date': 'str', 'payment_setup_reference': 'str', 'payment_setup_schedule_type': 'str', 'status': 'str', 'url': 'str'}¶

to_account(customer_account=None)¶

Parameters: customer_account – The customer_account is of type CustomerAccount.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

update(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of PaymentSetup.

Return type

updated_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of PaymentSetup.

Return type

property url¶

Gets the url of this PaymentSetup. # noqa: E501 This URL fetches the details of payment setup. # noqa: E501

Returns: The url of this PaymentSetup.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

with_details(amount=None, card_cvv_number=None, payment_setup_schedule_type=None)¶

Parameters

amount – The amount is of type str.
card_cvv_number – The card_cvv_number is of type str.
payment_setup_schedule_type – The payment_setup_schedule_type is of type str.

Returns

The Instance of PaymentSetup.

Return type

with_fee(fee=None)¶

Parameters: fee – The fee is of type Fee.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

with_payment_schedule(payment_schedule=None)¶

Parameters: payment_schedule – The payment_schedule is of type PaymentSchedule.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

with_reference(payment_setup_reference=None)¶

Parameters: payment_setup_reference – The payment_setup_reference is of type str.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

with_status(status=None)¶

Parameters: status – The status is of type str.
Returns: The Instance of PaymentSetup.
Return type: PaymentSetup

orbipay_paymentsapi_client.wrappers.payment_setups module¶

class orbipay_paymentsapi_client.wrappers.payment_setups.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.payment_setups.PaymentSetups¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

attribute_map = {'confirmation_number': 'confirmation_number', 'from_date': 'from_date', 'from_index': 'from_index', 'has_more_results': 'has_more_results', 'id_customer': 'id_customer', 'id_customer_account': 'id_customer_account', 'id_funding_account': 'id_funding_account', 'list': 'list', 'page_size': 'page_size', 'payment_setup_schedule_type': 'payment_setup_schedule_type', 'query_id': 'query_id', 'status': 'status', 'to_date': 'to_date', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property confirmation_number¶

Gets the confirmation_number of this PaymentSetups. # noqa: E501 The confirmation number or reference provided to the customer for the successful payment. # noqa: E501

Returns: The confirmation_number of this PaymentSetups.
Return type: str

find_by(filter_parameters=None)¶

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of PaymentSetups.
Return type: PaymentSetups

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of PaymentSetups.
Return type: PaymentSetups

property from_date¶

Gets the from_date of this PaymentSetups. # noqa: E501 The date from which recurring payments setup, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The from_date of this PaymentSetups.
Return type: str

property from_index¶

Gets the from_index of this PaymentSetups. # noqa: E501 The id of the object before which the previous set of objects are to be retrieved. # noqa: E501

Returns: The from_index of this PaymentSetups.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of PaymentSetups.

Return type

PaymentSetups

property has_more_results¶

Gets the has_more_results of this PaymentSetups. # noqa: E501 true if there are more results or pages # noqa: E501

Returns: The has_more_results of this PaymentSetups.
Return type: str

property id_customer¶

Gets the id_customer of this PaymentSetups. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this PaymentSetups.
Return type: str

property id_customer_account¶

Gets the id_customer_account of this PaymentSetups. # noqa: E501 The unique identifier assigned by EBPP to the customer account # noqa: E501

Returns: The id_customer_account of this PaymentSetups.
Return type: str

property id_funding_account¶

Gets the id_funding_account of this PaymentSetups. # noqa: E501 The unique identifier assigned by EBPP to the funding account # noqa: E501

Returns: The id_funding_account of this PaymentSetups.
Return type: str

property list¶

Gets the list of this PaymentSetups. # noqa: E501

Returns: The list of this PaymentSetups.
Return type: list[PaymentSetup]

property page_size¶

Gets the page_size of this PaymentSetups. # noqa: E501 The maximum number of objects returned in the query. # noqa: E501

Returns: The page_size of this PaymentSetups.
Return type: str

property payment_setup_schedule_type¶

Gets the payment_setup_schedule_type of this PaymentSetups. # noqa: E501 The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The payment_setup_schedule_type of this PaymentSetups.
Return type: list[str]

property query_id¶

Gets the query_id of this PaymentSetups. # noqa: E501 The query id of the object. # noqa: E501

Returns: The query_id of this PaymentSetups.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of PaymentSetups.

Return type

PaymentSetups

property status¶

Gets the status of this PaymentSetups. # noqa: E501 The status of the payment. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The status of this PaymentSetups.
Return type: list[str]

swagger_types = {'confirmation_number': 'str', 'from_date': 'str', 'from_index': 'str', 'has_more_results': 'str', 'id_customer': 'str', 'id_customer_account': 'str', 'id_funding_account': 'str', 'list': 'list[PaymentSetup]', 'page_size': 'str', 'payment_setup_schedule_type': 'list[str]', 'query_id': 'str', 'status': 'list[str]', 'to_date': 'str', 'to_index': 'str', 'total_results_count': 'str', 'url': 'str'}¶

property to_date¶

Gets the to_date of this PaymentSetups. # noqa: E501 The date upto which recurring payments setup, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The to_date of this PaymentSetups.
Return type: str

to_dict()¶: Returns the model properties as a dict

property to_index¶

Gets the to_index of this PaymentSetups. # noqa: E501 The id of the object after which the next set of objects are to be retrieved. # noqa: E501

Returns: The to_index of this PaymentSetups.
Return type: str

to_str()¶: Returns the string representation of the model

property total_results_count¶

Gets the total_results_count of this PaymentSetups. # noqa: E501 The total number of payment setup available matching the search criteria. # noqa: E501

Returns: The total_results_count of this PaymentSetups.
Return type: str

property url¶

Gets the url of this PaymentSetups. # noqa: E501 This URL fetches the next or previous set of payment setups, based on the presence of after_object or before_object parameter. # noqa: E501

Returns: The url of this PaymentSetups.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of PaymentSetups.
Return type: PaymentSetups

orbipay_paymentsapi_client.wrappers.payments module¶

class orbipay_paymentsapi_client.wrappers.payments.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.payments.Payments¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

attribute_map = {'confirmation_number': 'confirmation_number', 'from_date': 'from_date', 'from_index': 'from_index', 'has_more_results': 'has_more_results', 'id_customer': 'id_customer', 'id_customer_account': 'id_customer_account', 'id_funding_account': 'id_funding_account', 'list': 'list', 'page_size': 'page_size', 'payment_method': 'payment_method', 'payment_schedule_type': 'payment_schedule_type', 'query_id': 'query_id', 'status': 'status', 'to_date': 'to_date', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property confirmation_number¶

Gets the confirmation_number of this Payments. # noqa: E501 The confirmation number or reference provided to the customer for the successful payment. # noqa: E501

Returns: The confirmation_number of this Payments.
Return type: str

find_by(filter_parameters=None)¶

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of Payments.
Return type: Payments

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of Payments.
Return type: Payments

property from_date¶

Gets the from_date of this Payments. # noqa: E501 The date from which payments, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The from_date of this Payments.
Return type: str

property from_index¶

Gets the from_index of this Payments. # noqa: E501 The id of the object before which the previous set of objects are to be retrieved. # noqa: E501

Returns: The from_index of this Payments.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Payments.

Return type

Payments

property has_more_results¶

Gets the has_more_results of this Payments. # noqa: E501 true if there are more results or pages # noqa: E501

Returns: The has_more_results of this Payments.
Return type: str

property id_customer¶

Gets the id_customer of this Payments. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this Payments.
Return type: str

property id_customer_account¶

Gets the id_customer_account of this Payments. # noqa: E501 The unique identifier assigned by EBPP to the customer account # noqa: E501

Returns: The id_customer_account of this Payments.
Return type: str

property id_funding_account¶

Gets the id_funding_account of this Payments. # noqa: E501 The unique identifier assigned by EBPP to the funding account # noqa: E501

Returns: The id_funding_account of this Payments.
Return type: str

property list¶

Gets the list of this Payments. # noqa: E501

Returns: The list of this Payments.
Return type: list[Payment]

property page_size¶

Gets the page_size of this Payments. # noqa: E501 The maximum number of objects returned in the query. # noqa: E501

Returns: The page_size of this Payments.
Return type: str

property payment_method¶

Gets the payment_method of this Payments. # noqa: E501 The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this Payments.
Return type: list[str]

property payment_schedule_type¶

Gets the payment_schedule_type of this Payments. # noqa: E501 The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The payment_schedule_type of this Payments.
Return type: list[str]

property query_id¶

Gets the query_id of this Payments. # noqa: E501 The query id of the object. # noqa: E501

Returns: The query_id of this Payments.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Payments.

Return type

Payments

property status¶

Gets the status of this Payments. # noqa: E501 The status of the payment. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The status of this Payments.
Return type: list[str]

swagger_types = {'confirmation_number': 'str', 'from_date': 'str', 'from_index': 'str', 'has_more_results': 'str', 'id_customer': 'str', 'id_customer_account': 'str', 'id_funding_account': 'str', 'list': 'list[Payment]', 'page_size': 'str', 'payment_method': 'list[str]', 'payment_schedule_type': 'list[str]', 'query_id': 'str', 'status': 'list[str]', 'to_date': 'str', 'to_index': 'str', 'total_results_count': 'str', 'url': 'str'}¶

property to_date¶

Gets the to_date of this Payments. # noqa: E501 The date upto which payments, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The to_date of this Payments.
Return type: str

to_dict()¶: Returns the model properties as a dict

property to_index¶

Gets the to_index of this Payments. # noqa: E501 The id of the object after which the next set of objects are to be retrieved. # noqa: E501

Returns: The to_index of this Payments.
Return type: str

to_str()¶: Returns the string representation of the model

property total_results_count¶

Gets the total_results_count of this Payments. # noqa: E501 total number of payments available with matching criteria # noqa: E501

Returns: The total_results_count of this Payments.
Return type: str

property url¶

Gets the url of this Payments. # noqa: E501 This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter. # noqa: E501

Returns: The url of this Payments.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of Payments.
Return type: Payments

orbipay_paymentsapi_client.wrappers.recorded_payment module¶

class orbipay_paymentsapi_client.wrappers.recorded_payment.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.recorded_payment.RecordedPayment(id_payment=None)¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property amount¶

Gets the amount of this RecordedPayment. # noqa: E501 The amount being paid. In case the payment_amount_type is ‘other’, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. # noqa: E501

Returns: The amount of this RecordedPayment.
Return type: str

attribute_map = {'amount': 'amount', 'audit_info': 'audit_info', 'comments': 'comments', 'confirmation_number': 'confirmation_number', 'currency_code3d': 'currency_code3d', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'fee': 'fee', 'funding_account': 'funding_account', 'id': 'id', 'id_payment': 'id_payment', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_entry_date': 'payment_entry_date', 'payment_method': 'payment_method', 'payment_reference': 'payment_reference', 'payment_return_date': 'payment_return_date', 'payment_schedule_type': 'payment_schedule_type', 'return_code': 'return_code', 'status': 'status', 'token': 'token', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this RecordedPayment. # noqa: E501

Returns: The audit_info of this RecordedPayment.
Return type: AuditInfo

property comments¶

Gets the comments of this RecordedPayment. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this RecordedPayment.
Return type: str

property confirmation_number¶

Gets the confirmation_number of this RecordedPayment. # noqa: E501 The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this RecordedPayment.
Return type: str

create(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of RecordedPayment.

Return type

created_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of RecordedPayment.

Return type

property currency_code3d¶

Gets the currency_code3d of this RecordedPayment. # noqa: E501 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD. # noqa: E501

Returns: The currency_code3d of this RecordedPayment.
Return type: str

property custom_fields¶

Gets the custom_fields of this RecordedPayment. # noqa: E501 The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. # noqa: E501

Returns: The custom_fields of this RecordedPayment.
Return type: dict(str, str)

property customer¶

Gets the customer of this RecordedPayment. # noqa: E501

Returns: The customer of this RecordedPayment.
Return type: Customer

property customer_account¶

Gets the customer_account of this RecordedPayment. # noqa: E501

Returns: The customer_account of this RecordedPayment.
Return type: CustomerAccount

delete(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of RecordedPayment.

Return type

deleted_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of RecordedPayment.

Return type

property fee¶

Gets the fee of this RecordedPayment. # noqa: E501

Returns: The fee of this RecordedPayment.
Return type: Fee

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

from_account(funding_account=None)¶

Parameters: funding_account – The funding_account is of type FundingAccount.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

property funding_account¶

Gets the funding_account of this RecordedPayment. # noqa: E501

Returns: The funding_account of this RecordedPayment.
Return type: FundingAccount

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of RecordedPayment.

Return type

property id¶

Gets the id of this RecordedPayment. # noqa: E501 The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id of this RecordedPayment.
Return type: str

property id_payment¶

Gets the id_payment of this RecordedPayment. # noqa: E501 The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id_payment of this RecordedPayment.
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this RecordedPayment. # noqa: E501 The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. # noqa: E501

Returns: The payment_amount_type of this RecordedPayment.
Return type: str

property payment_date¶

Gets the payment_date of this RecordedPayment. # noqa: E501 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_date of this RecordedPayment.
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this RecordedPayment. # noqa: E501 The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_entry_date of this RecordedPayment.
Return type: str

property payment_method¶

Gets the payment_method of this RecordedPayment. # noqa: E501 The non fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this RecordedPayment.
Return type: str

property payment_reference¶

Gets the payment_reference of this RecordedPayment. # noqa: E501 The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this RecordedPayment.
Return type: str

property payment_return_date¶

Gets the payment_return_date of this RecordedPayment. # noqa: E501 The date on which the ACH returns is received by EBPP. # noqa: E501

Returns: The payment_return_date of this RecordedPayment.
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this RecordedPayment. # noqa: E501 The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this RecordedPayment.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of RecordedPayment.

Return type

property return_code¶

Gets the return_code of this RecordedPayment. # noqa: E501 The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. # noqa: E501

Returns: The return_code of this RecordedPayment.
Return type: str

property status¶

Gets the status of this RecordedPayment. # noqa: E501 The status of the payment. # noqa: E501

Returns: The status of this RecordedPayment.
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfo', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'Customer', 'customer_account': 'CustomerAccount', 'fee': 'Fee', 'funding_account': 'FundingAccount', 'id': 'str', 'id_payment': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_reference': 'str', 'payment_return_date': 'str', 'payment_schedule_type': 'str', 'return_code': 'str', 'status': 'str', 'token': 'str', 'url': 'str'}¶

to_account(customer_account=None)¶

Parameters: customer_account – The customer_account is of type CustomerAccount.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property token¶

Gets the token of this RecordedPayment. # noqa: E501 The token is used to uniquely identify the payment, such as the POS token. # noqa: E501

Returns: The token of this RecordedPayment.
Return type: str

property url¶

Gets the url of this RecordedPayment. # noqa: E501 This URL fetches the details of payment. # noqa: E501

Returns: The url of this RecordedPayment.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

with_customer(customer=None)¶

Parameters: customer – The customer is of type Customer.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

with_details(payment_amount_type=None, amount=None, payment_date=None, payment_method=None)¶

Parameters

payment_amount_type – The payment_amount_type is of type str.
amount – The amount is of type str.
payment_date – The payment_date is of type str.
payment_method – The payment_method is of type str.

Returns

The Instance of RecordedPayment.

Return type

with_fee(fee=None)¶

Parameters: fee – The fee is of type Fee.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

with_reference(payment_reference=None)¶

Parameters: payment_reference – The payment_reference is of type str.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

with_token(token=None)¶

Parameters: token – The token is of type str.
Returns: The Instance of RecordedPayment.
Return type: RecordedPayment

orbipay_paymentsapi_client.wrappers.recorded_payments module¶

class orbipay_paymentsapi_client.wrappers.recorded_payments.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.recorded_payments.RecordedPayments¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

attribute_map = {'confirmation_number': 'confirmation_number', 'from_date': 'from_date', 'from_index': 'from_index', 'has_more_results': 'has_more_results', 'id_customer': 'id_customer', 'id_customer_account': 'id_customer_account', 'list': 'list', 'page_size': 'page_size', 'payment_method': 'payment_method', 'query_id': 'query_id', 'status': 'status', 'to_date': 'to_date', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property confirmation_number¶

Gets the confirmation_number of this RecordedPayments. # noqa: E501 The confirmation number or reference provided to the customer for the successful payment. # noqa: E501

Returns: The confirmation_number of this RecordedPayments.
Return type: str

find_by(filter_parameters=None)¶

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of RecordedPayments.
Return type: RecordedPayments

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of RecordedPayments.
Return type: RecordedPayments

property from_date¶

Gets the from_date of this RecordedPayments. # noqa: E501 The date from which payments, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The from_date of this RecordedPayments.
Return type: str

property from_index¶

Gets the from_index of this RecordedPayments. # noqa: E501 The id of the object before which the previous set of objects are to be retrieved. # noqa: E501

Returns: The from_index of this RecordedPayments.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of RecordedPayments.

Return type

RecordedPayments

property has_more_results¶

Gets the has_more_results of this RecordedPayments. # noqa: E501 true if there are more results or pages # noqa: E501

Returns: The has_more_results of this RecordedPayments.
Return type: str

property id_customer¶

Gets the id_customer of this RecordedPayments. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this RecordedPayments.
Return type: str

property id_customer_account¶

Gets the id_customer_account of this RecordedPayments. # noqa: E501 The unique identifier assigned by EBPP to the customer account # noqa: E501

Returns: The id_customer_account of this RecordedPayments.
Return type: str

property list¶

Gets the list of this RecordedPayments. # noqa: E501

Returns: The list of this RecordedPayments.
Return type: list[RecordedPayment]

property page_size¶

Gets the page_size of this RecordedPayments. # noqa: E501 The maximum number of objects returned in the query. # noqa: E501

Returns: The page_size of this RecordedPayments.
Return type: str

property payment_method¶

Gets the payment_method of this RecordedPayments. # noqa: E501 The non fulfillment method for the payment. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The payment_method of this RecordedPayments.
Return type: list[str]

property query_id¶

Gets the query_id of this RecordedPayments. # noqa: E501 The query id of the object. # noqa: E501

Returns: The query_id of this RecordedPayments.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of RecordedPayments.

Return type

RecordedPayments

property status¶

Gets the status of this RecordedPayments. # noqa: E501 The status of the payment. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The status of this RecordedPayments.
Return type: list[str]

swagger_types = {'confirmation_number': 'str', 'from_date': 'str', 'from_index': 'str', 'has_more_results': 'str', 'id_customer': 'str', 'id_customer_account': 'str', 'list': 'list[RecordedPayment]', 'page_size': 'str', 'payment_method': 'list[str]', 'query_id': 'str', 'status': 'list[str]', 'to_date': 'str', 'to_index': 'str', 'total_results_count': 'str', 'url': 'str'}¶

property to_date¶

Gets the to_date of this RecordedPayments. # noqa: E501 The date upto which payments, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The to_date of this RecordedPayments.
Return type: str

to_dict()¶: Returns the model properties as a dict

property to_index¶

Gets the to_index of this RecordedPayments. # noqa: E501 The id of the object after which the next set of objects are to be retrieved. # noqa: E501

Returns: The to_index of this RecordedPayments.
Return type: str

to_str()¶: Returns the string representation of the model

property total_results_count¶

Gets the total_results_count of this RecordedPayments. # noqa: E501 total number of payments available with matching criteria # noqa: E501

Returns: The total_results_count of this RecordedPayments.
Return type: str

property url¶

Gets the url of this RecordedPayments. # noqa: E501 This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter. # noqa: E501

Returns: The url of this RecordedPayments.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of RecordedPayments.
Return type: RecordedPayments

orbipay_paymentsapi_client.wrappers.refund module¶

class orbipay_paymentsapi_client.wrappers.refund.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.refund.Refund(id_refund=None)¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

attribute_map = {'audit_info': 'audit_info', 'comments': 'comments', 'confirmation_number': 'confirmation_number', 'custom_fields': 'custom_fields', 'expected_refund_settlement_date': 'expected_refund_settlement_date', 'fee_refund': 'fee_refund', 'id': 'id', 'id_customer': 'id_customer', 'id_payment': 'id_payment', 'id_refund': 'id_refund', 'payment_network_response': 'payment_network_response', 'refund_amount': 'refund_amount', 'refund_date': 'refund_date', 'refund_entry_date': 'refund_entry_date', 'refund_reference': 'refund_reference', 'refund_type': 'refund_type', 'source_payment': 'source_payment', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this Refund. # noqa: E501

Returns: The audit_info of this Refund.
Return type: AuditInfo

property comments¶

Gets the comments of this Refund. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this Refund.
Return type: str

property confirmation_number¶

Gets the confirmation_number of this Refund. # noqa: E501 The confirmation number or reference provided to the customer for the refund. # noqa: E501

Returns: The confirmation_number of this Refund.
Return type: str

create(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Refund.

Return type

created_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Refund.

Return type

property custom_fields¶

Gets the custom_fields of this Refund. # noqa: E501 The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. # noqa: E501

Returns: The custom_fields of this Refund.
Return type: dict(str, str)

property expected_refund_settlement_date¶

Gets the expected_refund_settlement_date of this Refund. # noqa: E501 The date by which the credits would be posted to the original funding account. ISO8601 full-date format, YYYY-MM-DD # noqa: E501

Returns: The expected_refund_settlement_date of this Refund.
Return type: str

property fee_refund¶

Gets the fee_refund of this Refund. # noqa: E501

Returns: The fee_refund of this Refund.
Return type: FeeRefund

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of Refund.
Return type: Refund

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of Refund.
Return type: Refund

for_payment(id_payment=None)¶

Parameters: id_payment – The id_payment is of type str.
Returns: The Instance of Refund.
Return type: Refund

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Refund.

Return type

property id¶

Gets the id of this Refund. # noqa: E501 The unique identifier assigned by EBPP to the refund. # noqa: E501

Returns: The id of this Refund.
Return type: str

property id_customer¶

Gets the id_customer of this Refund. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this Refund.
Return type: str

property id_payment¶

Gets the id_payment of this Refund. # noqa: E501 The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id_payment of this Refund.
Return type: str

property id_refund¶

Gets the id_refund of this Refund. # noqa: E501 The unique identifier assigned by EBPP to the refund. # noqa: E501

Returns: The id_refund of this Refund.
Return type: str

property payment_network_response¶

Gets the payment_network_response of this Refund. # noqa: E501

Returns: The payment_network_response of this Refund.
Return type: PaymentNetworkResponse

property refund_amount¶

Gets the refund_amount of this Refund. # noqa: E501 The refund amount upto 2 decimal places. # noqa: E501

Returns: The refund_amount of this Refund.
Return type: str

property refund_date¶

Gets the refund_date of this Refund. # noqa: E501 The date on which the refund is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The refund_date of this Refund.
Return type: str

property refund_entry_date¶

Gets the refund_entry_date of this Refund. # noqa: E501 The date on which the refund captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The refund_entry_date of this Refund.
Return type: str

property refund_reference¶

Gets the refund_reference of this Refund. # noqa: E501 The unique identifier in the client system for the refund. # noqa: E501

Returns: The refund_reference of this Refund.
Return type: str

property refund_type¶

Gets the refund_type of this Refund. # noqa: E501 The portion of the payment amount that is to be or has been refunded. The original payment can be refunded fully including the amount and the fee components, or partially, for just the amount or the fee component. Refund can also be initiated for an arbitrary amount limited by the original payment amount. # noqa: E501

Returns: The refund_type of this Refund.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Refund.

Return type

property source_payment¶

Gets the source_payment of this Refund. # noqa: E501

Returns: The source_payment of this Refund.
Return type: SourcePayment

property status¶

Gets the status of this Refund. # noqa: E501 The status of the refund. # noqa: E501

Returns: The status of this Refund.
Return type: str

swagger_types = {'audit_info': 'AuditInfo', 'comments': 'str', 'confirmation_number': 'str', 'custom_fields': 'dict(str, str)', 'expected_refund_settlement_date': 'str', 'fee_refund': 'FeeRefund', 'id': 'str', 'id_customer': 'str', 'id_payment': 'str', 'id_refund': 'str', 'payment_network_response': 'PaymentNetworkResponse', 'refund_amount': 'str', 'refund_date': 'str', 'refund_entry_date': 'str', 'refund_reference': 'str', 'refund_type': 'str', 'source_payment': 'SourcePayment', 'status': 'str', 'url': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property url¶

Gets the url of this Refund. # noqa: E501 This URL fetches the details of refund. # noqa: E501

Returns: The url of this Refund.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of Refund.
Return type: Refund

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of Refund.
Return type: Refund

with_details(refund_amount=None)¶

Parameters: refund_amount – The refund_amount is of type str.
Returns: The Instance of Refund.
Return type: Refund

with_fee_refund(fee_refund=None)¶

Parameters: fee_refund – The fee_refund is of type FeeRefund.
Returns: The Instance of Refund.
Return type: Refund

with_memo(comments=None)¶

Parameters: comments – The comments is of type str.
Returns: The Instance of Refund.
Return type: Refund

with_reference(refund_reference=None)¶

Parameters: refund_reference – The refund_reference is of type str.
Returns: The Instance of Refund.
Return type: Refund

with_status(status=None)¶

Parameters: status – The status is of type str.
Returns: The Instance of Refund.
Return type: Refund

orbipay_paymentsapi_client.wrappers.refunds module¶

class orbipay_paymentsapi_client.wrappers.refunds.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.refunds.Refunds¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

attribute_map = {'confirmation_number': 'confirmation_number', 'from_date': 'from_date', 'from_index': 'from_index', 'has_more_results': 'has_more_results', 'id_customer': 'id_customer', 'list': 'list', 'page_size': 'page_size', 'query_id': 'query_id', 'status': 'status', 'to_date': 'to_date', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property confirmation_number¶

Gets the confirmation_number of this Refunds. # noqa: E501 The confirmation number provided to the customer for the refund or for the corresponding successful payment. # noqa: E501

Returns: The confirmation_number of this Refunds.
Return type: str

find_by(filter_parameters=None)¶

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of Refunds.
Return type: Refunds

for_customer(id_customer=None)¶

Parameters: id_customer – The id_customer is of type str.
Returns: The Instance of Refunds.
Return type: Refunds

property from_date¶

Gets the from_date of this Refunds. # noqa: E501 The date from which refunds, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The from_date of this Refunds.
Return type: str

property from_index¶

Gets the from_index of this Refunds. # noqa: E501 The id of the object before which the previous set of objects are to be retrieved. # noqa: E501

Returns: The from_index of this Refunds.
Return type: str

get(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of Refunds.

Return type

Refunds

property has_more_results¶

Gets the has_more_results of this Refunds. # noqa: E501 true if there are more results or pages # noqa: E501

Returns: The has_more_results of this Refunds.
Return type: str

property id_customer¶

Gets the id_customer of this Refunds. # noqa: E501 The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id_customer of this Refunds.
Return type: str

property list¶

Gets the list of this Refunds. # noqa: E501

Returns: The list of this Refunds.
Return type: list[Refund]

property page_size¶

Gets the page_size of this Refunds. # noqa: E501 The maximum number of objects returned in the query. # noqa: E501

Returns: The page_size of this Refunds.
Return type: str

property query_id¶

Gets the query_id of this Refunds. # noqa: E501 The query id of the object. # noqa: E501

Returns: The query_id of this Refunds.
Return type: str

retrieved_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of Refunds.

Return type

Refunds

property status¶

Gets the status of this Refunds. # noqa: E501 The status of the refund. This can take multiple values in the format key=value1&key=value2…. # noqa: E501

Returns: The status of this Refunds.
Return type: list[str]

swagger_types = {'confirmation_number': 'str', 'from_date': 'str', 'from_index': 'str', 'has_more_results': 'str', 'id_customer': 'str', 'list': 'list[Refund]', 'page_size': 'str', 'query_id': 'str', 'status': 'list[str]', 'to_date': 'str', 'to_index': 'str', 'total_results_count': 'str', 'url': 'str'}¶

property to_date¶

Gets the to_date of this Refunds. # noqa: E501 The date upto which refunds, matching the criteria specified, need to be retrieved. # noqa: E501

Returns: The to_date of this Refunds.
Return type: str

to_dict()¶: Returns the model properties as a dict

property to_index¶

Gets the to_index of this Refunds. # noqa: E501 The id of the object after which the next set of objects are to be retrieved. # noqa: E501

Returns: The to_index of this Refunds.
Return type: str

to_str()¶: Returns the string representation of the model

property total_results_count¶

Gets the total_results_count of this Refunds. # noqa: E501 total number of payments available with matching criteria # noqa: E501

Returns: The total_results_count of this Refunds.
Return type: str

property url¶

Gets the url of this Refunds. # noqa: E501 This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter. # noqa: E501

Returns: The url of this Refunds.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of Refunds.
Return type: Refunds

orbipay_paymentsapi_client.wrappers.resource_audit module¶

class orbipay_paymentsapi_client.wrappers.resource_audit.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.resource_audit.ResourceAudit¶

Bases: object

attribute_map = {'channel': 'channel', 'requestor': 'requestor', 'requestor_type': 'requestor_type', 'timestamp': 'timestamp'}¶

property channel¶

Gets the channel of this ResourceAudit. # noqa: E501 The channel through which the API is invoked. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> to configure channels. # noqa: E501

Returns: The channel of this ResourceAudit.
Return type: str

property requestor¶

Gets the requestor of this ResourceAudit. # noqa: E501 The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is “customer”, the requestor should be the EBPP generated customer id. In the case of self registration, where there is no EBPP generated customer id yet, the requestor should be set to ‘guest’. If the requestor_type is “external_user”, the requestor can be any unique identifier that the client may have for the external agent. If the requestor_type is system, requestor is optional. # noqa: E501

Returns: The requestor of this ResourceAudit.
Return type: str

property requestor_type¶

Gets the requestor_type of this ResourceAudit. # noqa: E501 If an API is being requested from an application that is being used directly by a customer, like the customer portal and IVR, the requestor_type should be set to “customer”. If an API is being requested from an application that is being used by third party agents/brokers servicing a customer on behalf of a biller/client, then the requestor_type should be set to “external_user”. It should be noted that these users would not have logins for the EBPP Portal or Payment Center. # noqa: E501

Returns: The requestor_type of this ResourceAudit.
Return type: str

swagger_types = {'channel': 'str', 'requestor': 'str', 'requestor_type': 'str', 'timestamp': 'str'}¶

property timestamp¶

Gets the timestamp of this ResourceAudit. # noqa: E501 The UTC timestamp, in ISO8601 format, for the moment when the resource got created or modified in EBPP. For e.g., 2019-08-13T09:21:34.359+0000 # noqa: E501

Returns: The timestamp of this ResourceAudit.
Return type: str

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

orbipay_paymentsapi_client.wrappers.simple_payment module¶

class orbipay_paymentsapi_client.wrappers.simple_payment.FinalClass(name, bases, classdict)¶: Bases: type

class orbipay_paymentsapi_client.wrappers.simple_payment.SimplePayment¶

Bases: orbipay_paymentsapi_client.wrappers.base.Base

property amount¶

Gets the amount of this SimplePayment. # noqa: E501 The amount being paid. In case the payment_amount_type is ‘discounted_amount’, ‘penalty_amount’ or ‘other’, the amount needs to be specified. In other cases, this is derived from the payment_amount_type. # noqa: E501

Returns: The amount of this SimplePayment.
Return type: str

attribute_map = {'amount': 'amount', 'audit_info': 'audit_info', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'confirmation_number': 'confirmation_number', 'cryptogram': 'cryptogram', 'currency_code3d': 'currency_code3d', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'eci': 'eci', 'expected_payment_settlement_date': 'expected_payment_settlement_date', 'fee': 'fee', 'funding_account': 'funding_account', 'id': 'id', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_entry_date': 'payment_entry_date', 'payment_method': 'payment_method', 'payment_network_response': 'payment_network_response', 'payment_notification_email': 'payment_notification_email', 'payment_reference': 'payment_reference', 'payment_request_date': 'payment_request_date', 'payment_return_date': 'payment_return_date', 'payment_schedule_type': 'payment_schedule_type', 'return_code': 'return_code', 'save_funding_account': 'save_funding_account', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this SimplePayment. # noqa: E501

Returns: The audit_info of this SimplePayment.
Return type: AuditInfo

property card_cvv_number¶

Gets the card_cvv_number of this SimplePayment. # noqa: E501 This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account. # noqa: E501

Returns: The card_cvv_number of this SimplePayment.
Return type: str

property comments¶

Gets the comments of this SimplePayment. # noqa: E501 Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo. # noqa: E501

Returns: The comments of this SimplePayment.
Return type: str

property confirmation_number¶

Gets the confirmation_number of this SimplePayment. # noqa: E501 The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this SimplePayment.
Return type: str

create(invocation_context=None, live_mode=None, api_end_point=None)¶

Parameters

invocation_context – The invocation_context is of type str.
live_mode – The live_mode is of type bool.
api_end_point – The api_end_point is of type str.

Returns

The Instance of SimplePayment.

Return type

created_by(requestor=None, requestor_type=None)¶

Parameters

requestor – The requestor is of type str.
requestor_type – The requestor_type is of type str.

Returns

The Instance of SimplePayment.

Return type

property cryptogram¶

Gets the cryptogram of this SimplePayment. # noqa: E501 This is applicable only for Apple Pay transactions. Online Payment Cryptogram, as defined by 3-D secure. # noqa: E501

Returns: The cryptogram of this SimplePayment.
Return type: str

property currency_code3d¶

Gets the currency_code3d of this SimplePayment. # noqa: E501 The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD. # noqa: E501

Returns: The currency_code3d of this SimplePayment.
Return type: str

property custom_fields¶

Gets the custom_fields of this SimplePayment. # noqa: E501 The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = “mailto: support@billerpayments.com”>support@billerpayments.com</a> for more information on configuring and using custom fields. # noqa: E501

Returns: The custom_fields of this SimplePayment.
Return type: dict(str, str)

property customer¶

Gets the customer of this SimplePayment. # noqa: E501

Returns: The customer of this SimplePayment.
Return type: Customer

property customer_account¶

Gets the customer_account of this SimplePayment. # noqa: E501

Returns: The customer_account of this SimplePayment.
Return type: CustomerAccount

property eci¶

Gets the eci of this SimplePayment. # noqa: E501 This is applicable only for Apple Pay transactions. ECI Indicator, as defined by 3-D secure. The card network may add an ECI indicator to the card data. This indicator is then included in the payment token. if you receive an ECI indicator, you must pass it on to your payment processor, otherwise, the transaction fails. # noqa: E501

Returns: The eci of this SimplePayment.
Return type: str

property expected_payment_settlement_date¶

Gets the expected_payment_settlement_date of this SimplePayment. # noqa: E501 The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The expected_payment_settlement_date of this SimplePayment.
Return type: str

property fee¶

Gets the fee of this SimplePayment. # noqa: E501

Returns: The fee of this SimplePayment.
Return type: Fee

for_client(client_key=None)¶

Parameters: client_key – The client_key is of type str.
Returns: The Instance of SimplePayment.
Return type: SimplePayment

for_customer(customer=None)¶

Parameters: customer – The customer is of type Customer.
Returns: The Instance of SimplePayment.
Return type: SimplePayment

from_account(funding_account=None, save_funding_account=None)¶

Parameters

funding_account – The funding_account is of type FundingAccount.
save_funding_account – The save_funding_account is of type str.

Returns

The Instance of SimplePayment.

Return type

property funding_account¶

Gets the funding_account of this SimplePayment. # noqa: E501

Returns: The funding_account of this SimplePayment.
Return type: FundingAccount

property id¶

Gets the id of this SimplePayment. # noqa: E501 The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id of this SimplePayment.
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this SimplePayment. # noqa: E501 The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other. # noqa: E501

Returns: The payment_amount_type of this SimplePayment.
Return type: str

property payment_date¶

Gets the payment_date of this SimplePayment. # noqa: E501 The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_date of this SimplePayment.
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this SimplePayment. # noqa: E501 The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. # noqa: E501

Returns: The payment_entry_date of this SimplePayment.
Return type: str

property payment_method¶

Gets the payment_method of this SimplePayment. # noqa: E501 The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this SimplePayment.
Return type: str

property payment_network_response¶

Gets the payment_network_response of this SimplePayment. # noqa: E501

Returns: The payment_network_response of this SimplePayment.
Return type: PaymentNetworkResponse

property payment_notification_email¶

Gets the payment_notification_email of this SimplePayment. # noqa: E501 The email address to which notifications for the payment will be sent. The notifications will be sent to the customer’s email in case this is not provided. # noqa: E501

Returns: The payment_notification_email of this SimplePayment.
Return type: str

property payment_reference¶

Gets the payment_reference of this SimplePayment. # noqa: E501 The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this SimplePayment.
Return type: str

property payment_request_date¶

Gets the payment_request_date of this SimplePayment. # noqa: E501 The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it. # noqa: E501

Returns: The payment_request_date of this SimplePayment.
Return type: str

property payment_return_date¶

Gets the payment_return_date of this SimplePayment. # noqa: E501 The date on which the ACH returns is received by EBPP. # noqa: E501

Returns: The payment_return_date of this SimplePayment.
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this SimplePayment. # noqa: E501 The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this SimplePayment.
Return type: str

property return_code¶

Gets the return_code of this SimplePayment. # noqa: E501 The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments. # noqa: E501

Returns: The return_code of this SimplePayment.
Return type: str

property save_funding_account¶

Gets the save_funding_account of this SimplePayment. # noqa: E501 query param # noqa: E501

Returns: The save_funding_account of this SimplePayment.
Return type: str

property status¶

Gets the status of this SimplePayment. # noqa: E501 The status of the payment. # noqa: E501

Returns: The status of this SimplePayment.
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'cryptogram': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'Customer', 'customer_account': 'CustomerAccount', 'eci': 'str', 'expected_payment_settlement_date': 'str', 'fee': 'Fee', 'funding_account': 'FundingAccount', 'id': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponse', 'payment_notification_email': 'str', 'payment_reference': 'str', 'payment_request_date': 'str', 'payment_return_date': 'str', 'payment_schedule_type': 'str', 'return_code': 'str', 'save_funding_account': 'str', 'status': 'str', 'url': 'str'}¶

to_account(customer_account=None)¶

Parameters: customer_account – The customer_account is of type CustomerAccount.
Returns: The Instance of SimplePayment.
Return type: SimplePayment

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property url¶

Gets the url of this SimplePayment. # noqa: E501 This URL fetches the details of payment. # noqa: E501

Returns: The url of this SimplePayment.
Return type: str

vide_channel(channel=None)¶

Parameters: channel – The channel is of type str.
Returns: The Instance of SimplePayment.
Return type: SimplePayment

with_cryptogram(cryptogram=None)¶

Parameters: cryptogram – The cryptogram is of type str.
Returns: The Instance of SimplePayment.
Return type: SimplePayment

with_custom_fields(custom_fields=None)¶

Parameters: custom_fields – The custom_fields is of type dict(str, str).
Returns: The Instance of SimplePayment.
Return type: SimplePayment

with_details(payment_amount_type=None, amount=None, payment_date=None, payment_request_date=None, card_cvv_number=None)¶

Parameters

payment_amount_type – The payment_amount_type is of type str.
amount – The amount is of type str.
payment_date – The payment_date is of type str.
payment_request_date – The payment_request_date is of type str.
card_cvv_number – The card_cvv_number is of type str.

Returns

The Instance of SimplePayment.

Return type