Instant Payments

class q2_sdk.hq.db.instant_payments.InstantPaymentsVendorsRow

Bases: RepresentationRowBase

VendorID: IntElement = 'VendorID'

ShortName: StringElement = 'ShortName'

ServiceURL: StringElement = 'ServiceURL'

StringIdentifier: StringElement = 'StringIdentifier'

GetHostAccountIDStoredProcName: StringElement = 'GetHostAccountIDStoredProcName'

class q2_sdk.hq.db.instant_payments.InstantPaymentsDataTypeRow

Bases: RepresentationRowBase

DataTypeID: IntElement = 'DataTypeID'

ShortName: StringElement = 'ShortName'

AdditionalValueLength: IntElement = 'ServiceURL'

class q2_sdk.hq.db.instant_payments.InstantPaymentsRequestTypeRow

Bases: RepresentationRowBase

RequestTypeID: IntElement = 'RequestTypeID'

ShortName: StringElement = 'ShortName'

GeneratedTransactionTypeID: IntElement = 'GeneratedTransactionTypeID'

EnforceLimits: BoolElement = 'EnforceLimits'

BitFlagValue: IntElement = 'BitFlagValue'

VendorID: IntElement = 'VendorID'

CanStartOutgoingRTPConversation: BoolElement = 'CanStartOutgoingRTPConversation'

ReplyParentRequestTypes: IntElement = 'ReplyParentRequestTypes'

RequiredParentDirectionOutgoing: BoolElement = 'RequiredParentDirectionOutgoing'

AllowExpiryDate: BoolElement = 'AllowExpiryDate'

RequireExpiryDate: BoolElement = 'RequireExpiryDate'

AllowRequestedExecutionDate: BoolElement = 'AllowRequestedExecutionDate'

RequireRequestedExecutionDate: BoolElement = 'RequireRequestedExecutionDate'

AllowAmountModificationAllowed: BoolElement = 'AllowAmountModificationAllowed'

RequireAmountModificationAllowed: BoolElement = 'RequireAmountModificationAllowed'

ExternalTransactionTypeID: IntElement = 'ExternalTransactionTypeID'

class q2_sdk.hq.db.instant_payments.InstantPayments(logger, hq_credentials=None, ret_table_obj=None)

Bases: DbObject

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

Parameters:

• logger – Reference to calling request’s logger (self.logger in your extension)

• hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)

• ret_table_obj (bool) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

NAME = 'InstantPayments'

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

property transaction_type: TransactionType

async get_vendors(serialize_for_cli=False)

Return type:

List[InstantPaymentsVendorsRow]

async get_vendor_by_name(name)

Return type:

InstantPaymentsVendorsRow

async get_data_types(serialize_for_cli=False)

Return type:

List[InstantPaymentsDataTypeRow]

async get_request_types(serialize_for_cli=False)

Return type:

List[InstantPaymentsRequestTypeRow]

async create_vendor(short_name, url)

async create_data_type(short_name)

async create_request_type(short_name, generated_transaction_type, enforce_limits, bitflag_value, vendor_name, can_start_outgoing_rtp_conversation, require_parent_direction_outgoing=False, reply_parent_request_types=None, external_transaction_type=None)

async update_request_type(short_name, vendor_name, instant_payment_params, update_vendor=True)

async remove_vendor(short_name)

async remove_data_type(short_name)

async remove_request_type(short_name)