IPWorks OFX 2020 Python Edition

Questions / Feedback?

tx_image_ref_type Property

Type of retrieval method for actual transaction image.

Syntax

def get_tx_image_ref_type(tx_index: int) -> str: ...

Default Value

""

Remarks

Type of retrieval method for actual transaction image.

If tx_image_ref is returned in the response, this can be either image identifier (to be used during the request for the image when the on_get_image method is called) or a URL.

Possible values for tx_image_ref_type are:

Value Meaning
OPAQUE Requires the client to send a separate OFX request to access the image. The image can be retrieved by calling the on_get_image method where tx_image_ref will be the parameter value for this method.
URL The image is accessed directly via the URL provided. The client will not provide authentication and will simply follow the URL provided.
FORMURL The image is accessed directly via an encoded URL. The client will send authentication to the server.

Note: This is not applicable for credit card accounts.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Python Edition - Version 20.0 [Build 7941]