Instant Payments

class q2_sdk.hq.db.instant_payments.InstantPaymentsVendorsRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

VendorID: int
ShortName: str
ServiceURL: str
StringIdentifier: str
GetHostAccountIDStoredProcName: str
class q2_sdk.hq.db.instant_payments.InstantPaymentsDataTypeRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

DataTypeID: int
ShortName: str
AdditionalValueLength: int
class q2_sdk.hq.db.instant_payments.InstantPaymentsRequestTypeRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

RequestTypeID: int
ShortName: str
GeneratedTransactionTypeID: int
EnforceLimits: bool
BitFlagValue: int
VendorID: int
CanStartOutgoingRTPConversation: bool
ReplyParentRequestTypes: int
RequiredParentDirectionOutgoing: bool
AllowExpiryDate: bool
RequireExpiryDate: bool
AllowRequestedExecutionDate: bool
RequireRequestedExecutionDate: bool
AllowAmountModificationAllowed: bool
RequireAmountModificationAllowed: bool
ExternalTransactionTypeID: int
class q2_sdk.hq.db.instant_payments.InstantPayments(logger, hq_credentials=None, ret_table_obj=None)[source]

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)[source]

Hook for subclassed DbObjects to add custom arguments.

property transaction_type: TransactionType
async get_vendors(serialize_for_cli=False)[source]
Return type:

List[InstantPaymentsVendorsRow]

async get_vendor_by_name(name)[source]
Return type:

InstantPaymentsVendorsRow

async get_data_types(serialize_for_cli=False)[source]
Return type:

List[InstantPaymentsDataTypeRow]

async get_request_types(serialize_for_cli=False)[source]
Return type:

List[InstantPaymentsRequestTypeRow]

async create_vendor(short_name, url)[source]
async create_data_type(short_name)[source]
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)[source]
async update_request_type(short_name, vendor_name, instant_payment_params, update_vendor=True)[source]
async remove_vendor(short_name)[source]
async remove_data_type(short_name)[source]
async remove_request_type(short_name)[source]