TxImageRefType Property

Type of retrieval method for actual transaction image.

Object Oriented Interface

public function getTxImageRefType($txindex);

Procedural Interface

ipworksofx_loanstatement_get($res, 60 , $txindex);

Default Value

''

Remarks

Type of retrieval method for actual transaction image.

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

Possible values for TxImageRefType 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 GetImage method where TxImageRef 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 $txindex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

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