API Reference¶

Payment Gateway Transaction

copyright:	2013-2014 by Openlabs Technologies & Consulting (P) Ltd.
license:	BSD, see LICENSE for more details

payment_gateway.gateway¶

transaction.PaymentGateway[source]¶: alias of payment_gateway.gateway

Fields¶

PaymentGateway.name¶: Define a char field (unicode).

PaymentGateway.journal¶: Define many2one field (int).

PaymentGateway.provider¶: Define a selection field (str).

PaymentGateway.method¶: Define a selection field (str).

PaymentGateway.test¶: Define a boolean field (True or False).

Methods¶

classmethod PaymentGateway.get_providers()[source]¶: Downstream modules can add to the list

payment_gateway.transaction¶

transaction.PaymentTransaction[source]¶: alias of payment_gateway.transaction

Fields¶

PaymentTransaction.uuid¶: Define a char field (unicode).

PaymentTransaction.provider_reference¶: Define a char field (unicode).

PaymentTransaction.date¶: Define a date field (date).

PaymentTransaction.company¶: Define many2one field (int).

PaymentTransaction.party¶: Define many2one field (int).

PaymentTransaction.payment_profile¶: Define many2one field (int).

PaymentTransaction.address¶: Define many2one field (int).

PaymentTransaction.amount¶: Define a numeric field (decimal).

PaymentTransaction.currency¶: Define many2one field (int).

PaymentTransaction.gateway¶: Define many2one field (int).

PaymentTransaction.provider¶: Define function field (any).

PaymentTransaction.method¶: Define function field (any).

PaymentTransaction.move¶: Define many2one field (int).

PaymentTransaction.logs¶: Define one2many field (list).

PaymentTransaction.state¶: Define a selection field (str).

Methods¶

PaymentTransaction.safe_post()[source]¶

If the initial configuration including defining a period and journal is not completed, marking as done could fail. In such cases, just mark as in-progress and let the user to manually mark as done.

Failing would otherwise rollback transaction but its not possible to rollback the payment

payment_gateway.transaction.log¶

transaction.TransactionLog[source]¶: alias of payment_gateway.transaction.log

Methods¶

classmethod TransactionLog.serialize_and_create(transaction, data)[source]¶

Serialise a given object and then save it as a log

Parameters:	transaction – The transaction against which the log needs to be saved data – The data object that needs to be saved

party.payment_profile¶

transaction.PaymentProfile[source]¶: alias of party.payment_profile

Fields¶

PaymentProfile.party¶: Define many2one field (int).

PaymentProfile.address¶: Define many2one field (int).

PaymentProfile.gateway¶: Define many2one field (int).

PaymentProfile.provider_reference¶: Define a char field (unicode).

PaymentProfile.last_4_digits¶: Define a char field (unicode).

PaymentProfile.expiry_month¶: Define a selection field (str).

PaymentProfile.expiry_year¶: Define an integer field (int).

Wizard: party.party.payment_profile.add¶

transaction.AddPaymentProfile[source]¶: alias of party.party.payment_profile.add

Methods¶

AddPaymentProfile.create_profile(provider_reference)[source]¶

A helper function that creates a profile from the card information that was entered into the View of the wizard. This helper could be called by the method which implement the API and wants to create the profile with provider_reference.

Parameters:	provider_reference – Value for the provider_reference field.
Returns:	Active record of the created profile