orbipay_paymentsapi_client.models package¶

Submodules¶

orbipay_paymentsapi_client.models.add_funding_account_request module¶

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

class orbipay_paymentsapi_client.models.add_funding_account_request.AddFundingAccountRequest(account_holder_name=None, nickname=None, address=None, account_number=None, aba_routing_number=None, expiry_date=None, account_holder_type=None, custom_fields=None, account_subtype=None, card_cvv_number=None, comments=None)¶

Bases: object

NOTE:

property aba_routing_number¶

Gets the aba_routing_number of this AddFundingAccountRequest. # noqa: E501

The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this AddFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_name¶

Gets the account_holder_name of this AddFundingAccountRequest. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this AddFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_type¶

Gets the account_holder_type of this AddFundingAccountRequest. # 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 AddFundingAccountRequest. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this AddFundingAccountRequest. # noqa: E501

The number or reference that a customer uses to identify the funding account. # noqa: E501

Returns: The account_number of this AddFundingAccountRequest. # noqa: E501
Return type: str

property account_subtype¶

Gets the account_subtype of this AddFundingAccountRequest. # 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/ApplePay account. For e.g., a savings account, a checking account. # noqa: E501

Returns: The account_subtype of this AddFundingAccountRequest. # noqa: E501
Return type: str

property address¶

Gets the address of this AddFundingAccountRequest. # noqa: E501

Returns: The address of this AddFundingAccountRequest. # noqa: E501
Return type: FundingAccountAddress

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', 'address': 'address', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'custom_fields': 'custom_fields', 'expiry_date': 'expiry_date', 'nickname': 'nickname'}¶

property card_cvv_number¶

Gets the card_cvv_number of this AddFundingAccountRequest. # noqa: E501

This is never returned by EBPP. This needs to be passed to EBPP when adding or editing a card funding account. # noqa: E501

Returns: The card_cvv_number of this AddFundingAccountRequest. # noqa: E501
Return type: str

property comments¶

Gets the comments of this AddFundingAccountRequest. # 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 AddFundingAccountRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this AddFundingAccountRequest. # 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 AddFundingAccountRequest. # noqa: E501
Return type: dict(str, str)

property expiry_date¶

Gets the expiry_date of this AddFundingAccountRequest. # 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 AddFundingAccountRequest. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this AddFundingAccountRequest. # noqa: E501

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

Returns: The nickname of this AddFundingAccountRequest. # noqa: E501
Return type: str

swagger_types = {'aba_routing_number': 'str', 'account_holder_name': 'str', 'account_holder_type': 'str', 'account_number': 'str', 'account_subtype': 'str', 'address': 'FundingAccountAddress', 'card_cvv_number': 'str', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'expiry_date': 'str', 'nickname': 'str'}¶

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

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

orbipay_paymentsapi_client.models.address_vo module¶

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

class orbipay_paymentsapi_client.models.address_vo.AddressVo(address_line1=None, address_line2=None, address_city=None, address_state=None, address_country=None, address_zip1=None, address_zip2=None)¶

Bases: object

NOTE:

property address_city¶

Gets the address_city of this AddressVo. # noqa: E501

City of the address. # noqa: E501

Returns: The address_city of this AddressVo. # noqa: E501
Return type: str

property address_country¶

Gets the address_country of this AddressVo. # noqa: E501

The 3 letter country code as per ISO 3166-1 (alpha-3). # noqa: E501

Returns: The address_country of this AddressVo. # noqa: E501
Return type: str

property address_line1¶

Gets the address_line1 of this AddressVo. # noqa: E501

Line one of the address. # noqa: E501

Returns: The address_line1 of this AddressVo. # noqa: E501
Return type: str

property address_line2¶

Gets the address_line2 of this AddressVo. # noqa: E501

Line two of the address. # noqa: E501

Returns: The address_line2 of this AddressVo. # noqa: E501
Return type: str

property address_state¶

Gets the address_state of this AddressVo. # noqa: E501

The state or province code as per ISO_3166-2. # noqa: E501

Returns: The address_state of this AddressVo. # noqa: E501
Return type: str

property address_zip1¶

Gets the address_zip1 of this AddressVo. # noqa: E501

The first part of the postal code for the address as per the system followed in the appropriate country where it belongs. In the case of US, it’s the 5 digit postal code used by the US Postal Service. # noqa: E501

Returns: The address_zip1 of this AddressVo. # noqa: E501
Return type: str

property address_zip2¶

Gets the address_zip2 of this AddressVo. # noqa: E501

The 4 digit add-on code used, in addition to the 5 digit postal code, by the US Postal Service.This is not applicable and will be ignored in the case of non-US addresses. # noqa: E501

Returns: The address_zip2 of this AddressVo. # noqa: E501
Return type: str

attribute_map = {'address_city': 'address_city', 'address_country': 'address_country', 'address_line1': 'address_line1', 'address_line2': 'address_line2', 'address_state': 'address_state', 'address_zip1': 'address_zip1', 'address_zip2': 'address_zip2'}¶

swagger_types = {'address_city': 'str', 'address_country': 'str', 'address_line1': 'str', 'address_line2': 'str', 'address_state': 'str', 'address_zip1': 'str', 'address_zip2': 'str'}¶

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

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

orbipay_paymentsapi_client.models.audit_info_vo module¶

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

class orbipay_paymentsapi_client.models.audit_info_vo.AuditInfoVo(created=None, last_modified=None)¶

Bases: object

NOTE:

attribute_map = {'created': 'created', 'last_modified': 'last_modified'}¶

property created¶

Gets the created of this AuditInfoVo. # noqa: E501

Returns: The created of this AuditInfoVo. # noqa: E501
Return type: ResourceAuditVo

property last_modified¶

Gets the last_modified of this AuditInfoVo. # noqa: E501

Returns: The last_modified of this AuditInfoVo. # noqa: E501
Return type: ResourceAuditVo

swagger_types = {'created': 'ResourceAuditVo', 'last_modified': 'ResourceAuditVo'}¶

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

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

orbipay_paymentsapi_client.models.create_customer_account_request module¶

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

class orbipay_paymentsapi_client.models.create_customer_account_request.CreateCustomerAccountRequest(account_holder_name=None, nickname=None, address=None, customer_account_reference=None, account_number=None, current_balance=None, current_statement_balance=None, minimum_payment_due=None, past_amount_due=None, payment_due_date=None, statement_date=None, custom_fields=None)¶

Bases: object

NOTE:

property account_holder_name¶

Gets the account_holder_name of this CreateCustomerAccountRequest. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this CreateCustomerAccountRequest. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this CreateCustomerAccountRequest. # noqa: E501

The number or reference that a customer uses to identify the customer’s account. # noqa: E501

Returns: The account_number of this CreateCustomerAccountRequest. # noqa: E501
Return type: str

property address¶

Gets the address of this CreateCustomerAccountRequest. # noqa: E501

Returns: The address of this CreateCustomerAccountRequest. # noqa: E501
Return type: AddressVo

attribute_map = {'account_holder_name': 'account_holder_name', 'account_number': 'account_number', 'address': 'address', 'current_balance': 'current_balance', 'current_statement_balance': 'current_statement_balance', 'custom_fields': 'custom_fields', 'customer_account_reference': 'customer_account_reference', 'minimum_payment_due': 'minimum_payment_due', 'nickname': 'nickname', 'past_amount_due': 'past_amount_due', 'payment_due_date': 'payment_due_date', 'statement_date': 'statement_date'}¶

property current_balance¶

Gets the current_balance of this CreateCustomerAccountRequest. # noqa: E501

The current balance on the customer’s account with the biller. # noqa: E501

Returns: The current_balance of this CreateCustomerAccountRequest. # noqa: E501
Return type: str

property current_statement_balance¶

Gets the current_statement_balance of this CreateCustomerAccountRequest. # 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 CreateCustomerAccountRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this CreateCustomerAccountRequest. # 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 CreateCustomerAccountRequest. # noqa: E501
Return type: dict(str, str)

property customer_account_reference¶

Gets the customer_account_reference of this CreateCustomerAccountRequest. # noqa: E501

The unique identifier in the client system for the customer account. # noqa: E501

Returns: The customer_account_reference of this CreateCustomerAccountRequest. # noqa: E501
Return type: str

property minimum_payment_due¶

Gets the minimum_payment_due of this CreateCustomerAccountRequest. # 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 CreateCustomerAccountRequest. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this CreateCustomerAccountRequest. # noqa: E501

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

Returns: The nickname of this CreateCustomerAccountRequest. # noqa: E501
Return type: str

property past_amount_due¶

Gets the past_amount_due of this CreateCustomerAccountRequest. # 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 CreateCustomerAccountRequest. # noqa: E501
Return type: str

property payment_due_date¶

Gets the payment_due_date of this CreateCustomerAccountRequest. # 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 CreateCustomerAccountRequest. # noqa: E501
Return type: str

property statement_date¶

Gets the statement_date of this CreateCustomerAccountRequest. # 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 CreateCustomerAccountRequest. # noqa: E501
Return type: str

swagger_types = {'account_holder_name': 'str', 'account_number': 'str', 'address': 'AddressVo', 'current_balance': 'str', 'current_statement_balance': 'str', 'custom_fields': 'dict(str, str)', 'customer_account_reference': 'str', 'minimum_payment_due': 'str', 'nickname': 'str', 'past_amount_due': 'str', 'payment_due_date': 'str', 'statement_date': 'str'}¶

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

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

orbipay_paymentsapi_client.models.create_customer_request module¶

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

class orbipay_paymentsapi_client.models.create_customer_request.CreateCustomerRequest(customer_accounts=None, comments=None, customer_reference=None, first_name=None, last_name=None, middle_name=None, gender=None, date_of_birth=None, ssn=None, locale=None, email=None, registered_email=None, home_phone=None, work_phone=None, mobile_phone=None, address=None, custom_fields=None)¶

Bases: object

NOTE:

property address¶

Gets the address of this CreateCustomerRequest. # noqa: E501

Returns: The address of this CreateCustomerRequest. # noqa: E501
Return type: AddressVo

attribute_map = {'address': 'address', 'comments': 'comments', 'custom_fields': 'custom_fields', 'customer_accounts': 'customer_accounts', 'customer_reference': 'customer_reference', 'date_of_birth': 'date_of_birth', 'email': 'email', 'first_name': 'first_name', 'gender': 'gender', 'home_phone': 'home_phone', 'last_name': 'last_name', 'locale': 'locale', 'middle_name': 'middle_name', 'mobile_phone': 'mobile_phone', 'registered_email': 'registered_email', 'ssn': 'ssn', 'work_phone': 'work_phone'}¶

property comments¶

Gets the comments of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: dict(str, str)

property customer_accounts¶

Gets the customer_accounts of this CreateCustomerRequest. # noqa: E501

Returns: The customer_accounts of this CreateCustomerRequest. # noqa: E501
Return type: list[CreateCustomerAccountRequest]

property customer_reference¶

Gets the customer_reference of this CreateCustomerRequest. # noqa: E501

The unique identifier in the client system for the customer. # noqa: E501

Returns: The customer_reference of this CreateCustomerRequest. # noqa: E501
Return type: str

property date_of_birth¶

Gets the date_of_birth of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

property email¶

Gets the email of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

property first_name¶

Gets the first_name of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

property gender¶

Gets the gender of this CreateCustomerRequest. # noqa: E501

The gender of the customer. # noqa: E501

Returns: The gender of this CreateCustomerRequest. # noqa: E501
Return type: str

property home_phone¶

Gets the home_phone of this CreateCustomerRequest. # noqa: E501

The home phone number of the customer. # noqa: E501

Returns: The home_phone of this CreateCustomerRequest. # noqa: E501
Return type: str

property last_name¶

Gets the last_name of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

property locale¶

Gets the locale of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

property middle_name¶

Gets the middle_name of this CreateCustomerRequest. # noqa: E501

The middle name of the customer. # noqa: E501

Returns: The middle_name of this CreateCustomerRequest. # noqa: E501
Return type: str

property mobile_phone¶

Gets the mobile_phone of this CreateCustomerRequest. # noqa: E501

The mobile phone number of the customer. # noqa: E501

Returns: The mobile_phone of this CreateCustomerRequest. # noqa: E501
Return type: str

property registered_email¶

Gets the registered_email of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

property ssn¶

Gets the ssn of this CreateCustomerRequest. # 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 CreateCustomerRequest. # noqa: E501
Return type: str

swagger_types = {'address': 'AddressVo', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer_accounts': 'list[CreateCustomerAccountRequest]', 'customer_reference': 'str', 'date_of_birth': 'str', 'email': 'str', 'first_name': 'str', 'gender': 'str', 'home_phone': 'str', 'last_name': 'str', 'locale': 'str', 'middle_name': 'str', 'mobile_phone': 'str', 'registered_email': 'str', 'ssn': 'str', 'work_phone': 'str'}¶

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

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

property work_phone¶

Gets the work_phone of this CreateCustomerRequest. # noqa: E501

The work phone number of the customer. # noqa: E501

Returns: The work_phone of this CreateCustomerRequest. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.create_payment_request module¶

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

class orbipay_paymentsapi_client.models.create_payment_request.CreatePaymentRequest(amount=None, card_cvv_number=None, payment_date=None, payment_request_date=None, payment_amount_type=None, fee=None, customer=None, funding_account=None, customer_account=None, payment_reference=None, payment_notification_email=None, comments=None, custom_fields=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: str

attribute_map = {'amount': 'amount', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'fee': 'fee', 'funding_account': 'funding_account', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_notification_email': 'payment_notification_email', 'payment_reference': 'payment_reference', 'payment_request_date': 'payment_request_date'}¶

property card_cvv_number¶

Gets the card_cvv_number of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: str

property comments¶

Gets the comments of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this CreatePaymentRequest. # noqa: E501

Returns: The customer of this CreatePaymentRequest. # noqa: E501
Return type: CustomerMinimalRequest

property customer_account¶

Gets the customer_account of this CreatePaymentRequest. # noqa: E501

Returns: The customer_account of this CreatePaymentRequest. # noqa: E501
Return type: CustomerAccountMinimalRequest

property fee¶

Gets the fee of this CreatePaymentRequest. # noqa: E501

Returns: The fee of this CreatePaymentRequest. # noqa: E501
Return type: FeeRequest

property funding_account¶

Gets the funding_account of this CreatePaymentRequest. # noqa: E501

Returns: The funding_account of this CreatePaymentRequest. # noqa: E501
Return type: FundingAccountMinimalRequest

property payment_amount_type¶

Gets the payment_amount_type of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: str

property payment_notification_email¶

Gets the payment_notification_email of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this CreatePaymentRequest. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this CreatePaymentRequest. # noqa: E501
Return type: str

property payment_request_date¶

Gets the payment_request_date of this CreatePaymentRequest. # 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 CreatePaymentRequest. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'card_cvv_number': 'str', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'CustomerMinimalRequest', 'customer_account': 'CustomerAccountMinimalRequest', 'fee': 'FeeRequest', 'funding_account': 'FundingAccountMinimalRequest', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_notification_email': 'str', 'payment_reference': 'str', 'payment_request_date': 'str'}¶

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

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

orbipay_paymentsapi_client.models.create_payment_setup_request module¶

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

class orbipay_paymentsapi_client.models.create_payment_setup_request.CreatePaymentSetupRequest(payment_setup_reference=None, payment_setup_schedule_type=None, amount=None, card_cvv_number=None, fee=None, customer=None, funding_account=None, customer_account=None, payment_schedule=None, custom_fields=None, comments=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this CreatePaymentSetupRequest. # 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 CreatePaymentSetupRequest. # noqa: E501
Return type: str

attribute_map = {'amount': 'amount', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'fee': 'fee', 'funding_account': 'funding_account', 'payment_schedule': 'payment_schedule', 'payment_setup_reference': 'payment_setup_reference', 'payment_setup_schedule_type': 'payment_setup_schedule_type'}¶

property card_cvv_number¶

Gets the card_cvv_number of this CreatePaymentSetupRequest. # 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 CreatePaymentSetupRequest. # noqa: E501
Return type: str

property comments¶

Gets the comments of this CreatePaymentSetupRequest. # 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 CreatePaymentSetupRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this CreatePaymentSetupRequest. # 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 CreatePaymentSetupRequest. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this CreatePaymentSetupRequest. # noqa: E501

Returns: The customer of this CreatePaymentSetupRequest. # noqa: E501
Return type: CustomerMinimalRequest

property customer_account¶

Gets the customer_account of this CreatePaymentSetupRequest. # noqa: E501

Returns: The customer_account of this CreatePaymentSetupRequest. # noqa: E501
Return type: CustomerAccountMinimalRequest

property fee¶

Gets the fee of this CreatePaymentSetupRequest. # noqa: E501

Returns: The fee of this CreatePaymentSetupRequest. # noqa: E501
Return type: FeeRequest

property funding_account¶

Gets the funding_account of this CreatePaymentSetupRequest. # noqa: E501

Returns: The funding_account of this CreatePaymentSetupRequest. # noqa: E501
Return type: FundingAccountMinimalRequest

property payment_schedule¶

Gets the payment_schedule of this CreatePaymentSetupRequest. # noqa: E501

Returns: The payment_schedule of this CreatePaymentSetupRequest. # noqa: E501
Return type: PaymentScheduleVo

property payment_setup_reference¶

Gets the payment_setup_reference of this CreatePaymentSetupRequest. # noqa: E501

The unique identifier in the client system for the paymentSetup. # noqa: E501

Returns: The payment_setup_reference of this CreatePaymentSetupRequest. # noqa: E501
Return type: str

property payment_setup_schedule_type¶

Gets the payment_setup_schedule_type of this CreatePaymentSetupRequest. # noqa: E501

The schedule type for the payment setup. # noqa: E501

Returns: The payment_setup_schedule_type of this CreatePaymentSetupRequest. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'card_cvv_number': 'str', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'CustomerMinimalRequest', 'customer_account': 'CustomerAccountMinimalRequest', 'fee': 'FeeRequest', 'funding_account': 'FundingAccountMinimalRequest', 'payment_schedule': 'PaymentScheduleVo', 'payment_setup_reference': 'str', 'payment_setup_schedule_type': 'str'}¶

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

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

orbipay_paymentsapi_client.models.create_refund_request module¶

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

class orbipay_paymentsapi_client.models.create_refund_request.CreateRefundRequest(refund_reference=None, refund_amount=None, fee_refund=None, comments=None, custom_fields=None)¶

Bases: object

NOTE:

attribute_map = {'comments': 'comments', 'custom_fields': 'custom_fields', 'fee_refund': 'fee_refund', 'refund_amount': 'refund_amount', 'refund_reference': 'refund_reference'}¶

property comments¶

Gets the comments of this CreateRefundRequest. # 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 CreateRefundRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this CreateRefundRequest. # 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 CreateRefundRequest. # noqa: E501
Return type: dict(str, str)

property fee_refund¶

Gets the fee_refund of this CreateRefundRequest. # noqa: E501

Returns: The fee_refund of this CreateRefundRequest. # noqa: E501
Return type: FeeRefundRequest

property refund_amount¶

Gets the refund_amount of this CreateRefundRequest. # noqa: E501

The refund amount upto 2 decimal places. # noqa: E501

Returns: The refund_amount of this CreateRefundRequest. # noqa: E501
Return type: str

property refund_reference¶

Gets the refund_reference of this CreateRefundRequest. # noqa: E501

The unique identifier in the client system for the refund. # noqa: E501

Returns: The refund_reference of this CreateRefundRequest. # noqa: E501
Return type: str

swagger_types = {'comments': 'str', 'custom_fields': 'dict(str, str)', 'fee_refund': 'FeeRefundRequest', 'refund_amount': 'str', 'refund_reference': 'str'}¶

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

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

orbipay_paymentsapi_client.models.customer_account_minimal_request module¶

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

class orbipay_paymentsapi_client.models.customer_account_minimal_request.CustomerAccountMinimalRequest(id=None)¶

Bases: object

NOTE:

attribute_map = {'id': 'id'}¶

property id¶

Gets the id of this CustomerAccountMinimalRequest. # noqa: E501

Id is a unique identifier assigned to the account in EBPP. # noqa: E501

Returns: The id of this CustomerAccountMinimalRequest. # noqa: E501
Return type: str

swagger_types = {'id': 'str'}¶

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

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

orbipay_paymentsapi_client.models.customer_account_response module¶

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

class orbipay_paymentsapi_client.models.customer_account_response.CustomerAccountResponse(account_holder_name=None, nickname=None, address=None, customer_account_reference=None, account_number=None, current_balance=None, current_statement_balance=None, minimum_payment_due=None, past_amount_due=None, payment_due_date=None, statement_date=None, id=None, url=None, status=None, custom_fields=None, comments=None, audit_info=None)¶

Bases: object

NOTE:

property account_holder_name¶

Gets the account_holder_name of this CustomerAccountResponse. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this CustomerAccountResponse. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this CustomerAccountResponse. # noqa: E501

The number or reference that a customer uses to identify the customer’s account. # noqa: E501

Returns: The account_number of this CustomerAccountResponse. # noqa: E501
Return type: str

property address¶

Gets the address of this CustomerAccountResponse. # noqa: E501

Returns: The address of this CustomerAccountResponse. # noqa: E501
Return type: AddressVo

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', '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 CustomerAccountResponse. # noqa: E501

Returns: The audit_info of this CustomerAccountResponse. # noqa: E501
Return type: AuditInfoVo

property comments¶

Gets the comments of this CustomerAccountResponse. # 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 CustomerAccountResponse. # noqa: E501
Return type: str

property current_balance¶

Gets the current_balance of this CustomerAccountResponse. # noqa: E501

The current balance on the customer’s account with the biller. # noqa: E501

Returns: The current_balance of this CustomerAccountResponse. # noqa: E501
Return type: str

property current_statement_balance¶

Gets the current_statement_balance of this CustomerAccountResponse. # 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 CustomerAccountResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this CustomerAccountResponse. # 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 CustomerAccountResponse. # noqa: E501
Return type: dict(str, str)

property customer_account_reference¶

Gets the customer_account_reference of this CustomerAccountResponse. # noqa: E501

The unique identifier in the client system for the customer account. # noqa: E501

Returns: The customer_account_reference of this CustomerAccountResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this CustomerAccountResponse. # noqa: E501

Id is a unique identifier assigned to the customer account in EBPP. # noqa: E501

Returns: The id of this CustomerAccountResponse. # noqa: E501
Return type: str

property minimum_payment_due¶

Gets the minimum_payment_due of this CustomerAccountResponse. # 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 CustomerAccountResponse. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this CustomerAccountResponse. # noqa: E501

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

Returns: The nickname of this CustomerAccountResponse. # noqa: E501
Return type: str

property past_amount_due¶

Gets the past_amount_due of this CustomerAccountResponse. # 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 CustomerAccountResponse. # noqa: E501
Return type: str

property payment_due_date¶

Gets the payment_due_date of this CustomerAccountResponse. # 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 CustomerAccountResponse. # noqa: E501
Return type: str

property statement_date¶

Gets the statement_date of this CustomerAccountResponse. # 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 CustomerAccountResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this CustomerAccountResponse. # noqa: E501

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

Returns: The status of this CustomerAccountResponse. # noqa: E501
Return type: str

swagger_types = {'account_holder_name': 'str', 'account_number': 'str', 'address': 'AddressVo', 'audit_info': 'AuditInfoVo', 'comments': 'str', 'current_balance': 'str', 'current_statement_balance': 'str', 'custom_fields': 'dict(str, str)', 'customer_account_reference': 'str', 'id': '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 CustomerAccountResponse. # noqa: E501

This URL fetches the Account details. # noqa: E501

Returns: The url of this CustomerAccountResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customer_account_snapshot_response module¶

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

class orbipay_paymentsapi_client.models.customer_account_snapshot_response.CustomerAccountSnapshotResponse(account_number=None, id=None, url=None)¶

Bases: object

NOTE:

property account_number¶

Gets the account_number of this CustomerAccountSnapshotResponse. # noqa: E501

The number or reference that a customer uses to identify the customer’s account. # noqa: E501

Returns: The account_number of this CustomerAccountSnapshotResponse. # noqa: E501
Return type: str

attribute_map = {'account_number': 'account_number', 'id': 'id', 'url': 'url'}¶

property id¶

Gets the id of this CustomerAccountSnapshotResponse. # noqa: E501

Id is a unique identifier assigned to the account in EBPP. # noqa: E501

Returns: The id of this CustomerAccountSnapshotResponse. # noqa: E501
Return type: str

swagger_types = {'account_number': '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 CustomerAccountSnapshotResponse. # noqa: E501

This URL fetches the customer account details. # noqa: E501

Returns: The url of this CustomerAccountSnapshotResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customer_accounts_response module¶

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

class orbipay_paymentsapi_client.models.customer_accounts_response.CustomerAccountsResponse(list=None, total_results_count=None, has_more_results=None, url=None, from_index=None, to_index=None, query_id=None)¶

Bases: object

NOTE:

attribute_map = {'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'query_id': 'query_id', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property from_index¶

Gets the from_index of this CustomerAccountsResponse. # 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 CustomerAccountsResponse. # noqa: E501
Return type: str

property has_more_results¶

Gets the has_more_results of this CustomerAccountsResponse. # noqa: E501

true if there are more results or pages # noqa: E501

Returns: The has_more_results of this CustomerAccountsResponse. # noqa: E501
Return type: str

property list¶

Gets the list of this CustomerAccountsResponse. # noqa: E501

Returns: The list of this CustomerAccountsResponse. # noqa: E501
Return type: list[CustomerAccountResponse]

property query_id¶

Gets the query_id of this CustomerAccountsResponse. # noqa: E501

The query id of the object. # noqa: E501

Returns: The query_id of this CustomerAccountsResponse. # noqa: E501
Return type: str

swagger_types = {'from_index': 'str', 'has_more_results': 'str', 'list': 'list[CustomerAccountResponse]', 'query_id': '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 CustomerAccountsResponse. # 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 CustomerAccountsResponse. # noqa: E501
Return type: str

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

property total_results_count¶

Gets the total_results_count of this CustomerAccountsResponse. # noqa: E501

total number of Customer accounts of customer available with matching criteria # noqa: E501

Returns: The total_results_count of this CustomerAccountsResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this CustomerAccountsResponse. # 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 CustomerAccountsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customer_minimal_request module¶

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

class orbipay_paymentsapi_client.models.customer_minimal_request.CustomerMinimalRequest(id=None)¶

Bases: object

NOTE:

attribute_map = {'id': 'id'}¶

property id¶

Gets the id of this CustomerMinimalRequest. # noqa: E501

The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id of this CustomerMinimalRequest. # noqa: E501
Return type: str

swagger_types = {'id': 'str'}¶

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

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

orbipay_paymentsapi_client.models.customer_response module¶

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

class orbipay_paymentsapi_client.models.customer_response.CustomerResponse(first_name=None, last_name=None, middle_name=None, gender=None, date_of_birth=None, ssn=None, locale=None, email=None, registered_email=None, home_phone=None, work_phone=None, mobile_phone=None, address=None, custom_fields=None, customer_reference=None, id=None, status=None, url=None, comments=None, customer_accounts=None, funding_accounts=None, payments=None, payment_setups=None, audit_info=None)¶

Bases: object

NOTE:

property address¶

Gets the address of this CustomerResponse. # noqa: E501

Returns: The address of this CustomerResponse. # noqa: E501
Return type: AddressVo

attribute_map = {'address': 'address', 'audit_info': 'audit_info', 'comments': 'comments', 'custom_fields': 'custom_fields', 'customer_accounts': 'customer_accounts', 'customer_reference': 'customer_reference', 'date_of_birth': 'date_of_birth', 'email': 'email', 'first_name': 'first_name', 'funding_accounts': 'funding_accounts', 'gender': 'gender', 'home_phone': 'home_phone', 'id': 'id', 'last_name': 'last_name', 'locale': 'locale', 'middle_name': 'middle_name', 'mobile_phone': 'mobile_phone', 'payment_setups': 'payment_setups', 'payments': 'payments', 'registered_email': 'registered_email', 'ssn': 'ssn', 'status': 'status', 'url': 'url', 'work_phone': 'work_phone'}¶

property audit_info¶

Gets the audit_info of this CustomerResponse. # noqa: E501

Returns: The audit_info of this CustomerResponse. # noqa: E501
Return type: AuditInfoVo

property comments¶

Gets the comments of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: dict(str, str)

property customer_accounts¶

Gets the customer_accounts of this CustomerResponse. # noqa: E501

Returns: The customer_accounts of this CustomerResponse. # noqa: E501
Return type: CustomersCustomerAccountsResponse

property customer_reference¶

Gets the customer_reference of this CustomerResponse. # noqa: E501

The unique identifier in the client system for the customer. # noqa: E501

Returns: The customer_reference of this CustomerResponse. # noqa: E501
Return type: str

property date_of_birth¶

Gets the date_of_birth of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property email¶

Gets the email of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property first_name¶

Gets the first_name of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property funding_accounts¶

Gets the funding_accounts of this CustomerResponse. # noqa: E501

Returns: The funding_accounts of this CustomerResponse. # noqa: E501
Return type: CustomersFundingAccountsResponse

property gender¶

Gets the gender of this CustomerResponse. # noqa: E501

The gender of the customer. # noqa: E501

Returns: The gender of this CustomerResponse. # noqa: E501
Return type: str

property home_phone¶

Gets the home_phone of this CustomerResponse. # noqa: E501

The home phone number of the customer. # noqa: E501

Returns: The home_phone of this CustomerResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this CustomerResponse. # noqa: E501

The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id of this CustomerResponse. # noqa: E501
Return type: str

property last_name¶

Gets the last_name of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property locale¶

Gets the locale of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property middle_name¶

Gets the middle_name of this CustomerResponse. # noqa: E501

The middle name of the customer. # noqa: E501

Returns: The middle_name of this CustomerResponse. # noqa: E501
Return type: str

property mobile_phone¶

Gets the mobile_phone of this CustomerResponse. # noqa: E501

The mobile phone number of the customer. # noqa: E501

Returns: The mobile_phone of this CustomerResponse. # noqa: E501
Return type: str

property payment_setups¶

Gets the payment_setups of this CustomerResponse. # noqa: E501

Returns: The payment_setups of this CustomerResponse. # noqa: E501
Return type: CustomersPaymentSetupsResponse

property payments¶

Gets the payments of this CustomerResponse. # noqa: E501

Returns: The payments of this CustomerResponse. # noqa: E501
Return type: CustomersPaymentsResponse

property registered_email¶

Gets the registered_email of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property ssn¶

Gets the ssn of this CustomerResponse. # 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 CustomerResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this CustomerResponse. # noqa: E501

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

Returns: The status of this CustomerResponse. # noqa: E501
Return type: str

swagger_types = {'address': 'AddressVo', 'audit_info': 'AuditInfoVo', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer_accounts': 'CustomersCustomerAccountsResponse', 'customer_reference': 'str', 'date_of_birth': 'str', 'email': 'str', 'first_name': 'str', 'funding_accounts': 'CustomersFundingAccountsResponse', 'gender': 'str', 'home_phone': 'str', 'id': 'str', 'last_name': 'str', 'locale': 'str', 'middle_name': 'str', 'mobile_phone': 'str', 'payment_setups': 'CustomersPaymentSetupsResponse', 'payments': 'CustomersPaymentsResponse', '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

property url¶

Gets the url of this CustomerResponse. # noqa: E501

This URL fetches the Customer details. # noqa: E501

Returns: The url of this CustomerResponse. # noqa: E501
Return type: str

property work_phone¶

Gets the work_phone of this CustomerResponse. # noqa: E501

The work phone number of the customer. # noqa: E501

Returns: The work_phone of this CustomerResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customer_snapshot_response module¶

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

class orbipay_paymentsapi_client.models.customer_snapshot_response.CustomerSnapshotResponse(id=None, url=None, customer_reference=None, first_name=None, last_name=None, middle_name=None, email=None, home_phone=None, address=None)¶

Bases: object

NOTE:

property address¶

Gets the address of this CustomerSnapshotResponse. # noqa: E501

Returns: The address of this CustomerSnapshotResponse. # noqa: E501
Return type: AddressVo

attribute_map = {'address': 'address', 'customer_reference': 'customer_reference', 'email': 'email', 'first_name': 'first_name', 'home_phone': 'home_phone', 'id': 'id', 'last_name': 'last_name', 'middle_name': 'middle_name', 'url': 'url'}¶

property customer_reference¶

Gets the customer_reference of this CustomerSnapshotResponse. # noqa: E501

The unique identifier in the client system for the customer. # noqa: E501

Returns: The customer_reference of this CustomerSnapshotResponse. # noqa: E501
Return type: str

property email¶

Gets the email of this CustomerSnapshotResponse. # 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 CustomerSnapshotResponse. # noqa: E501
Return type: str

property first_name¶

Gets the first_name of this CustomerSnapshotResponse. # noqa: E501

The first name of the customer. # noqa: E501

Returns: The first_name of this CustomerSnapshotResponse. # noqa: E501
Return type: str

property home_phone¶

Gets the home_phone of this CustomerSnapshotResponse. # noqa: E501

The home phone number of the customer. # noqa: E501

Returns: The home_phone of this CustomerSnapshotResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this CustomerSnapshotResponse. # noqa: E501

The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id of this CustomerSnapshotResponse. # noqa: E501
Return type: str

property last_name¶

Gets the last_name of this CustomerSnapshotResponse. # noqa: E501

The last name of the customer. # noqa: E501

Returns: The last_name of this CustomerSnapshotResponse. # noqa: E501
Return type: str

property middle_name¶

Gets the middle_name of this CustomerSnapshotResponse. # noqa: E501

The middle initial of the customer. # noqa: E501

Returns: The middle_name of this CustomerSnapshotResponse. # noqa: E501
Return type: str

swagger_types = {'address': 'AddressVo', 'customer_reference': 'str', 'email': 'str', 'first_name': 'str', 'home_phone': 'str', 'id': 'str', 'last_name': 'str', 'middle_name': '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 CustomerSnapshotResponse. # noqa: E501

The URL that can be used to fetch the details of the customer. # noqa: E501

Returns: The url of this CustomerSnapshotResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customers_customer_accounts_response module¶

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

class orbipay_paymentsapi_client.models.customers_customer_accounts_response.CustomersCustomerAccountsResponse(list=None, url=None)¶

Bases: object

NOTE:

attribute_map = {'list': 'list', 'url': 'url'}¶

property list¶

Gets the list of this CustomersCustomerAccountsResponse. # noqa: E501

Returns: The list of this CustomersCustomerAccountsResponse. # noqa: E501
Return type: list[CustomerAccountResponse]

swagger_types = {'list': 'list[CustomerAccountResponse]', '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 CustomersCustomerAccountsResponse. # noqa: E501

This URL fetches the list of Customer accounts of a customer. # noqa: E501

Returns: The url of this CustomersCustomerAccountsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customers_funding_accounts_response module¶

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

class orbipay_paymentsapi_client.models.customers_funding_accounts_response.CustomersFundingAccountsResponse(url=None)¶

Bases: object

NOTE:

attribute_map = {'url': 'url'}¶

swagger_types = {'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 CustomersFundingAccountsResponse. # noqa: E501

This URL fetches the list of Funding accounts of a customer. # noqa: E501

Returns: The url of this CustomersFundingAccountsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customers_payment_setups_response module¶

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

class orbipay_paymentsapi_client.models.customers_payment_setups_response.CustomersPaymentSetupsResponse(url=None)¶

Bases: object

NOTE:

attribute_map = {'url': 'url'}¶

swagger_types = {'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 CustomersPaymentSetupsResponse. # noqa: E501

This URL fetches the list of payment setups of a customer. # noqa: E501

Returns: The url of this CustomersPaymentSetupsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customers_payments_response module¶

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

class orbipay_paymentsapi_client.models.customers_payments_response.CustomersPaymentsResponse(url=None)¶

Bases: object

NOTE:

attribute_map = {'url': 'url'}¶

swagger_types = {'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 CustomersPaymentsResponse. # noqa: E501

This URL fetches the list of payments of a customer. # noqa: E501

Returns: The url of this CustomersPaymentsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.customers_response module¶

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

class orbipay_paymentsapi_client.models.customers_response.CustomersResponse(list=None, total_results_count=None, has_more_results=None, url=None, from_index=None, to_index=None, query_id=None)¶

Bases: object

NOTE:

attribute_map = {'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'query_id': 'query_id', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property from_index¶

Gets the from_index of this CustomersResponse. # 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 CustomersResponse. # noqa: E501
Return type: str

property has_more_results¶

Gets the has_more_results of this CustomersResponse. # noqa: E501

true if there are more results or pages # noqa: E501

Returns: The has_more_results of this CustomersResponse. # noqa: E501
Return type: str

property list¶

Gets the list of this CustomersResponse. # noqa: E501

Returns: The list of this CustomersResponse. # noqa: E501
Return type: list[CustomerResponse]

property query_id¶

Gets the query_id of this CustomersResponse. # noqa: E501

The query id of the object. # noqa: E501

Returns: The query_id of this CustomersResponse. # noqa: E501
Return type: str

swagger_types = {'from_index': 'str', 'has_more_results': 'str', 'list': 'list[CustomerResponse]', 'query_id': '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 CustomersResponse. # 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 CustomersResponse. # noqa: E501
Return type: str

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

property total_results_count¶

Gets the total_results_count of this CustomersResponse. # noqa: E501

The total number of customers available matching the search criteria. # noqa: E501

Returns: The total_results_count of this CustomersResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this CustomersResponse. # 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 CustomersResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.delete_funding_account_request module¶

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

class orbipay_paymentsapi_client.models.delete_funding_account_request.DeleteFundingAccountRequest(comments=None)¶

Bases: object

NOTE:

attribute_map = {'comments': 'comments'}¶

property comments¶

Gets the comments of this DeleteFundingAccountRequest. # 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 DeleteFundingAccountRequest. # noqa: E501
Return type: str

swagger_types = {'comments': 'str'}¶

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

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

orbipay_paymentsapi_client.models.delete_payment_request module¶

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

class orbipay_paymentsapi_client.models.delete_payment_request.DeletePaymentRequest(comments=None)¶

Bases: object

NOTE:

attribute_map = {'comments': 'comments'}¶

property comments¶

Gets the comments of this DeletePaymentRequest. # 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 DeletePaymentRequest. # noqa: E501
Return type: str

swagger_types = {'comments': 'str'}¶

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

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

orbipay_paymentsapi_client.models.delete_payment_setup_request module¶

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

class orbipay_paymentsapi_client.models.delete_payment_setup_request.DeletePaymentSetupRequest(comments=None)¶

Bases: object

NOTE:

attribute_map = {'comments': 'comments'}¶

property comments¶

Gets the comments of this DeletePaymentSetupRequest. # 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 DeletePaymentSetupRequest. # noqa: E501
Return type: str

swagger_types = {'comments': 'str'}¶

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

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

orbipay_paymentsapi_client.models.delete_recorded_payment_request module¶

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

class orbipay_paymentsapi_client.models.delete_recorded_payment_request.DeleteRecordedPaymentRequest(comments=None)¶

Bases: object

NOTE:

attribute_map = {'comments': 'comments'}¶

property comments¶

Gets the comments of this DeleteRecordedPaymentRequest. # 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 DeleteRecordedPaymentRequest. # noqa: E501
Return type: str

swagger_types = {'comments': 'str'}¶

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

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

orbipay_paymentsapi_client.models.delete_response module¶

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

class orbipay_paymentsapi_client.models.delete_response.DeleteResponse(deleted=None, id=None)¶

Bases: object

NOTE:

attribute_map = {'deleted': 'deleted', 'id': 'id'}¶

property deleted¶

Gets the deleted of this DeleteResponse. # noqa: E501

Returns: The deleted of this DeleteResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this DeleteResponse. # noqa: E501

The id of the deleted resource. # noqa: E501

Returns: The id of this DeleteResponse. # noqa: E501
Return type: str

swagger_types = {'deleted': 'str', 'id': 'str'}¶

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

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

orbipay_paymentsapi_client.models.error_response_vo module¶

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

class orbipay_paymentsapi_client.models.error_response_vo.ErrorResponseVo(errors=None)¶

Bases: object

NOTE:

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

property errors¶

Gets the errors of this ErrorResponseVo. # noqa: E501

Returns: The errors of this ErrorResponseVo. # noqa: E501
Return type: list[ErrorVo]

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

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

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

orbipay_paymentsapi_client.models.error_vo module¶

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

class orbipay_paymentsapi_client.models.error_vo.ErrorVo(code=None, message=None, field=None)¶

Bases: object

NOTE:

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

property code¶

Gets the code of this ErrorVo. # noqa: E501

A string indicating error # noqa: E501

Returns: The code of this ErrorVo. # noqa: E501
Return type: str

property field¶

Gets the field of this ErrorVo. # noqa: E501

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

Returns: The field of this ErrorVo. # noqa: E501
Return type: str

property message¶

Gets the message of this ErrorVo. # noqa: E501

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

Returns: The message of this ErrorVo. # noqa: E501
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

orbipay_paymentsapi_client.models.fee_refund_request module¶

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

class orbipay_paymentsapi_client.models.fee_refund_request.FeeRefundRequest(fee_refund_amount=None)¶

Bases: object

NOTE:

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

property fee_refund_amount¶

Gets the fee_refund_amount of this FeeRefundRequest. # noqa: E501

The fee amount upto 2 decimal places. # noqa: E501

Returns: The fee_refund_amount of this FeeRefundRequest. # noqa: E501
Return type: str

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

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

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

orbipay_paymentsapi_client.models.fee_refund_response module¶

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

class orbipay_paymentsapi_client.models.fee_refund_response.FeeRefundResponse(fee_refund_amount=None, fee_type=None)¶

Bases: object

NOTE:

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

property fee_refund_amount¶

Gets the fee_refund_amount of this FeeRefundResponse. # noqa: E501

The refunded fee amount upto 2 decimal places. # noqa: E501

Returns: The fee_refund_amount of this FeeRefundResponse. # noqa: E501
Return type: str

property fee_type¶

Gets the fee_type of this FeeRefundResponse. # 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 FeeRefundResponse. # noqa: E501
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

orbipay_paymentsapi_client.models.fee_request module¶

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

class orbipay_paymentsapi_client.models.fee_request.FeeRequest(fee_amount=None)¶

Bases: object

NOTE:

attribute_map = {'fee_amount': 'fee_amount'}¶

property fee_amount¶

Gets the fee_amount of this FeeRequest. # noqa: E501

The fee amount upto 2 decimal places. # noqa: E501

Returns: The fee_amount of this FeeRequest. # noqa: E501
Return type: str

swagger_types = {'fee_amount': 'str'}¶

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

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

orbipay_paymentsapi_client.models.fee_response module¶

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

class orbipay_paymentsapi_client.models.fee_response.FeeResponse(fee_type=None, fee_amount=None, id=None, url=None)¶

Bases: object

NOTE:

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

property fee_amount¶

Gets the fee_amount of this FeeResponse. # noqa: E501

The fee amount upto 2 decimal places. # noqa: E501

Returns: The fee_amount of this FeeResponse. # noqa: E501
Return type: str

property fee_type¶

Gets the fee_type of this FeeResponse. # 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 FeeResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this FeeResponse. # noqa: E501

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

Returns: The id of this FeeResponse. # noqa: E501
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 FeeResponse. # 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 FeeResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.funding_account_address module¶

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

class orbipay_paymentsapi_client.models.funding_account_address.FundingAccountAddress(address_line1=None, address_line2=None, address_city=None, address_state=None, address_country=None, address_zip1=None, address_zip2=None)¶

Bases: object

NOTE:

property address_city¶

Gets the address_city of this FundingAccountAddress. # noqa: E501

City of the address. # noqa: E501

Returns: The address_city of this FundingAccountAddress. # noqa: E501
Return type: str

property address_country¶

Gets the address_country of this FundingAccountAddress. # noqa: E501

The 3 letter country code as per ISO 3166-1 (alpha-3). # noqa: E501

Returns: The address_country of this FundingAccountAddress. # noqa: E501
Return type: str

property address_line1¶

Gets the address_line1 of this FundingAccountAddress. # noqa: E501

Line one of the address. # noqa: E501

Returns: The address_line1 of this FundingAccountAddress. # noqa: E501
Return type: str

property address_line2¶

Gets the address_line2 of this FundingAccountAddress. # noqa: E501

Line two of the address. # noqa: E501

Returns: The address_line2 of this FundingAccountAddress. # noqa: E501
Return type: str

property address_state¶

Gets the address_state of this FundingAccountAddress. # noqa: E501

The state or province code as per ISO_3166-2. # noqa: E501

Returns: The address_state of this FundingAccountAddress. # noqa: E501
Return type: str

property address_zip1¶

Gets the address_zip1 of this FundingAccountAddress. # noqa: E501

The first part of the postal code for the address as per the system followed in the appropriate country where it belongs. In the case of US, it’s the 5 digit postal code used by the US Postal Service. # noqa: E501

Returns: The address_zip1 of this FundingAccountAddress. # noqa: E501
Return type: str

property address_zip2¶

Gets the address_zip2 of this FundingAccountAddress. # noqa: E501

The 4 digit add-on code used, in addition to the 5 digit postal code, by the US Postal Service.This is not applicable and will be ignored in the case of non-US addresses. # noqa: E501

Returns: The address_zip2 of this FundingAccountAddress. # noqa: E501
Return type: str

attribute_map = {'address_city': 'address_city', 'address_country': 'address_country', 'address_line1': 'address_line1', 'address_line2': 'address_line2', 'address_state': 'address_state', 'address_zip1': 'address_zip1', 'address_zip2': 'address_zip2'}¶

swagger_types = {'address_city': 'str', 'address_country': 'str', 'address_line1': 'str', 'address_line2': 'str', 'address_state': 'str', 'address_zip1': 'str', 'address_zip2': 'str'}¶

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

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

orbipay_paymentsapi_client.models.funding_account_minimal_request module¶

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

class orbipay_paymentsapi_client.models.funding_account_minimal_request.FundingAccountMinimalRequest(id=None)¶

Bases: object

NOTE:

attribute_map = {'id': 'id'}¶

property id¶

Gets the id of this FundingAccountMinimalRequest. # noqa: E501

Id is a unique identifier assigned to the account in EBPP. # noqa: E501

Returns: The id of this FundingAccountMinimalRequest. # noqa: E501
Return type: str

swagger_types = {'id': 'str'}¶

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

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

orbipay_paymentsapi_client.models.funding_account_response module¶

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

class orbipay_paymentsapi_client.models.funding_account_response.FundingAccountResponse(account_holder_name=None, nickname=None, address=None, account_number=None, aba_routing_number=None, issuer_name=None, currency_code3d=None, expiry_date=None, account_holder_type=None, custom_fields=None, account_subtype=None, id=None, url=None, ach_eligible_flag=None, atm_eligible_flag=None, card_cvv_number=None, account_type=None, status=None, display_text=None, comments=None, audit_info=None)¶

Bases: object

NOTE:

property aba_routing_number¶

Gets the aba_routing_number of this FundingAccountResponse. # noqa: E501

The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this FundingAccountResponse. # noqa: E501
Return type: str

property account_holder_name¶

Gets the account_holder_name of this FundingAccountResponse. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this FundingAccountResponse. # noqa: E501
Return type: str

property account_holder_type¶

Gets the account_holder_type of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: str

property account_subtype¶

Gets the account_subtype of this FundingAccountResponse. # 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/ApplePay account. For e.g., a savings account, a checking account. # noqa: E501

Returns: The account_subtype of this FundingAccountResponse. # noqa: E501
Return type: str

property account_type¶

Gets the account_type of this FundingAccountResponse. # noqa: E501

The type of the funding account. # noqa: E501

Returns: The account_type of this FundingAccountResponse. # noqa: E501
Return type: str

property ach_eligible_flag¶

Gets the ach_eligible_flag of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: str

property address¶

Gets the address of this FundingAccountResponse. # noqa: E501

Returns: The address of this FundingAccountResponse. # noqa: E501
Return type: FundingAccountAddress

property atm_eligible_flag¶

Gets the atm_eligible_flag of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
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', 'display_text': 'display_text', 'expiry_date': 'expiry_date', 'id': 'id', 'issuer_name': 'issuer_name', 'nickname': 'nickname', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this FundingAccountResponse. # noqa: E501

Returns: The audit_info of this FundingAccountResponse. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this FundingAccountResponse. # noqa: E501

This is never returned by EBPP. This needs to be passed to EBPP when adding or editing a card funding account. # noqa: E501

Returns: The card_cvv_number of this FundingAccountResponse. # noqa: E501
Return type: str

property comments¶

Gets the comments of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: dict(str, str)

property display_text¶

Gets the display_text of this FundingAccountResponse. # noqa: E501

UI representation of the account. # noqa: E501

Returns: The display_text of this FundingAccountResponse. # noqa: E501
Return type: str

property expiry_date¶

Gets the expiry_date of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this FundingAccountResponse. # noqa: E501

Id is a unique identifier assigned to the funding account in EBPP. A new Id is generated for the funding account when the account number is updated. # noqa: E501

Returns: The id of this FundingAccountResponse. # noqa: E501
Return type: str

property issuer_name¶

Gets the issuer_name of this FundingAccountResponse. # 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 FundingAccountResponse. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this FundingAccountResponse. # noqa: E501

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

Returns: The nickname of this FundingAccountResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this FundingAccountResponse. # noqa: E501

The status of the funding account in EBPP. # noqa: E501

Returns: The status of this FundingAccountResponse. # noqa: E501
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': 'FundingAccountAddress', 'atm_eligible_flag': 'str', 'audit_info': 'AuditInfoVo', 'card_cvv_number': 'str', 'comments': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'display_text': 'str', 'expiry_date': 'str', 'id': '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

property url¶

Gets the url of this FundingAccountResponse. # noqa: E501

This URL fetches the funding account details. # noqa: E501

Returns: The url of this FundingAccountResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.funding_account_response_cgen module¶

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

class orbipay_paymentsapi_client.models.funding_account_response_cgen.FundingAccountResponseCgen(account_holder_name=None, nickname=None, address=None, account_number=None, aba_routing_number=None, issuer_name=None, currency_code3d=None, expiry_date=None, account_holder_type=None, custom_fields=None, account_subtype=None, id=None, url=None, ach_eligible_flag=None, atm_eligible_flag=None, card_cvv_number=None, account_type=None, status=None, device_manufacturer_id=None, display_text=None, comments=None, deleted=None, audit_info=None)¶

Bases: object

NOTE:

property aba_routing_number¶

Gets the aba_routing_number of this FundingAccountResponseCgen. # noqa: E501

The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this FundingAccountResponseCgen. # noqa: E501
Return type: str

property account_holder_name¶

Gets the account_holder_name of this FundingAccountResponseCgen. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this FundingAccountResponseCgen. # noqa: E501
Return type: str

property account_holder_type¶

Gets the account_holder_type of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property account_subtype¶

Gets the account_subtype of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property account_type¶

Gets the account_type of this FundingAccountResponseCgen. # noqa: E501

The type of the funding account. # noqa: E501

Returns: The account_type of this FundingAccountResponseCgen. # noqa: E501
Return type: str

property ach_eligible_flag¶

Gets the ach_eligible_flag of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property address¶

Gets the address of this FundingAccountResponseCgen. # noqa: E501

Returns: The address of this FundingAccountResponseCgen. # noqa: E501
Return type: FundingAccountAddress

property atm_eligible_flag¶

Gets the atm_eligible_flag of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
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', 'issuer_name': 'issuer_name', 'nickname': 'nickname', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this FundingAccountResponseCgen. # noqa: E501

Returns: The audit_info of this FundingAccountResponseCgen. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property comments¶

Gets the comments of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: dict(str, str)

property deleted¶

Gets the deleted of this FundingAccountResponseCgen. # noqa: E501

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

Returns: The deleted of this FundingAccountResponseCgen. # noqa: E501
Return type: str

property device_manufacturer_id¶

Gets the device_manufacturer_id of this FundingAccountResponseCgen. # noqa: E501

This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier. # noqa: E501

Returns: The device_manufacturer_id of this FundingAccountResponseCgen. # noqa: E501
Return type: str

property display_text¶

Gets the display_text of this FundingAccountResponseCgen. # noqa: E501

UI representation of the account. # noqa: E501

Returns: The display_text of this FundingAccountResponseCgen. # noqa: E501
Return type: str

property expiry_date¶

Gets the expiry_date of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property id¶

Gets the id of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property issuer_name¶

Gets the issuer_name of this FundingAccountResponseCgen. # 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 FundingAccountResponseCgen. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this FundingAccountResponseCgen. # noqa: E501

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

Returns: The nickname of this FundingAccountResponseCgen. # noqa: E501
Return type: str

property status¶

Gets the status of this FundingAccountResponseCgen. # noqa: E501

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

Returns: The status of this FundingAccountResponseCgen. # noqa: E501
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': 'FundingAccountAddress', 'atm_eligible_flag': 'str', 'audit_info': 'AuditInfoVo', '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', '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

property url¶

Gets the url of this FundingAccountResponseCgen. # noqa: E501

This URL fetches the funding account details. # noqa: E501

Returns: The url of this FundingAccountResponseCgen. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.funding_account_snapshot_response module¶

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

class orbipay_paymentsapi_client.models.funding_account_snapshot_response.FundingAccountSnapshotResponse(id=None, url=None, account_number=None, account_type=None, account_subtype=None, aba_routing_number=None, issuer_name=None, nickname=None, display_text=None, account_holder_name=None)¶

Bases: object

NOTE:

property aba_routing_number¶

Gets the aba_routing_number of this FundingAccountSnapshotResponse. # noqa: E501

The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

property account_holder_name¶

Gets the account_holder_name of this FundingAccountSnapshotResponse. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this FundingAccountSnapshotResponse. # 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 FundingAccountSnapshotResponse. # noqa: E501
Return type: str

property account_subtype¶

Gets the account_subtype of this FundingAccountSnapshotResponse. # 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/ApplePay account. # noqa: E501

Returns: The account_subtype of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

property account_type¶

Gets the account_type of this FundingAccountSnapshotResponse. # noqa: E501

The type of the funding account. # noqa: E501

Returns: The account_type of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

attribute_map = {'aba_routing_number': 'aba_routing_number', 'account_holder_name': 'account_holder_name', 'account_number': 'account_number', 'account_subtype': 'account_subtype', 'account_type': 'account_type', 'display_text': 'display_text', 'id': 'id', 'issuer_name': 'issuer_name', 'nickname': 'nickname', 'url': 'url'}¶

property display_text¶

Gets the display_text of this FundingAccountSnapshotResponse. # noqa: E501

UI representation of the account. # noqa: E501

Returns: The display_text of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this FundingAccountSnapshotResponse. # noqa: E501

Id is a unique identifier assigned to the account in EBPP. # noqa: E501

Returns: The id of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

property issuer_name¶

Gets the issuer_name of this FundingAccountSnapshotResponse. # 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 FundingAccountSnapshotResponse. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this FundingAccountSnapshotResponse. # noqa: E501

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

Returns: The nickname of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

swagger_types = {'aba_routing_number': 'str', 'account_holder_name': 'str', 'account_number': 'str', 'account_subtype': 'str', 'account_type': 'str', 'display_text': 'str', 'id': 'str', 'issuer_name': 'str', 'nickname': '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 FundingAccountSnapshotResponse. # noqa: E501

This URL fetches the funding account details. # noqa: E501

Returns: The url of this FundingAccountSnapshotResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.funding_accounts_response module¶

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

class orbipay_paymentsapi_client.models.funding_accounts_response.FundingAccountsResponse(list=None, total_results_count=None, has_more_results=None, url=None, from_index=None, to_index=None, query_id=None)¶

Bases: object

NOTE:

attribute_map = {'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'query_id': 'query_id', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property from_index¶

Gets the from_index of this FundingAccountsResponse. # 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 FundingAccountsResponse. # noqa: E501
Return type: str

property has_more_results¶

Gets the has_more_results of this FundingAccountsResponse. # noqa: E501

true if there are more results or pages # noqa: E501

Returns: The has_more_results of this FundingAccountsResponse. # noqa: E501
Return type: str

property list¶

Gets the list of this FundingAccountsResponse. # noqa: E501

Returns: The list of this FundingAccountsResponse. # noqa: E501
Return type: list[FundingAccountResponse]

property query_id¶

Gets the query_id of this FundingAccountsResponse. # noqa: E501

The query id of the object. # noqa: E501

Returns: The query_id of this FundingAccountsResponse. # noqa: E501
Return type: str

swagger_types = {'from_index': 'str', 'has_more_results': 'str', 'list': 'list[FundingAccountResponse]', 'query_id': '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 FundingAccountsResponse. # 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 FundingAccountsResponse. # noqa: E501
Return type: str

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

property total_results_count¶

Gets the total_results_count of this FundingAccountsResponse. # noqa: E501

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

Returns: The total_results_count of this FundingAccountsResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this FundingAccountsResponse. # 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 FundingAccountsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.get_recorded_payment_response module¶

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

class orbipay_paymentsapi_client.models.get_recorded_payment_response.GetRecordedPaymentResponse(id=None, url=None, fee=None, status=None, payment_method=None, token=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, payment_date=None, payment_schedule_type=None, payment_amount_type=None, payment_reference=None, payment_entry_date=None, payment_return_date=None, comments=None, return_code=None, customer=None, funding_account=None, customer_account=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
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', '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 GetRecordedPaymentResponse. # noqa: E501

Returns: The audit_info of this GetRecordedPaymentResponse. # noqa: E501
Return type: AuditInfoVo

property comments¶

Gets the comments of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this GetRecordedPaymentResponse. # noqa: E501

The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this GetRecordedPaymentResponse. # noqa: E501

Returns: The customer of this GetRecordedPaymentResponse. # noqa: E501
Return type: CustomerSnapshotResponse

property customer_account¶

Gets the customer_account of this GetRecordedPaymentResponse. # noqa: E501

Returns: The customer_account of this GetRecordedPaymentResponse. # noqa: E501
Return type: CustomerAccountSnapshotResponse

property fee¶

Gets the fee of this GetRecordedPaymentResponse. # noqa: E501

Returns: The fee of this GetRecordedPaymentResponse. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this GetRecordedPaymentResponse. # noqa: E501

Returns: The funding_account of this GetRecordedPaymentResponse. # noqa: E501
Return type: RecordedPaymentFundingAccount

property id¶

Gets the id of this GetRecordedPaymentResponse. # noqa: E501

The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this GetRecordedPaymentResponse. # noqa: E501

The non fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this GetRecordedPaymentResponse. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

property payment_return_date¶

Gets the payment_return_date of this GetRecordedPaymentResponse. # noqa: E501

The date on which the ACH returns is received by EBPP. # noqa: E501

Returns: The payment_return_date of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this GetRecordedPaymentResponse. # noqa: E501

The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

property return_code¶

Gets the return_code of this GetRecordedPaymentResponse. # 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 GetRecordedPaymentResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this GetRecordedPaymentResponse. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'CustomerSnapshotResponse', 'customer_account': 'CustomerAccountSnapshotResponse', 'fee': 'FeeResponse', 'funding_account': 'RecordedPaymentFundingAccount', 'id': '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_dict()¶: Returns the model properties as a dict

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

property token¶

Gets the token of this GetRecordedPaymentResponse. # noqa: E501

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

Returns: The token of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this GetRecordedPaymentResponse. # noqa: E501

This URL fetches the details of payment. # noqa: E501

Returns: The url of this GetRecordedPaymentResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.payment_network_response_vo module¶

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

class orbipay_paymentsapi_client.models.payment_network_response_vo.PaymentNetworkResponseVo(payment_auth_code=None, payment_response_code=None, payment_response_msg=None)¶

Bases: object

NOTE:

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 PaymentNetworkResponseVo. # 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 PaymentNetworkResponseVo. # noqa: E501
Return type: str

property payment_response_code¶

Gets the payment_response_code of this PaymentNetworkResponseVo. # 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 PaymentNetworkResponseVo. # noqa: E501
Return type: str

property payment_response_msg¶

Gets the payment_response_msg of this PaymentNetworkResponseVo. # 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 PaymentNetworkResponseVo. # noqa: E501
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.models.payment_response module¶

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

class orbipay_paymentsapi_client.models.payment_response.PaymentResponse(id=None, url=None, fee=None, status=None, payment_method=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, card_cvv_number=None, payment_date=None, payment_schedule_type=None, payment_request_date=None, payment_amount_type=None, payment_reference=None, expected_payment_settlement_date=None, payment_entry_date=None, payment_return_date=None, return_code=None, payment_notification_email=None, comments=None, token=None, customer=None, funding_account=None, customer_account=None, payment_network_response=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
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', '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', 'status': 'status', 'token': 'token', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this PaymentResponse. # noqa: E501

Returns: The audit_info of this PaymentResponse. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property comments¶

Gets the comments of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this PaymentResponse. # noqa: E501

The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this PaymentResponse. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this PaymentResponse. # noqa: E501

Returns: The customer of this PaymentResponse. # noqa: E501
Return type: CustomerSnapshotResponse

property customer_account¶

Gets the customer_account of this PaymentResponse. # noqa: E501

Returns: The customer_account of this PaymentResponse. # noqa: E501
Return type: CustomerAccountSnapshotResponse

property expected_payment_settlement_date¶

Gets the expected_payment_settlement_date of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property fee¶

Gets the fee of this PaymentResponse. # noqa: E501

Returns: The fee of this PaymentResponse. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this PaymentResponse. # noqa: E501

Returns: The funding_account of this PaymentResponse. # noqa: E501
Return type: FundingAccountSnapshotResponse

property id¶

Gets the id of this PaymentResponse. # noqa: E501

The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id of this PaymentResponse. # noqa: E501
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this PaymentResponse. # noqa: E501

The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this PaymentResponse. # noqa: E501
Return type: str

property payment_network_response¶

Gets the payment_network_response of this PaymentResponse. # noqa: E501

Returns: The payment_network_response of this PaymentResponse. # noqa: E501
Return type: PaymentNetworkResponseVo

property payment_notification_email¶

Gets the payment_notification_email of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this PaymentResponse. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this PaymentResponse. # noqa: E501
Return type: str

property payment_request_date¶

Gets the payment_request_date of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property payment_return_date¶

Gets the payment_return_date of this PaymentResponse. # noqa: E501

The date on which the ACH returns is received by EBPP. # noqa: E501

Returns: The payment_return_date of this PaymentResponse. # noqa: E501
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this PaymentResponse. # noqa: E501

The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this PaymentResponse. # noqa: E501
Return type: str

property return_code¶

Gets the return_code of this PaymentResponse. # 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 PaymentResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this PaymentResponse. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this PaymentResponse. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'CustomerSnapshotResponse', 'customer_account': 'CustomerAccountSnapshotResponse', 'expected_payment_settlement_date': 'str', 'fee': 'FeeResponse', 'funding_account': 'FundingAccountSnapshotResponse', 'id': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponseVo', 'payment_notification_email': 'str', 'payment_reference': 'str', 'payment_request_date': 'str', 'payment_return_date': 'str', 'payment_schedule_type': 'str', 'return_code': 'str', 'status': 'str', 'token': 'str', 'url': 'str'}¶

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 PaymentResponse. # noqa: E501

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

Returns: The token of this PaymentResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this PaymentResponse. # noqa: E501

This URL fetches the details of payment. # noqa: E501

Returns: The url of this PaymentResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.payment_response_cgen module¶

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

class orbipay_paymentsapi_client.models.payment_response_cgen.PaymentResponseCgen(id=None, url=None, fee=None, status=None, payment_method=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, card_cvv_number=None, payment_date=None, payment_schedule_type=None, payment_request_date=None, payment_amount_type=None, payment_reference=None, expected_payment_settlement_date=None, payment_entry_date=None, payment_return_date=None, return_code=None, payment_notification_email=None, comments=None, deleted=None, customer=None, funding_account=None, customer_account=None, payment_network_response=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
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', '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 PaymentResponseCgen. # noqa: E501

Returns: The audit_info of this PaymentResponseCgen. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property comments¶

Gets the comments of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this PaymentResponseCgen. # noqa: E501

The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this PaymentResponseCgen. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this PaymentResponseCgen. # noqa: E501

Returns: The customer of this PaymentResponseCgen. # noqa: E501
Return type: CustomerSnapshotResponse

property customer_account¶

Gets the customer_account of this PaymentResponseCgen. # noqa: E501

Returns: The customer_account of this PaymentResponseCgen. # noqa: E501
Return type: CustomerAccountSnapshotResponse

property deleted¶

Gets the deleted of this PaymentResponseCgen. # noqa: E501

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

Returns: The deleted of this PaymentResponseCgen. # noqa: E501
Return type: str

property expected_payment_settlement_date¶

Gets the expected_payment_settlement_date of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property fee¶

Gets the fee of this PaymentResponseCgen. # noqa: E501

Returns: The fee of this PaymentResponseCgen. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this PaymentResponseCgen. # noqa: E501

Returns: The funding_account of this PaymentResponseCgen. # noqa: E501
Return type: FundingAccountSnapshotResponse

property id¶

Gets the id of this PaymentResponseCgen. # noqa: E501

The unique identifier assigned by Orbipay to the payment. # noqa: E501

Returns: The id of this PaymentResponseCgen. # noqa: E501
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this PaymentResponseCgen. # noqa: E501

The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this PaymentResponseCgen. # noqa: E501
Return type: str

property payment_network_response¶

Gets the payment_network_response of this PaymentResponseCgen. # noqa: E501

Returns: The payment_network_response of this PaymentResponseCgen. # noqa: E501
Return type: PaymentNetworkResponseVo

property payment_notification_email¶

Gets the payment_notification_email of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this PaymentResponseCgen. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this PaymentResponseCgen. # noqa: E501
Return type: str

property payment_request_date¶

Gets the payment_request_date of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property payment_return_date¶

Gets the payment_return_date of this PaymentResponseCgen. # noqa: E501

The date on which the ACH returns is received by Orbipay. # noqa: E501

Returns: The payment_return_date of this PaymentResponseCgen. # noqa: E501
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this PaymentResponseCgen. # noqa: E501

The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this PaymentResponseCgen. # noqa: E501
Return type: str

property return_code¶

Gets the return_code of this PaymentResponseCgen. # 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 PaymentResponseCgen. # noqa: E501
Return type: str

property status¶

Gets the status of this PaymentResponseCgen. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this PaymentResponseCgen. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'CustomerSnapshotResponse', 'customer_account': 'CustomerAccountSnapshotResponse', 'deleted': 'str', 'expected_payment_settlement_date': 'str', 'fee': 'FeeResponse', 'funding_account': 'FundingAccountSnapshotResponse', 'id': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponseVo', '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_dict()¶: Returns the model properties as a dict

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

property url¶

Gets the url of this PaymentResponseCgen. # noqa: E501

This URL fetches the details of payment. # noqa: E501

Returns: The url of this PaymentResponseCgen. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.payment_schedule_minimal_request module¶

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

class orbipay_paymentsapi_client.models.payment_schedule_minimal_request.PaymentScheduleMinimalRequest(payment_limit_amount=None)¶

Bases: object

NOTE:

attribute_map = {'payment_limit_amount': 'payment_limit_amount'}¶

property payment_limit_amount¶

Gets the payment_limit_amount of this PaymentScheduleMinimalRequest. # 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 PaymentScheduleMinimalRequest. # noqa: E501
Return type: str

swagger_types = {'payment_limit_amount': 'str'}¶

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

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

orbipay_paymentsapi_client.models.payment_schedule_vo module¶

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

class orbipay_paymentsapi_client.models.payment_schedule_vo.PaymentScheduleVo(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

NOTE:

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 PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
Return type: str

property payment_defer_days¶

Gets the payment_defer_days of this PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
Return type: str

property payment_end_date¶

Gets the payment_end_date of this PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
Return type: str

property payment_limit_amount¶

Gets the payment_limit_amount of this PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
Return type: str

property payment_plan_id¶

Gets the payment_plan_id of this PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
Return type: str

property payment_recurring_count¶

Gets the payment_recurring_count of this PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
Return type: str

property payment_recurring_type¶

Gets the payment_recurring_type of this PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
Return type: str

property payment_start_date¶

Gets the payment_start_date of this PaymentScheduleVo. # 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 PaymentScheduleVo. # noqa: E501
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

orbipay_paymentsapi_client.models.payment_setup_response module¶

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

class orbipay_paymentsapi_client.models.payment_setup_response.PaymentSetupResponse(id=None, url=None, fee=None, status=None, payment_method=None, payment_setup_schedule_type=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, card_cvv_number=None, next_payment_date=None, payment_setup_reference=None, payment_schedule=None, payment_setup_entry_date=None, comments=None, customer=None, funding_account=None, customer_account=None, payment_network_response=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this PaymentSetupResponse. # 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 PaymentSetupResponse. # noqa: E501
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', 'fee': 'fee', 'funding_account': 'funding_account', 'id': 'id', '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 PaymentSetupResponse. # noqa: E501

Returns: The audit_info of this PaymentSetupResponse. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this PaymentSetupResponse. # noqa: E501

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment setup with a card funding account. # noqa: E501

Returns: The card_cvv_number of this PaymentSetupResponse. # noqa: E501
Return type: str

property comments¶

Gets the comments of this PaymentSetupResponse. # 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 PaymentSetupResponse. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this PaymentSetupResponse. # noqa: E501

The confirmation number or reference provided to the customer for the payment setup. # noqa: E501

Returns: The confirmation_number of this PaymentSetupResponse. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this PaymentSetupResponse. # 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 PaymentSetupResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this PaymentSetupResponse. # 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 PaymentSetupResponse. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this PaymentSetupResponse. # noqa: E501

Returns: The customer of this PaymentSetupResponse. # noqa: E501
Return type: CustomerSnapshotResponse

property customer_account¶

Gets the customer_account of this PaymentSetupResponse. # noqa: E501

Returns: The customer_account of this PaymentSetupResponse. # noqa: E501
Return type: CustomerAccountSnapshotResponse

property fee¶

Gets the fee of this PaymentSetupResponse. # noqa: E501

Returns: The fee of this PaymentSetupResponse. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this PaymentSetupResponse. # noqa: E501

Returns: The funding_account of this PaymentSetupResponse. # noqa: E501
Return type: FundingAccountSnapshotResponse

property id¶

Gets the id of this PaymentSetupResponse. # noqa: E501

The unique identifier assigned by EBPP to the payment setup. # noqa: E501

Returns: The id of this PaymentSetupResponse. # noqa: E501
Return type: str

property next_payment_date¶

Gets the next_payment_date of this PaymentSetupResponse. # 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 PaymentSetupResponse. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this PaymentSetupResponse. # noqa: E501

The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this PaymentSetupResponse. # noqa: E501
Return type: str

property payment_network_response¶

Gets the payment_network_response of this PaymentSetupResponse. # noqa: E501

Returns: The payment_network_response of this PaymentSetupResponse. # noqa: E501
Return type: PaymentNetworkResponseVo

property payment_schedule¶

Gets the payment_schedule of this PaymentSetupResponse. # noqa: E501

Returns: The payment_schedule of this PaymentSetupResponse. # noqa: E501
Return type: PaymentScheduleVo

property payment_setup_entry_date¶

Gets the payment_setup_entry_date of this PaymentSetupResponse. # noqa: E501

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

Returns: The payment_setup_entry_date of this PaymentSetupResponse. # noqa: E501
Return type: str

property payment_setup_reference¶

Gets the payment_setup_reference of this PaymentSetupResponse. # noqa: E501

The unique identifier in the client system for the payment setup. # noqa: E501

Returns: The payment_setup_reference of this PaymentSetupResponse. # noqa: E501
Return type: str

property payment_setup_schedule_type¶

Gets the payment_setup_schedule_type of this PaymentSetupResponse. # noqa: E501

The schedule type for the payment setup. # noqa: E501

Returns: The payment_setup_schedule_type of this PaymentSetupResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this PaymentSetupResponse. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this PaymentSetupResponse. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'CustomerSnapshotResponse', 'customer_account': 'CustomerAccountSnapshotResponse', 'fee': 'FeeResponse', 'funding_account': 'FundingAccountSnapshotResponse', 'id': 'str', 'next_payment_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponseVo', 'payment_schedule': 'PaymentScheduleVo', 'payment_setup_entry_date': 'str', 'payment_setup_reference': 'str', 'payment_setup_schedule_type': '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 PaymentSetupResponse. # noqa: E501

This URL fetches the details of payment setup. # noqa: E501

Returns: The url of this PaymentSetupResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.payment_setup_response_cgen module¶

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

class orbipay_paymentsapi_client.models.payment_setup_response_cgen.PaymentSetupResponseCgen(id=None, url=None, fee=None, status=None, payment_method=None, payment_setup_schedule_type=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, card_cvv_number=None, next_payment_date=None, payment_setup_reference=None, payment_schedule=None, payment_setup_entry_date=None, comments=None, deleted=None, customer=None, funding_account=None, customer_account=None, payment_network_response=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this PaymentSetupResponseCgen. # 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 PaymentSetupResponseCgen. # noqa: E501
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', '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 PaymentSetupResponseCgen. # noqa: E501

Returns: The audit_info of this PaymentSetupResponseCgen. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this PaymentSetupResponseCgen. # 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 PaymentSetupResponseCgen. # noqa: E501
Return type: str

property comments¶

Gets the comments of this PaymentSetupResponseCgen. # 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 PaymentSetupResponseCgen. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this PaymentSetupResponseCgen. # noqa: E501

The confirmation number or reference provided to the customer for the payment setup. # noqa: E501

Returns: The confirmation_number of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this PaymentSetupResponseCgen. # 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 PaymentSetupResponseCgen. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this PaymentSetupResponseCgen. # 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 PaymentSetupResponseCgen. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this PaymentSetupResponseCgen. # noqa: E501

Returns: The customer of this PaymentSetupResponseCgen. # noqa: E501
Return type: CustomerSnapshotResponse

property customer_account¶

Gets the customer_account of this PaymentSetupResponseCgen. # noqa: E501

Returns: The customer_account of this PaymentSetupResponseCgen. # noqa: E501
Return type: CustomerAccountSnapshotResponse

property deleted¶

Gets the deleted of this PaymentSetupResponseCgen. # noqa: E501

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

Returns: The deleted of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

property fee¶

Gets the fee of this PaymentSetupResponseCgen. # noqa: E501

Returns: The fee of this PaymentSetupResponseCgen. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this PaymentSetupResponseCgen. # noqa: E501

Returns: The funding_account of this PaymentSetupResponseCgen. # noqa: E501
Return type: FundingAccountSnapshotResponse

property id¶

Gets the id of this PaymentSetupResponseCgen. # noqa: E501

The unique identifier assigned by Orbipay to the payment setup. # noqa: E501

Returns: The id of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

property next_payment_date¶

Gets the next_payment_date of this PaymentSetupResponseCgen. # 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 PaymentSetupResponseCgen. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this PaymentSetupResponseCgen. # noqa: E501

The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

property payment_network_response¶

Gets the payment_network_response of this PaymentSetupResponseCgen. # noqa: E501

Returns: The payment_network_response of this PaymentSetupResponseCgen. # noqa: E501
Return type: PaymentNetworkResponseVo

property payment_schedule¶

Gets the payment_schedule of this PaymentSetupResponseCgen. # noqa: E501

Returns: The payment_schedule of this PaymentSetupResponseCgen. # noqa: E501
Return type: PaymentScheduleVo

property payment_setup_entry_date¶

Gets the payment_setup_entry_date of this PaymentSetupResponseCgen. # 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 PaymentSetupResponseCgen. # noqa: E501
Return type: str

property payment_setup_reference¶

Gets the payment_setup_reference of this PaymentSetupResponseCgen. # noqa: E501

The unique identifier in the client system for the payment setup. # noqa: E501

Returns: The payment_setup_reference of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

property payment_setup_schedule_type¶

Gets the payment_setup_schedule_type of this PaymentSetupResponseCgen. # noqa: E501

The schedule type for the payment setup. # noqa: E501

Returns: The payment_setup_schedule_type of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

property status¶

Gets the status of this PaymentSetupResponseCgen. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'CustomerSnapshotResponse', 'customer_account': 'CustomerAccountSnapshotResponse', 'deleted': 'str', 'fee': 'FeeResponse', 'funding_account': 'FundingAccountSnapshotResponse', 'id': 'str', 'next_payment_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponseVo', 'payment_schedule': 'PaymentScheduleVo', 'payment_setup_entry_date': 'str', 'payment_setup_reference': 'str', 'payment_setup_schedule_type': '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 PaymentSetupResponseCgen. # noqa: E501

This URL fetches the details of payment setup. # noqa: E501

Returns: The url of this PaymentSetupResponseCgen. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.payment_setups_response module¶

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

class orbipay_paymentsapi_client.models.payment_setups_response.PaymentSetupsResponse(list=None, total_results_count=None, has_more_results=None, url=None, from_index=None, to_index=None, query_id=None)¶

Bases: object

NOTE:

attribute_map = {'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'query_id': 'query_id', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property from_index¶

Gets the from_index of this PaymentSetupsResponse. # 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 PaymentSetupsResponse. # noqa: E501
Return type: str

property has_more_results¶

Gets the has_more_results of this PaymentSetupsResponse. # noqa: E501

true if there are more results or pages # noqa: E501

Returns: The has_more_results of this PaymentSetupsResponse. # noqa: E501
Return type: str

property list¶

Gets the list of this PaymentSetupsResponse. # noqa: E501

Returns: The list of this PaymentSetupsResponse. # noqa: E501
Return type: list[PaymentSetupResponse]

property query_id¶

Gets the query_id of this PaymentSetupsResponse. # noqa: E501

The query id of the object. # noqa: E501

Returns: The query_id of this PaymentSetupsResponse. # noqa: E501
Return type: str

swagger_types = {'from_index': 'str', 'has_more_results': 'str', 'list': 'list[PaymentSetupResponse]', 'query_id': '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 PaymentSetupsResponse. # 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 PaymentSetupsResponse. # noqa: E501
Return type: str

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

property total_results_count¶

Gets the total_results_count of this PaymentSetupsResponse. # noqa: E501

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

Returns: The total_results_count of this PaymentSetupsResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this PaymentSetupsResponse. # 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 PaymentSetupsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.payments_response module¶

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

class orbipay_paymentsapi_client.models.payments_response.PaymentsResponse(list=None, total_results_count=None, has_more_results=None, url=None, from_index=None, to_index=None, query_id=None)¶

Bases: object

NOTE:

attribute_map = {'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'query_id': 'query_id', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property from_index¶

Gets the from_index of this PaymentsResponse. # 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 PaymentsResponse. # noqa: E501
Return type: str

property has_more_results¶

Gets the has_more_results of this PaymentsResponse. # noqa: E501

true if there are more results or pages # noqa: E501

Returns: The has_more_results of this PaymentsResponse. # noqa: E501
Return type: str

property list¶

Gets the list of this PaymentsResponse. # noqa: E501

Returns: The list of this PaymentsResponse. # noqa: E501
Return type: list[PaymentResponse]

property query_id¶

Gets the query_id of this PaymentsResponse. # noqa: E501

The query id of the object. # noqa: E501

Returns: The query_id of this PaymentsResponse. # noqa: E501
Return type: str

swagger_types = {'from_index': 'str', 'has_more_results': 'str', 'list': 'list[PaymentResponse]', 'query_id': '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 PaymentsResponse. # 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 PaymentsResponse. # noqa: E501
Return type: str

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

property total_results_count¶

Gets the total_results_count of this PaymentsResponse. # noqa: E501

total number of payments available with matching criteria # noqa: E501

Returns: The total_results_count of this PaymentsResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this PaymentsResponse. # 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 PaymentsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.record_payment_request module¶

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

class orbipay_paymentsapi_client.models.record_payment_request.RecordPaymentRequest(amount=None, payment_date=None, payment_amount_type=None, payment_method=None, token=None, fee=None, customer=None, funding_account=None, customer_account=None, payment_reference=None, comments=None, custom_fields=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this RecordPaymentRequest. # 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 RecordPaymentRequest. # noqa: E501
Return type: str

attribute_map = {'amount': 'amount', 'comments': 'comments', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'fee': 'fee', 'funding_account': 'funding_account', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_method': 'payment_method', 'payment_reference': 'payment_reference', 'token': 'token'}¶

property comments¶

Gets the comments of this RecordPaymentRequest. # noqa: E501

Returns: The comments of this RecordPaymentRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this RecordPaymentRequest. # 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 RecordPaymentRequest. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this RecordPaymentRequest. # noqa: E501

Returns: The customer of this RecordPaymentRequest. # noqa: E501
Return type: SimplePaymentCustomerRequest

property customer_account¶

Gets the customer_account of this RecordPaymentRequest. # noqa: E501

Returns: The customer_account of this RecordPaymentRequest. # noqa: E501
Return type: CreateCustomerAccountRequest

property fee¶

Gets the fee of this RecordPaymentRequest. # noqa: E501

Returns: The fee of this RecordPaymentRequest. # noqa: E501
Return type: FeeRequest

property funding_account¶

Gets the funding_account of this RecordPaymentRequest. # noqa: E501

Returns: The funding_account of this RecordPaymentRequest. # noqa: E501
Return type: RecordedPaymentFundingAccount

property payment_amount_type¶

Gets the payment_amount_type of this RecordPaymentRequest. # 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 RecordPaymentRequest. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this RecordPaymentRequest. # 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 RecordPaymentRequest. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this RecordPaymentRequest. # noqa: E501

The non fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this RecordPaymentRequest. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this RecordPaymentRequest. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this RecordPaymentRequest. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'SimplePaymentCustomerRequest', 'customer_account': 'CreateCustomerAccountRequest', 'fee': 'FeeRequest', 'funding_account': 'RecordedPaymentFundingAccount', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_method': 'str', 'payment_reference': 'str', 'token': 'str'}¶

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 RecordPaymentRequest. # noqa: E501

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

Returns: The token of this RecordPaymentRequest. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.recorded_payment_funding_account module¶

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

class orbipay_paymentsapi_client.models.recorded_payment_funding_account.RecordedPaymentFundingAccount(account_number=None, issuer_name=None)¶

Bases: object

NOTE:

property account_number¶

Gets the account_number of this RecordedPaymentFundingAccount. # noqa: E501

The number or reference that a customer uses to identify the funding account. or last 4 digits of account number. # noqa: E501

Returns: The account_number of this RecordedPaymentFundingAccount. # noqa: E501
Return type: str

attribute_map = {'account_number': 'account_number', 'issuer_name': 'issuer_name'}¶

property issuer_name¶

Gets the issuer_name of this RecordedPaymentFundingAccount. # noqa: E501

The name of the authority that has issued the account. # noqa: E501

Returns: The issuer_name of this RecordedPaymentFundingAccount. # noqa: E501
Return type: str

swagger_types = {'account_number': 'str', 'issuer_name': 'str'}¶

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

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

orbipay_paymentsapi_client.models.recorded_payment_response module¶

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

class orbipay_paymentsapi_client.models.recorded_payment_response.RecordedPaymentResponse(id=None, url=None, fee=None, status=None, payment_method=None, token=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, payment_date=None, payment_schedule_type=None, payment_amount_type=None, payment_reference=None, payment_entry_date=None, payment_return_date=None, comments=None, return_code=None, customer=None, funding_account=None, customer_account=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
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', '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 RecordedPaymentResponse. # noqa: E501

Returns: The audit_info of this RecordedPaymentResponse. # noqa: E501
Return type: AuditInfoVo

property comments¶

Gets the comments of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this RecordedPaymentResponse. # noqa: E501

The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this RecordedPaymentResponse. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this RecordedPaymentResponse. # noqa: E501

Returns: The customer of this RecordedPaymentResponse. # noqa: E501
Return type: SimplePaymentCustomerResponse

property customer_account¶

Gets the customer_account of this RecordedPaymentResponse. # noqa: E501

Returns: The customer_account of this RecordedPaymentResponse. # noqa: E501
Return type: CustomerAccountResponse

property fee¶

Gets the fee of this RecordedPaymentResponse. # noqa: E501

Returns: The fee of this RecordedPaymentResponse. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this RecordedPaymentResponse. # noqa: E501

Returns: The funding_account of this RecordedPaymentResponse. # noqa: E501
Return type: RecordedPaymentFundingAccount

property id¶

Gets the id of this RecordedPaymentResponse. # noqa: E501

The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id of this RecordedPaymentResponse. # noqa: E501
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this RecordedPaymentResponse. # noqa: E501

The non fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this RecordedPaymentResponse. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this RecordedPaymentResponse. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this RecordedPaymentResponse. # noqa: E501
Return type: str

property payment_return_date¶

Gets the payment_return_date of this RecordedPaymentResponse. # noqa: E501

The date on which the ACH returns is received by EBPP. # noqa: E501

Returns: The payment_return_date of this RecordedPaymentResponse. # noqa: E501
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this RecordedPaymentResponse. # noqa: E501

The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this RecordedPaymentResponse. # noqa: E501
Return type: str

property return_code¶

Gets the return_code of this RecordedPaymentResponse. # 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 RecordedPaymentResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this RecordedPaymentResponse. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this RecordedPaymentResponse. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'SimplePaymentCustomerResponse', 'customer_account': 'CustomerAccountResponse', 'fee': 'FeeResponse', 'funding_account': 'RecordedPaymentFundingAccount', 'id': '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_dict()¶: Returns the model properties as a dict

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

property token¶

Gets the token of this RecordedPaymentResponse. # noqa: E501

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

Returns: The token of this RecordedPaymentResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this RecordedPaymentResponse. # noqa: E501

This URL fetches the details of payment. # noqa: E501

Returns: The url of this RecordedPaymentResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.recorded_payments_response module¶

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

class orbipay_paymentsapi_client.models.recorded_payments_response.RecordedPaymentsResponse(list=None, total_results_count=None, has_more_results=None, url=None, from_index=None, to_index=None, query_id=None)¶

Bases: object

NOTE:

attribute_map = {'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'query_id': 'query_id', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property from_index¶

Gets the from_index of this RecordedPaymentsResponse. # 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 RecordedPaymentsResponse. # noqa: E501
Return type: str

property has_more_results¶

Gets the has_more_results of this RecordedPaymentsResponse. # noqa: E501

true if there are more results or pages # noqa: E501

Returns: The has_more_results of this RecordedPaymentsResponse. # noqa: E501
Return type: str

property list¶

Gets the list of this RecordedPaymentsResponse. # noqa: E501

Returns: The list of this RecordedPaymentsResponse. # noqa: E501
Return type: list[GetRecordedPaymentResponse]

property query_id¶

Gets the query_id of this RecordedPaymentsResponse. # noqa: E501

The query id of the object. # noqa: E501

Returns: The query_id of this RecordedPaymentsResponse. # noqa: E501
Return type: str

swagger_types = {'from_index': 'str', 'has_more_results': 'str', 'list': 'list[GetRecordedPaymentResponse]', 'query_id': '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 RecordedPaymentsResponse. # 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 RecordedPaymentsResponse. # noqa: E501
Return type: str

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

property total_results_count¶

Gets the total_results_count of this RecordedPaymentsResponse. # noqa: E501

total number of payments available with matching criteria # noqa: E501

Returns: The total_results_count of this RecordedPaymentsResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this RecordedPaymentsResponse. # 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 RecordedPaymentsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.refund_response module¶

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

class orbipay_paymentsapi_client.models.refund_response.RefundResponse(refund_reference=None, id=None, url=None, refund_type=None, refund_amount=None, fee_refund=None, status=None, confirmation_number=None, refund_date=None, refund_entry_date=None, expected_refund_settlement_date=None, custom_fields=None, comments=None, source_payment=None, payment_network_response=None, audit_info=None)¶

Bases: object

NOTE:

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', '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 RefundResponse. # noqa: E501

Returns: The audit_info of this RefundResponse. # noqa: E501
Return type: AuditInfoVo

property comments¶

Gets the comments of this RefundResponse. # 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 RefundResponse. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this RefundResponse. # noqa: E501

The confirmation number or reference provided to the customer for the refund. # noqa: E501

Returns: The confirmation_number of this RefundResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this RefundResponse. # 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 RefundResponse. # noqa: E501
Return type: dict(str, str)

property expected_refund_settlement_date¶

Gets the expected_refund_settlement_date of this RefundResponse. # 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 RefundResponse. # noqa: E501
Return type: str

property fee_refund¶

Gets the fee_refund of this RefundResponse. # noqa: E501

Returns: The fee_refund of this RefundResponse. # noqa: E501
Return type: FeeRefundResponse

property id¶

Gets the id of this RefundResponse. # noqa: E501

The unique identifier assigned by EBPP to the refund. # noqa: E501

Returns: The id of this RefundResponse. # noqa: E501
Return type: str

property payment_network_response¶

Gets the payment_network_response of this RefundResponse. # noqa: E501

Returns: The payment_network_response of this RefundResponse. # noqa: E501
Return type: PaymentNetworkResponseVo

property refund_amount¶

Gets the refund_amount of this RefundResponse. # noqa: E501

The refund amount upto 2 decimal places. # noqa: E501

Returns: The refund_amount of this RefundResponse. # noqa: E501
Return type: str

property refund_date¶

Gets the refund_date of this RefundResponse. # 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 RefundResponse. # noqa: E501
Return type: str

property refund_entry_date¶

Gets the refund_entry_date of this RefundResponse. # 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 RefundResponse. # noqa: E501
Return type: str

property refund_reference¶

Gets the refund_reference of this RefundResponse. # noqa: E501

The unique identifier in the client system for the refund. # noqa: E501

Returns: The refund_reference of this RefundResponse. # noqa: E501
Return type: str

property refund_type¶

Gets the refund_type of this RefundResponse. # 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 RefundResponse. # noqa: E501
Return type: str

property source_payment¶

Gets the source_payment of this RefundResponse. # noqa: E501

Returns: The source_payment of this RefundResponse. # noqa: E501
Return type: SourcePayment

property status¶

Gets the status of this RefundResponse. # noqa: E501

The status of the refund. # noqa: E501

Returns: The status of this RefundResponse. # noqa: E501
Return type: str

swagger_types = {'audit_info': 'AuditInfoVo', 'comments': 'str', 'confirmation_number': 'str', 'custom_fields': 'dict(str, str)', 'expected_refund_settlement_date': 'str', 'fee_refund': 'FeeRefundResponse', 'id': 'str', 'payment_network_response': 'PaymentNetworkResponseVo', '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 RefundResponse. # noqa: E501

This URL fetches the details of refund. # noqa: E501

Returns: The url of this RefundResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.refunds_response module¶

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

class orbipay_paymentsapi_client.models.refunds_response.RefundsResponse(list=None, total_results_count=None, has_more_results=None, url=None, from_index=None, to_index=None, query_id=None)¶

Bases: object

NOTE:

attribute_map = {'from_index': 'from_index', 'has_more_results': 'has_more_results', 'list': 'list', 'query_id': 'query_id', 'to_index': 'to_index', 'total_results_count': 'total_results_count', 'url': 'url'}¶

property from_index¶

Gets the from_index of this RefundsResponse. # 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 RefundsResponse. # noqa: E501
Return type: str

property has_more_results¶

Gets the has_more_results of this RefundsResponse. # noqa: E501

true if there are more results or pages # noqa: E501

Returns: The has_more_results of this RefundsResponse. # noqa: E501
Return type: str

property list¶

Gets the list of this RefundsResponse. # noqa: E501

Returns: The list of this RefundsResponse. # noqa: E501
Return type: list[RefundResponse]

property query_id¶

Gets the query_id of this RefundsResponse. # noqa: E501

The query id of the object. # noqa: E501

Returns: The query_id of this RefundsResponse. # noqa: E501
Return type: str

swagger_types = {'from_index': 'str', 'has_more_results': 'str', 'list': 'list[RefundResponse]', 'query_id': '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 RefundsResponse. # 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 RefundsResponse. # noqa: E501
Return type: str

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

property total_results_count¶

Gets the total_results_count of this RefundsResponse. # noqa: E501

total number of payments available with matching criteria # noqa: E501

Returns: The total_results_count of this RefundsResponse. # noqa: E501
Return type: str

property url¶

Gets the url of this RefundsResponse. # 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 RefundsResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.renew_customer_account_request module¶

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

class orbipay_paymentsapi_client.models.renew_customer_account_request.RenewCustomerAccountRequest(account_holder_name=None, nickname=None, address=None, customer_account_reference=None, account_number=None, current_balance=None, current_statement_balance=None, minimum_payment_due=None, past_amount_due=None, payment_due_date=None, statement_date=None, custom_fields=None, comments=None)¶

Bases: object

NOTE:

property account_holder_name¶

Gets the account_holder_name of this RenewCustomerAccountRequest. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this RenewCustomerAccountRequest. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this RenewCustomerAccountRequest. # noqa: E501

The number or reference that a customer uses to identify the customer’s account. # noqa: E501

Returns: The account_number of this RenewCustomerAccountRequest. # noqa: E501
Return type: str

property address¶

Gets the address of this RenewCustomerAccountRequest. # noqa: E501

Returns: The address of this RenewCustomerAccountRequest. # noqa: E501
Return type: AddressVo

attribute_map = {'account_holder_name': 'account_holder_name', 'account_number': 'account_number', 'address': 'address', 'comments': 'comments', 'current_balance': 'current_balance', 'current_statement_balance': 'current_statement_balance', 'custom_fields': 'custom_fields', 'customer_account_reference': 'customer_account_reference', 'minimum_payment_due': 'minimum_payment_due', 'nickname': 'nickname', 'past_amount_due': 'past_amount_due', 'payment_due_date': 'payment_due_date', 'statement_date': 'statement_date'}¶

property comments¶

Gets the comments of this RenewCustomerAccountRequest. # 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 RenewCustomerAccountRequest. # noqa: E501
Return type: str

property current_balance¶

Gets the current_balance of this RenewCustomerAccountRequest. # noqa: E501

The current balance on the customer’s account with the biller. # noqa: E501

Returns: The current_balance of this RenewCustomerAccountRequest. # noqa: E501
Return type: str

property current_statement_balance¶

Gets the current_statement_balance of this RenewCustomerAccountRequest. # 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 RenewCustomerAccountRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this RenewCustomerAccountRequest. # 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 RenewCustomerAccountRequest. # noqa: E501
Return type: dict(str, str)

property customer_account_reference¶

Gets the customer_account_reference of this RenewCustomerAccountRequest. # noqa: E501

The unique identifier in the client system for the customer account. # noqa: E501

Returns: The customer_account_reference of this RenewCustomerAccountRequest. # noqa: E501
Return type: str

property minimum_payment_due¶

Gets the minimum_payment_due of this RenewCustomerAccountRequest. # 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 RenewCustomerAccountRequest. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this RenewCustomerAccountRequest. # noqa: E501

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

Returns: The nickname of this RenewCustomerAccountRequest. # noqa: E501
Return type: str

property past_amount_due¶

Gets the past_amount_due of this RenewCustomerAccountRequest. # 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 RenewCustomerAccountRequest. # noqa: E501
Return type: str

property payment_due_date¶

Gets the payment_due_date of this RenewCustomerAccountRequest. # 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 RenewCustomerAccountRequest. # noqa: E501
Return type: str

property statement_date¶

Gets the statement_date of this RenewCustomerAccountRequest. # 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 RenewCustomerAccountRequest. # noqa: E501
Return type: str

swagger_types = {'account_holder_name': 'str', 'account_number': 'str', 'address': 'AddressVo', 'comments': 'str', 'current_balance': 'str', 'current_statement_balance': 'str', 'custom_fields': 'dict(str, str)', 'customer_account_reference': 'str', 'minimum_payment_due': 'str', 'nickname': 'str', 'past_amount_due': 'str', 'payment_due_date': 'str', 'statement_date': 'str'}¶

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

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

orbipay_paymentsapi_client.models.replace_funding_account_request module¶

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

class orbipay_paymentsapi_client.models.replace_funding_account_request.ReplaceFundingAccountRequest(account_holder_name=None, nickname=None, address=None, account_number=None, aba_routing_number=None, expiry_date=None, account_holder_type=None, custom_fields=None, account_subtype=None, card_cvv_number=None, comments=None)¶

Bases: object

NOTE:

property aba_routing_number¶

Gets the aba_routing_number of this ReplaceFundingAccountRequest. # noqa: E501

The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_name¶

Gets the account_holder_name of this ReplaceFundingAccountRequest. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_type¶

Gets the account_holder_type of this ReplaceFundingAccountRequest. # 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 ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this ReplaceFundingAccountRequest. # noqa: E501

The number or reference that a customer uses to identify the funding account. # noqa: E501

Returns: The account_number of this ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property account_subtype¶

Gets the account_subtype of this ReplaceFundingAccountRequest. # 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/ApplePay account. For e.g., a savings account, a checking account. # noqa: E501

Returns: The account_subtype of this ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property address¶

Gets the address of this ReplaceFundingAccountRequest. # noqa: E501

Returns: The address of this ReplaceFundingAccountRequest. # noqa: E501
Return type: FundingAccountAddress

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', 'address': 'address', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'custom_fields': 'custom_fields', 'expiry_date': 'expiry_date', 'nickname': 'nickname'}¶

property card_cvv_number¶

Gets the card_cvv_number of this ReplaceFundingAccountRequest. # noqa: E501

This is never returned by EBPP. This needs to be passed to EBPP when adding or editing a card funding account. # noqa: E501

Returns: The card_cvv_number of this ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property comments¶

Gets the comments of this ReplaceFundingAccountRequest. # 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 ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this ReplaceFundingAccountRequest. # 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 ReplaceFundingAccountRequest. # noqa: E501
Return type: dict(str, str)

property expiry_date¶

Gets the expiry_date of this ReplaceFundingAccountRequest. # 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 ReplaceFundingAccountRequest. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this ReplaceFundingAccountRequest. # noqa: E501

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

Returns: The nickname of this ReplaceFundingAccountRequest. # noqa: E501
Return type: str

swagger_types = {'aba_routing_number': 'str', 'account_holder_name': 'str', 'account_holder_type': 'str', 'account_number': 'str', 'account_subtype': 'str', 'address': 'FundingAccountAddress', 'card_cvv_number': 'str', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'expiry_date': 'str', 'nickname': 'str'}¶

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

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

orbipay_paymentsapi_client.models.resource_audit_vo module¶

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

class orbipay_paymentsapi_client.models.resource_audit_vo.ResourceAuditVo(channel=None, requestor_type=None, requestor=None, timestamp=None)¶

Bases: object

NOTE:

attribute_map = {'channel': 'channel', 'requestor': 'requestor', 'requestor_type': 'requestor_type', 'timestamp': 'timestamp'}¶

property channel¶

Gets the channel of this ResourceAuditVo. # 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 ResourceAuditVo. # noqa: E501
Return type: str

property requestor¶

Gets the requestor of this ResourceAuditVo. # 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 ResourceAuditVo. # noqa: E501
Return type: str

property requestor_type¶

Gets the requestor_type of this ResourceAuditVo. # 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 ResourceAuditVo. # noqa: E501
Return type: str

swagger_types = {'channel': 'str', 'requestor': 'str', 'requestor_type': 'str', 'timestamp': 'str'}¶

property timestamp¶

Gets the timestamp of this ResourceAuditVo. # 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 ResourceAuditVo. # noqa: E501
Return type: str

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

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

orbipay_paymentsapi_client.models.simple_payment_customer_request module¶

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

class orbipay_paymentsapi_client.models.simple_payment_customer_request.SimplePaymentCustomerRequest(customer_reference=None, first_name=None, last_name=None, middle_name=None, gender=None, date_of_birth=None, ssn=None, locale=None, email=None, registered_email=None, home_phone=None, work_phone=None, mobile_phone=None, address=None, custom_fields=None)¶

Bases: object

NOTE:

property address¶

Gets the address of this SimplePaymentCustomerRequest. # noqa: E501

Returns: The address of this SimplePaymentCustomerRequest. # noqa: E501
Return type: AddressVo

attribute_map = {'address': 'address', 'custom_fields': 'custom_fields', 'customer_reference': 'customer_reference', 'date_of_birth': 'date_of_birth', 'email': 'email', 'first_name': 'first_name', 'gender': 'gender', 'home_phone': 'home_phone', 'last_name': 'last_name', 'locale': 'locale', 'middle_name': 'middle_name', 'mobile_phone': 'mobile_phone', 'registered_email': 'registered_email', 'ssn': 'ssn', 'work_phone': 'work_phone'}¶

property custom_fields¶

Gets the custom_fields of this SimplePaymentCustomerRequest. # 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 SimplePaymentCustomerRequest. # noqa: E501
Return type: dict(str, str)

property customer_reference¶

Gets the customer_reference of this SimplePaymentCustomerRequest. # noqa: E501

The unique identifier in the client system for the customer. # noqa: E501

Returns: The customer_reference of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property date_of_birth¶

Gets the date_of_birth of this SimplePaymentCustomerRequest. # 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 SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property email¶

Gets the email of this SimplePaymentCustomerRequest. # 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 SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property first_name¶

Gets the first_name of this SimplePaymentCustomerRequest. # noqa: E501

The first name of the customer. # noqa: E501

Returns: The first_name of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property gender¶

Gets the gender of this SimplePaymentCustomerRequest. # noqa: E501

The gender of the customer. # noqa: E501

Returns: The gender of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property home_phone¶

Gets the home_phone of this SimplePaymentCustomerRequest. # noqa: E501

The home phone number of the customer. # noqa: E501

Returns: The home_phone of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property last_name¶

Gets the last_name of this SimplePaymentCustomerRequest. # noqa: E501

The last name of the customer. # noqa: E501

Returns: The last_name of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property locale¶

Gets the locale of this SimplePaymentCustomerRequest. # 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 SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property middle_name¶

Gets the middle_name of this SimplePaymentCustomerRequest. # noqa: E501

The middle name of the customer. # noqa: E501

Returns: The middle_name of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property mobile_phone¶

Gets the mobile_phone of this SimplePaymentCustomerRequest. # noqa: E501

The mobile phone number of the customer. # noqa: E501

Returns: The mobile_phone of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property registered_email¶

Gets the registered_email of this SimplePaymentCustomerRequest. # 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 SimplePaymentCustomerRequest. # noqa: E501
Return type: str

property ssn¶

Gets the ssn of this SimplePaymentCustomerRequest. # 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 SimplePaymentCustomerRequest. # noqa: E501
Return type: str

swagger_types = {'address': 'AddressVo', 'custom_fields': 'dict(str, str)', 'customer_reference': 'str', 'date_of_birth': 'str', 'email': 'str', 'first_name': 'str', 'gender': 'str', 'home_phone': 'str', 'last_name': 'str', 'locale': 'str', 'middle_name': 'str', 'mobile_phone': 'str', 'registered_email': 'str', 'ssn': 'str', 'work_phone': 'str'}¶

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

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

property work_phone¶

Gets the work_phone of this SimplePaymentCustomerRequest. # noqa: E501

The work phone number of the customer. # noqa: E501

Returns: The work_phone of this SimplePaymentCustomerRequest. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.simple_payment_customer_response module¶

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

class orbipay_paymentsapi_client.models.simple_payment_customer_response.SimplePaymentCustomerResponse(first_name=None, last_name=None, middle_name=None, gender=None, date_of_birth=None, ssn=None, locale=None, email=None, registered_email=None, home_phone=None, work_phone=None, mobile_phone=None, address=None, custom_fields=None, customer_reference=None, id=None, status=None, url=None, audit_info=None, comments=None)¶

Bases: object

NOTE:

property address¶

Gets the address of this SimplePaymentCustomerResponse. # noqa: E501

Returns: The address of this SimplePaymentCustomerResponse. # noqa: E501
Return type: AddressVo

attribute_map = {'address': 'address', 'audit_info': 'audit_info', 'comments': 'comments', 'custom_fields': 'custom_fields', 'customer_reference': 'customer_reference', 'date_of_birth': 'date_of_birth', 'email': 'email', 'first_name': 'first_name', 'gender': 'gender', 'home_phone': 'home_phone', 'id': 'id', 'last_name': 'last_name', 'locale': 'locale', 'middle_name': 'middle_name', 'mobile_phone': 'mobile_phone', 'registered_email': 'registered_email', 'ssn': 'ssn', 'status': 'status', 'url': 'url', 'work_phone': 'work_phone'}¶

property audit_info¶

Gets the audit_info of this SimplePaymentCustomerResponse. # noqa: E501

Returns: The audit_info of this SimplePaymentCustomerResponse. # noqa: E501
Return type: AuditInfoVo

property comments¶

Gets the comments of this SimplePaymentCustomerResponse. # 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 SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this SimplePaymentCustomerResponse. # 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 SimplePaymentCustomerResponse. # noqa: E501
Return type: dict(str, str)

property customer_reference¶

Gets the customer_reference of this SimplePaymentCustomerResponse. # noqa: E501

The unique identifier in the client system for the customer. # noqa: E501

Returns: The customer_reference of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property date_of_birth¶

Gets the date_of_birth of this SimplePaymentCustomerResponse. # 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 SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property email¶

Gets the email of this SimplePaymentCustomerResponse. # 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 SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property first_name¶

Gets the first_name of this SimplePaymentCustomerResponse. # noqa: E501

The first name of the customer. # noqa: E501

Returns: The first_name of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property gender¶

Gets the gender of this SimplePaymentCustomerResponse. # noqa: E501

The gender of the customer. # noqa: E501

Returns: The gender of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property home_phone¶

Gets the home_phone of this SimplePaymentCustomerResponse. # noqa: E501

The home phone number of the customer. # noqa: E501

Returns: The home_phone of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property id¶

Gets the id of this SimplePaymentCustomerResponse. # noqa: E501

The unique identifier assigned by EBPP to the customer. # noqa: E501

Returns: The id of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property last_name¶

Gets the last_name of this SimplePaymentCustomerResponse. # noqa: E501

The last name of the customer. # noqa: E501

Returns: The last_name of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property locale¶

Gets the locale of this SimplePaymentCustomerResponse. # 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 SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property middle_name¶

Gets the middle_name of this SimplePaymentCustomerResponse. # noqa: E501

The middle name of the customer. # noqa: E501

Returns: The middle_name of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property mobile_phone¶

Gets the mobile_phone of this SimplePaymentCustomerResponse. # noqa: E501

The mobile phone number of the customer. # noqa: E501

Returns: The mobile_phone of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property registered_email¶

Gets the registered_email of this SimplePaymentCustomerResponse. # 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 SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property ssn¶

Gets the ssn of this SimplePaymentCustomerResponse. # 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 SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this SimplePaymentCustomerResponse. # noqa: E501

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

Returns: The status of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

swagger_types = {'address': 'AddressVo', 'audit_info': 'AuditInfoVo', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer_reference': 'str', 'date_of_birth': 'str', 'email': 'str', 'first_name': 'str', 'gender': 'str', 'home_phone': 'str', 'id': 'str', 'last_name': 'str', 'locale': 'str', 'middle_name': 'str', 'mobile_phone': 'str', '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

property url¶

Gets the url of this SimplePaymentCustomerResponse. # noqa: E501

This URL fetches the Customer details. # noqa: E501

Returns: The url of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

property work_phone¶

Gets the work_phone of this SimplePaymentCustomerResponse. # noqa: E501

The work phone number of the customer. # noqa: E501

Returns: The work_phone of this SimplePaymentCustomerResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.simple_payment_funding_account_request module¶

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

class orbipay_paymentsapi_client.models.simple_payment_funding_account_request.SimplePaymentFundingAccountRequest(account_holder_name=None, nickname=None, address=None, account_number=None, aba_routing_number=None, expiry_date=None, account_holder_type=None, custom_fields=None, account_subtype=None, card_cvv_number=None, device_manufacturer_id=None, display_text=None)¶

Bases: object

NOTE:

property aba_routing_number¶

Gets the aba_routing_number of this SimplePaymentFundingAccountRequest. # noqa: E501

The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_name¶

Gets the account_holder_name of this SimplePaymentFundingAccountRequest. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_type¶

Gets the account_holder_type of this SimplePaymentFundingAccountRequest. # noqa: E501

The type of ownership for the funding account. This is applicable only in the case of bank accounts. # noqa: E501

Returns: The account_holder_type of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this SimplePaymentFundingAccountRequest. # 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 SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property account_subtype¶

Gets the account_subtype of this SimplePaymentFundingAccountRequest. # 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/ApplePay account. For e.g., a savings account, a checking account. # noqa: E501

Returns: The account_subtype of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property address¶

Gets the address of this SimplePaymentFundingAccountRequest. # noqa: E501

Returns: The address of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: FundingAccountAddress

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', 'address': 'address', 'card_cvv_number': 'card_cvv_number', 'custom_fields': 'custom_fields', 'device_manufacturer_id': 'device_manufacturer_id', 'display_text': 'display_text', 'expiry_date': 'expiry_date', 'nickname': 'nickname'}¶

property card_cvv_number¶

Gets the card_cvv_number of this SimplePaymentFundingAccountRequest. # noqa: E501

This is never returned by EBPP. This needs to be passed to EBPP when adding or editing a card funding account. # noqa: E501

Returns: The card_cvv_number of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this SimplePaymentFundingAccountRequest. # 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 SimplePaymentFundingAccountRequest. # noqa: E501
Return type: dict(str, str)

property device_manufacturer_id¶

Gets the device_manufacturer_id of this SimplePaymentFundingAccountRequest. # noqa: E501

This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier. # noqa: E501

Returns: The device_manufacturer_id of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property display_text¶

Gets the display_text of this SimplePaymentFundingAccountRequest. # noqa: E501

UI representation of the account. # noqa: E501

Returns: The display_text of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property expiry_date¶

Gets the expiry_date of this SimplePaymentFundingAccountRequest. # 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 SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this SimplePaymentFundingAccountRequest. # noqa: E501

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

Returns: The nickname of this SimplePaymentFundingAccountRequest. # noqa: E501
Return type: str

swagger_types = {'aba_routing_number': 'str', 'account_holder_name': 'str', 'account_holder_type': 'str', 'account_number': 'str', 'account_subtype': 'str', 'address': 'FundingAccountAddress', 'card_cvv_number': 'str', 'custom_fields': 'dict(str, str)', 'device_manufacturer_id': 'str', 'display_text': 'str', 'expiry_date': 'str', 'nickname': 'str'}¶

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

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

orbipay_paymentsapi_client.models.simple_payment_request module¶

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

class orbipay_paymentsapi_client.models.simple_payment_request.SimplePaymentRequest(amount=None, card_cvv_number=None, payment_date=None, payment_request_date=None, payment_amount_type=None, fee=None, customer=None, funding_account=None, customer_account=None, payment_reference=None, payment_notification_email=None, cryptogram=None, eci=None, comments=None, custom_fields=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

attribute_map = {'amount': 'amount', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'cryptogram': 'cryptogram', 'custom_fields': 'custom_fields', 'customer': 'customer', 'customer_account': 'customer_account', 'eci': 'eci', 'fee': 'fee', 'funding_account': 'funding_account', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_notification_email': 'payment_notification_email', 'payment_reference': 'payment_reference', 'payment_request_date': 'payment_request_date'}¶

property card_cvv_number¶

Gets the card_cvv_number of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

property comments¶

Gets the comments of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

property cryptogram¶

Gets the cryptogram of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this SimplePaymentRequest. # noqa: E501

Returns: The customer of this SimplePaymentRequest. # noqa: E501
Return type: SimplePaymentCustomerRequest

property customer_account¶

Gets the customer_account of this SimplePaymentRequest. # noqa: E501

Returns: The customer_account of this SimplePaymentRequest. # noqa: E501
Return type: CreateCustomerAccountRequest

property eci¶

Gets the eci of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

property fee¶

Gets the fee of this SimplePaymentRequest. # noqa: E501

Returns: The fee of this SimplePaymentRequest. # noqa: E501
Return type: FeeRequest

property funding_account¶

Gets the funding_account of this SimplePaymentRequest. # noqa: E501

Returns: The funding_account of this SimplePaymentRequest. # noqa: E501
Return type: SimplePaymentFundingAccountRequest

property payment_amount_type¶

Gets the payment_amount_type of this SimplePaymentRequest. # 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. # noqa: E501

Returns: The payment_amount_type of this SimplePaymentRequest. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

property payment_notification_email¶

Gets the payment_notification_email of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this SimplePaymentRequest. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this SimplePaymentRequest. # noqa: E501
Return type: str

property payment_request_date¶

Gets the payment_request_date of this SimplePaymentRequest. # 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 SimplePaymentRequest. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'card_cvv_number': 'str', 'comments': 'str', 'cryptogram': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'SimplePaymentCustomerRequest', 'customer_account': 'CreateCustomerAccountRequest', 'eci': 'str', 'fee': 'FeeRequest', 'funding_account': 'SimplePaymentFundingAccountRequest', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_notification_email': 'str', 'payment_reference': 'str', 'payment_request_date': 'str'}¶

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

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

orbipay_paymentsapi_client.models.simple_payment_response module¶

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

class orbipay_paymentsapi_client.models.simple_payment_response.SimplePaymentResponse(id=None, url=None, fee=None, status=None, payment_method=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, card_cvv_number=None, payment_date=None, payment_schedule_type=None, payment_request_date=None, payment_amount_type=None, payment_reference=None, expected_payment_settlement_date=None, payment_entry_date=None, payment_return_date=None, return_code=None, payment_notification_email=None, comments=None, customer=None, funding_account=None, customer_account=None, payment_network_response=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
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', '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', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this SimplePaymentResponse. # noqa: E501

Returns: The audit_info of this SimplePaymentResponse. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property comments¶

Gets the comments of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this SimplePaymentResponse. # noqa: E501

The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this SimplePaymentResponse. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this SimplePaymentResponse. # noqa: E501

Returns: The customer of this SimplePaymentResponse. # noqa: E501
Return type: SimplePaymentCustomerResponse

property customer_account¶

Gets the customer_account of this SimplePaymentResponse. # noqa: E501

Returns: The customer_account of this SimplePaymentResponse. # noqa: E501
Return type: CustomerAccountResponse

property expected_payment_settlement_date¶

Gets the expected_payment_settlement_date of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property fee¶

Gets the fee of this SimplePaymentResponse. # noqa: E501

Returns: The fee of this SimplePaymentResponse. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this SimplePaymentResponse. # noqa: E501

Returns: The funding_account of this SimplePaymentResponse. # noqa: E501
Return type: FundingAccountResponse

property id¶

Gets the id of this SimplePaymentResponse. # noqa: E501

The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id of this SimplePaymentResponse. # noqa: E501
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this SimplePaymentResponse. # noqa: E501

The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this SimplePaymentResponse. # noqa: E501
Return type: str

property payment_network_response¶

Gets the payment_network_response of this SimplePaymentResponse. # noqa: E501

Returns: The payment_network_response of this SimplePaymentResponse. # noqa: E501
Return type: PaymentNetworkResponseVo

property payment_notification_email¶

Gets the payment_notification_email of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this SimplePaymentResponse. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this SimplePaymentResponse. # noqa: E501
Return type: str

property payment_request_date¶

Gets the payment_request_date of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property payment_return_date¶

Gets the payment_return_date of this SimplePaymentResponse. # noqa: E501

The date on which the ACH returns is received by EBPP. # noqa: E501

Returns: The payment_return_date of this SimplePaymentResponse. # noqa: E501
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this SimplePaymentResponse. # noqa: E501

The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this SimplePaymentResponse. # noqa: E501
Return type: str

property return_code¶

Gets the return_code of this SimplePaymentResponse. # 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 SimplePaymentResponse. # noqa: E501
Return type: str

property status¶

Gets the status of this SimplePaymentResponse. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this SimplePaymentResponse. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'SimplePaymentCustomerResponse', 'customer_account': 'CustomerAccountResponse', 'expected_payment_settlement_date': 'str', 'fee': 'FeeResponse', 'funding_account': 'FundingAccountResponse', 'id': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponseVo', '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_dict()¶: Returns the model properties as a dict

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

property url¶

Gets the url of this SimplePaymentResponse. # noqa: E501

This URL fetches the details of payment. # noqa: E501

Returns: The url of this SimplePaymentResponse. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.simple_payment_response_cgen module¶

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

class orbipay_paymentsapi_client.models.simple_payment_response_cgen.SimplePaymentResponseCgen(id=None, url=None, fee=None, status=None, payment_method=None, confirmation_number=None, custom_fields=None, currency_code3d=None, amount=None, card_cvv_number=None, payment_date=None, payment_schedule_type=None, payment_request_date=None, payment_amount_type=None, payment_reference=None, expected_payment_settlement_date=None, payment_entry_date=None, payment_return_date=None, return_code=None, payment_notification_email=None, cryptogram=None, eci=None, comments=None, customer=None, funding_account=None, customer_account=None, payment_network_response=None, audit_info=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
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', 'status': 'status', 'url': 'url'}¶

property audit_info¶

Gets the audit_info of this SimplePaymentResponseCgen. # noqa: E501

Returns: The audit_info of this SimplePaymentResponseCgen. # noqa: E501
Return type: AuditInfoVo

property card_cvv_number¶

Gets the card_cvv_number of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property comments¶

Gets the comments of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property confirmation_number¶

Gets the confirmation_number of this SimplePaymentResponseCgen. # noqa: E501

The confirmation number or reference provided to the customer for the payment. # noqa: E501

Returns: The confirmation_number of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

property cryptogram¶

Gets the cryptogram of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property currency_code3d¶

Gets the currency_code3d of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: dict(str, str)

property customer¶

Gets the customer of this SimplePaymentResponseCgen. # noqa: E501

Returns: The customer of this SimplePaymentResponseCgen. # noqa: E501
Return type: SimplePaymentCustomerResponse

property customer_account¶

Gets the customer_account of this SimplePaymentResponseCgen. # noqa: E501

Returns: The customer_account of this SimplePaymentResponseCgen. # noqa: E501
Return type: CustomerAccountResponse

property eci¶

Gets the eci of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property expected_payment_settlement_date¶

Gets the expected_payment_settlement_date of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property fee¶

Gets the fee of this SimplePaymentResponseCgen. # noqa: E501

Returns: The fee of this SimplePaymentResponseCgen. # noqa: E501
Return type: FeeResponse

property funding_account¶

Gets the funding_account of this SimplePaymentResponseCgen. # noqa: E501

Returns: The funding_account of this SimplePaymentResponseCgen. # noqa: E501
Return type: FundingAccountResponse

property id¶

Gets the id of this SimplePaymentResponseCgen. # noqa: E501

The unique identifier assigned by EBPP to the payment. # noqa: E501

Returns: The id of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_amount_type¶

Gets the payment_amount_type of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_entry_date¶

Gets the payment_entry_date of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_method¶

Gets the payment_method of this SimplePaymentResponseCgen. # noqa: E501

The fulfillment method for the payment. # noqa: E501

Returns: The payment_method of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_network_response¶

Gets the payment_network_response of this SimplePaymentResponseCgen. # noqa: E501

Returns: The payment_network_response of this SimplePaymentResponseCgen. # noqa: E501
Return type: PaymentNetworkResponseVo

property payment_notification_email¶

Gets the payment_notification_email of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_reference¶

Gets the payment_reference of this SimplePaymentResponseCgen. # noqa: E501

The unique identifier in the client system for the payment. # noqa: E501

Returns: The payment_reference of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_request_date¶

Gets the payment_request_date of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_return_date¶

Gets the payment_return_date of this SimplePaymentResponseCgen. # noqa: E501

The date on which the ACH returns is received by EBPP. # noqa: E501

Returns: The payment_return_date of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

property payment_schedule_type¶

Gets the payment_schedule_type of this SimplePaymentResponseCgen. # noqa: E501

The schedule type for the payment. This defaults to one_time_payment. # noqa: E501

Returns: The payment_schedule_type of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

property return_code¶

Gets the return_code of this SimplePaymentResponseCgen. # 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 SimplePaymentResponseCgen. # noqa: E501
Return type: str

property status¶

Gets the status of this SimplePaymentResponseCgen. # noqa: E501

The status of the payment. # noqa: E501

Returns: The status of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'audit_info': 'AuditInfoVo', 'card_cvv_number': 'str', 'comments': 'str', 'confirmation_number': 'str', 'cryptogram': 'str', 'currency_code3d': 'str', 'custom_fields': 'dict(str, str)', 'customer': 'SimplePaymentCustomerResponse', 'customer_account': 'CustomerAccountResponse', 'eci': 'str', 'expected_payment_settlement_date': 'str', 'fee': 'FeeResponse', 'funding_account': 'FundingAccountResponse', 'id': 'str', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_entry_date': 'str', 'payment_method': 'str', 'payment_network_response': 'PaymentNetworkResponseVo', '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_dict()¶: Returns the model properties as a dict

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

property url¶

Gets the url of this SimplePaymentResponseCgen. # noqa: E501

This URL fetches the details of payment. # noqa: E501

Returns: The url of this SimplePaymentResponseCgen. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.source_payment module¶

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

class orbipay_paymentsapi_client.models.source_payment.SourcePayment(id=None, url=None, customer=None, customer_account=None, funding_account=None)¶

Bases: object

NOTE:

attribute_map = {'customer': 'customer', 'customer_account': 'customer_account', 'funding_account': 'funding_account', 'id': 'id', 'url': 'url'}¶

property customer¶

Gets the customer of this SourcePayment. # noqa: E501

Returns: The customer of this SourcePayment. # noqa: E501
Return type: SourcePaymentCustomer

property customer_account¶

Gets the customer_account of this SourcePayment. # noqa: E501

Returns: The customer_account of this SourcePayment. # noqa: E501
Return type: SourcePaymentCustomerAccount

property funding_account¶

Gets the funding_account of this SourcePayment. # noqa: E501

Returns: The funding_account of this SourcePayment. # noqa: E501
Return type: FundingAccountSnapshotResponse

property id¶

Gets the id of this SourcePayment. # noqa: E501

Returns: The id of this SourcePayment. # noqa: E501
Return type: str

swagger_types = {'customer': 'SourcePaymentCustomer', 'customer_account': 'SourcePaymentCustomerAccount', 'funding_account': 'FundingAccountSnapshotResponse', '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 SourcePayment. # noqa: E501

This URL fetches the details of source payment. # noqa: E501

Returns: The url of this SourcePayment. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.source_payment_customer module¶

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

class orbipay_paymentsapi_client.models.source_payment_customer.SourcePaymentCustomer(id=None, url=None, customer_reference=None)¶

Bases: object

NOTE:

attribute_map = {'customer_reference': 'customer_reference', 'id': 'id', 'url': 'url'}¶

property customer_reference¶

Gets the customer_reference of this SourcePaymentCustomer. # noqa: E501

The unique identifier in the client system for the customer. # noqa: E501

Returns: The customer_reference of this SourcePaymentCustomer. # noqa: E501
Return type: str

property id¶

Gets the id of this SourcePaymentCustomer. # noqa: E501

Returns: The id of this SourcePaymentCustomer. # noqa: E501
Return type: str

swagger_types = {'customer_reference': '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 SourcePaymentCustomer. # noqa: E501

This URL fetches the details of source payment. # noqa: E501

Returns: The url of this SourcePaymentCustomer. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.source_payment_customer_account module¶

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

class orbipay_paymentsapi_client.models.source_payment_customer_account.SourcePaymentCustomerAccount(id=None, url=None, account_number=None)¶

Bases: object

NOTE:

property account_number¶

Gets the account_number of this SourcePaymentCustomerAccount. # noqa: E501

The number or reference that a customer uses to identify the customer’s account. # noqa: E501

Returns: The account_number of this SourcePaymentCustomerAccount. # noqa: E501
Return type: str

attribute_map = {'account_number': 'account_number', 'id': 'id', 'url': 'url'}¶

property id¶

Gets the id of this SourcePaymentCustomerAccount. # noqa: E501

Returns: The id of this SourcePaymentCustomerAccount. # noqa: E501
Return type: str

swagger_types = {'account_number': '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 SourcePaymentCustomerAccount. # noqa: E501

This URL fetches the details of source payment. # noqa: E501

Returns: The url of this SourcePaymentCustomerAccount. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.update_customer_account_request module¶

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

class orbipay_paymentsapi_client.models.update_customer_account_request.UpdateCustomerAccountRequest(account_holder_name=None, nickname=None, address=None, customer_account_reference=None, account_number=None, current_balance=None, current_statement_balance=None, minimum_payment_due=None, past_amount_due=None, payment_due_date=None, statement_date=None, custom_fields=None, status=None)¶

Bases: object

NOTE:

property account_holder_name¶

Gets the account_holder_name of this UpdateCustomerAccountRequest. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this UpdateCustomerAccountRequest. # noqa: E501

The number or reference that a customer uses to identify the customer’s account. # noqa: E501

Returns: The account_number of this UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property address¶

Gets the address of this UpdateCustomerAccountRequest. # noqa: E501

Returns: The address of this UpdateCustomerAccountRequest. # noqa: E501
Return type: AddressVo

attribute_map = {'account_holder_name': 'account_holder_name', 'account_number': 'account_number', 'address': 'address', 'current_balance': 'current_balance', 'current_statement_balance': 'current_statement_balance', 'custom_fields': 'custom_fields', 'customer_account_reference': 'customer_account_reference', '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'}¶

property current_balance¶

Gets the current_balance of this UpdateCustomerAccountRequest. # noqa: E501

The current balance on the customer’s account with the biller. # noqa: E501

Returns: The current_balance of this UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property current_statement_balance¶

Gets the current_statement_balance of this UpdateCustomerAccountRequest. # 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 UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this UpdateCustomerAccountRequest. # 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 UpdateCustomerAccountRequest. # noqa: E501
Return type: dict(str, str)

property customer_account_reference¶

Gets the customer_account_reference of this UpdateCustomerAccountRequest. # noqa: E501

The unique identifier in the client system for the customer account. # noqa: E501

Returns: The customer_account_reference of this UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property minimum_payment_due¶

Gets the minimum_payment_due of this UpdateCustomerAccountRequest. # 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 UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this UpdateCustomerAccountRequest. # noqa: E501

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

Returns: The nickname of this UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property past_amount_due¶

Gets the past_amount_due of this UpdateCustomerAccountRequest. # 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 UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property payment_due_date¶

Gets the payment_due_date of this UpdateCustomerAccountRequest. # 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 UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property statement_date¶

Gets the statement_date of this UpdateCustomerAccountRequest. # 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 UpdateCustomerAccountRequest. # noqa: E501
Return type: str

property status¶

Gets the status of this UpdateCustomerAccountRequest. # noqa: E501

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

Returns: The status of this UpdateCustomerAccountRequest. # noqa: E501
Return type: str

swagger_types = {'account_holder_name': 'str', 'account_number': 'str', 'address': 'AddressVo', 'current_balance': 'str', 'current_statement_balance': 'str', 'custom_fields': 'dict(str, str)', 'customer_account_reference': 'str', 'minimum_payment_due': 'str', 'nickname': 'str', 'past_amount_due': 'str', 'payment_due_date': 'str', 'statement_date': 'str', 'status': 'str'}¶

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

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

orbipay_paymentsapi_client.models.update_customer_request module¶

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

class orbipay_paymentsapi_client.models.update_customer_request.UpdateCustomerRequest(first_name=None, last_name=None, middle_name=None, gender=None, date_of_birth=None, ssn=None, locale=None, email=None, registered_email=None, home_phone=None, work_phone=None, mobile_phone=None, address=None, custom_fields=None, status=None, customer_accounts=None, comments=None)¶

Bases: object

NOTE:

property address¶

Gets the address of this UpdateCustomerRequest. # noqa: E501

Returns: The address of this UpdateCustomerRequest. # noqa: E501
Return type: AddressVo

attribute_map = {'address': 'address', 'comments': 'comments', 'custom_fields': 'custom_fields', 'customer_accounts': 'customer_accounts', 'date_of_birth': 'date_of_birth', 'email': 'email', 'first_name': 'first_name', 'gender': 'gender', 'home_phone': 'home_phone', 'last_name': 'last_name', 'locale': 'locale', 'middle_name': 'middle_name', 'mobile_phone': 'mobile_phone', 'registered_email': 'registered_email', 'ssn': 'ssn', 'status': 'status', 'work_phone': 'work_phone'}¶

property comments¶

Gets the comments of this UpdateCustomerRequest. # 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 UpdateCustomerRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this UpdateCustomerRequest. # 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 UpdateCustomerRequest. # noqa: E501
Return type: dict(str, str)

property customer_accounts¶

Gets the customer_accounts of this UpdateCustomerRequest. # noqa: E501

Returns: The customer_accounts of this UpdateCustomerRequest. # noqa: E501
Return type: list[UpdateCustomerAccountRequest]

property date_of_birth¶

Gets the date_of_birth of this UpdateCustomerRequest. # 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 UpdateCustomerRequest. # noqa: E501
Return type: str

property email¶

Gets the email of this UpdateCustomerRequest. # 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 UpdateCustomerRequest. # noqa: E501
Return type: str

property first_name¶

Gets the first_name of this UpdateCustomerRequest. # noqa: E501

The first name of the customer. # noqa: E501

Returns: The first_name of this UpdateCustomerRequest. # noqa: E501
Return type: str

property gender¶

Gets the gender of this UpdateCustomerRequest. # noqa: E501

The gender of the customer. # noqa: E501

Returns: The gender of this UpdateCustomerRequest. # noqa: E501
Return type: str

property home_phone¶

Gets the home_phone of this UpdateCustomerRequest. # noqa: E501

The home phone number of the customer. # noqa: E501

Returns: The home_phone of this UpdateCustomerRequest. # noqa: E501
Return type: str

property last_name¶

Gets the last_name of this UpdateCustomerRequest. # noqa: E501

The last name of the customer. # noqa: E501

Returns: The last_name of this UpdateCustomerRequest. # noqa: E501
Return type: str

property locale¶

Gets the locale of this UpdateCustomerRequest. # 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 UpdateCustomerRequest. # noqa: E501
Return type: str

property middle_name¶

Gets the middle_name of this UpdateCustomerRequest. # noqa: E501

The middle name of the customer. # noqa: E501

Returns: The middle_name of this UpdateCustomerRequest. # noqa: E501
Return type: str

property mobile_phone¶

Gets the mobile_phone of this UpdateCustomerRequest. # noqa: E501

The mobile phone number of the customer. # noqa: E501

Returns: The mobile_phone of this UpdateCustomerRequest. # noqa: E501
Return type: str

property registered_email¶

Gets the registered_email of this UpdateCustomerRequest. # 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 UpdateCustomerRequest. # noqa: E501
Return type: str

property ssn¶

Gets the ssn of this UpdateCustomerRequest. # 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 UpdateCustomerRequest. # noqa: E501
Return type: str

property status¶

Gets the status of this UpdateCustomerRequest. # noqa: E501

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

Returns: The status of this UpdateCustomerRequest. # noqa: E501
Return type: str

swagger_types = {'address': 'AddressVo', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'customer_accounts': 'list[UpdateCustomerAccountRequest]', 'date_of_birth': 'str', 'email': 'str', 'first_name': 'str', 'gender': 'str', 'home_phone': 'str', 'last_name': 'str', 'locale': 'str', 'middle_name': 'str', 'mobile_phone': 'str', 'registered_email': 'str', 'ssn': 'str', 'status': 'str', 'work_phone': 'str'}¶

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

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

property work_phone¶

Gets the work_phone of this UpdateCustomerRequest. # noqa: E501

The work phone number of the customer. # noqa: E501

Returns: The work_phone of this UpdateCustomerRequest. # noqa: E501
Return type: str

orbipay_paymentsapi_client.models.update_funding_account_request module¶

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

class orbipay_paymentsapi_client.models.update_funding_account_request.UpdateFundingAccountRequest(account_holder_name=None, nickname=None, address=None, account_number=None, aba_routing_number=None, expiry_date=None, account_holder_type=None, custom_fields=None, account_subtype=None, status=None, card_cvv_number=None, comments=None)¶

Bases: object

NOTE:

property aba_routing_number¶

Gets the aba_routing_number of this UpdateFundingAccountRequest. # noqa: E501

The ABA/Routing number for the bank account. # noqa: E501

Returns: The aba_routing_number of this UpdateFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_name¶

Gets the account_holder_name of this UpdateFundingAccountRequest. # noqa: E501

The name as specified on the account. # noqa: E501

Returns: The account_holder_name of this UpdateFundingAccountRequest. # noqa: E501
Return type: str

property account_holder_type¶

Gets the account_holder_type of this UpdateFundingAccountRequest. # 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 UpdateFundingAccountRequest. # noqa: E501
Return type: str

property account_number¶

Gets the account_number of this UpdateFundingAccountRequest. # noqa: E501

The number or reference that a customer uses to identify the funding account. # noqa: E501

Returns: The account_number of this UpdateFundingAccountRequest. # noqa: E501
Return type: str

property account_subtype¶

Gets the account_subtype of this UpdateFundingAccountRequest. # 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/ApplePay account. # noqa: E501

Returns: The account_subtype of this UpdateFundingAccountRequest. # noqa: E501
Return type: str

property address¶

Gets the address of this UpdateFundingAccountRequest. # noqa: E501

Returns: The address of this UpdateFundingAccountRequest. # noqa: E501
Return type: FundingAccountAddress

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', 'address': 'address', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'custom_fields': 'custom_fields', 'expiry_date': 'expiry_date', 'nickname': 'nickname', 'status': 'status'}¶

property card_cvv_number¶

Gets the card_cvv_number of this UpdateFundingAccountRequest. # noqa: E501

This is never returned by EBPP. This needs to be passed to EBPP when adding or editing a card funding account. # noqa: E501

Returns: The card_cvv_number of this UpdateFundingAccountRequest. # noqa: E501
Return type: str

property comments¶

Gets the comments of this UpdateFundingAccountRequest. # 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 UpdateFundingAccountRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this UpdateFundingAccountRequest. # 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 UpdateFundingAccountRequest. # noqa: E501
Return type: dict(str, str)

property expiry_date¶

Gets the expiry_date of this UpdateFundingAccountRequest. # 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 UpdateFundingAccountRequest. # noqa: E501
Return type: str

property nickname¶

Gets the nickname of this UpdateFundingAccountRequest. # noqa: E501

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

Returns: The nickname of this UpdateFundingAccountRequest. # noqa: E501
Return type: str

property status¶

Gets the status of this UpdateFundingAccountRequest. # noqa: E501

The status of the funding account in EBPP. # noqa: E501

Returns: The status of this UpdateFundingAccountRequest. # noqa: E501
Return type: str

swagger_types = {'aba_routing_number': 'str', 'account_holder_name': 'str', 'account_holder_type': 'str', 'account_number': 'str', 'account_subtype': 'str', 'address': 'FundingAccountAddress', 'card_cvv_number': 'str', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'expiry_date': 'str', 'nickname': 'str', 'status': 'str'}¶

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

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

orbipay_paymentsapi_client.models.update_payment_funding_account_minimal_request module¶

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

class orbipay_paymentsapi_client.models.update_payment_funding_account_minimal_request.UpdatePaymentFundingAccountMinimalRequest(id=None)¶

Bases: object

NOTE:

attribute_map = {'id': 'id'}¶

property id¶

Gets the id of this UpdatePaymentFundingAccountMinimalRequest. # noqa: E501

Id is a unique identifier assigned to the account in EBPP. # noqa: E501

Returns: The id of this UpdatePaymentFundingAccountMinimalRequest. # noqa: E501
Return type: str

swagger_types = {'id': 'str'}¶

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

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

orbipay_paymentsapi_client.models.update_payment_request module¶

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

class orbipay_paymentsapi_client.models.update_payment_request.UpdatePaymentRequest(comments=None, custom_fields=None, fee=None, amount=None, card_cvv_number=None, payment_date=None, payment_request_date=None, payment_amount_type=None, funding_account=None)¶

Bases: object

NOTE:

property amount¶

Gets the amount of this UpdatePaymentRequest. # 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 UpdatePaymentRequest. # noqa: E501
Return type: str

attribute_map = {'amount': 'amount', 'card_cvv_number': 'card_cvv_number', 'comments': 'comments', 'custom_fields': 'custom_fields', 'fee': 'fee', 'funding_account': 'funding_account', 'payment_amount_type': 'payment_amount_type', 'payment_date': 'payment_date', 'payment_request_date': 'payment_request_date'}¶

property card_cvv_number¶

Gets the card_cvv_number of this UpdatePaymentRequest. # 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 UpdatePaymentRequest. # noqa: E501
Return type: str

property comments¶

Gets the comments of this UpdatePaymentRequest. # 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 UpdatePaymentRequest. # noqa: E501
Return type: str

property custom_fields¶

Gets the custom_fields of this UpdatePaymentRequest. # 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 UpdatePaymentRequest. # noqa: E501
Return type: dict(str, str)

property fee¶

Gets the fee of this UpdatePaymentRequest. # noqa: E501

Returns: The fee of this UpdatePaymentRequest. # noqa: E501
Return type: FeeRequest

property funding_account¶

Gets the funding_account of this UpdatePaymentRequest. # noqa: E501

Returns: The funding_account of this UpdatePaymentRequest. # noqa: E501
Return type: UpdatePaymentFundingAccountMinimalRequest

property payment_amount_type¶

Gets the payment_amount_type of this UpdatePaymentRequest. # 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 UpdatePaymentRequest. # noqa: E501
Return type: str

property payment_date¶

Gets the payment_date of this UpdatePaymentRequest. # 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 UpdatePaymentRequest. # noqa: E501
Return type: str

property payment_request_date¶

Gets the payment_request_date of this UpdatePaymentRequest. # 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 UpdatePaymentRequest. # noqa: E501
Return type: str

swagger_types = {'amount': 'str', 'card_cvv_number': 'str', 'comments': 'str', 'custom_fields': 'dict(str, str)', 'fee': 'FeeRequest', 'funding_account': 'UpdatePaymentFundingAccountMinimalRequest', 'payment_amount_type': 'str', 'payment_date': 'str', 'payment_request_date': 'str'}¶

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

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

orbipay_paymentsapi_client.models.update_payment_setup_request module¶

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

class orbipay_paymentsapi_client.models.update_payment_setup_request.UpdatePaymentSetupRequest(funding_account=None, payment_schedule=None, comments=None)¶

Bases: object

NOTE:

attribute_map = {'comments': 'comments', 'funding_account': 'funding_account', 'payment_schedule': 'payment_schedule'}¶

property comments¶

Gets the comments of this UpdatePaymentSetupRequest. # 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 UpdatePaymentSetupRequest. # noqa: E501
Return type: str

property funding_account¶

Gets the funding_account of this UpdatePaymentSetupRequest. # noqa: E501

Returns: The funding_account of this UpdatePaymentSetupRequest. # noqa: E501
Return type: FundingAccountMinimalRequest

property payment_schedule¶

Gets the payment_schedule of this UpdatePaymentSetupRequest. # noqa: E501

Returns: The payment_schedule of this UpdatePaymentSetupRequest. # noqa: E501
Return type: PaymentScheduleMinimalRequest

swagger_types = {'comments': 'str', 'funding_account': 'FundingAccountMinimalRequest', 'payment_schedule': 'PaymentScheduleMinimalRequest'}¶

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

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