IPWorks OFX 2020 Node.js Edition

Questions / Feedback?

PaymentTxType Property

Transaction type performed on the payment being synchronized.

Syntax

 billpayment.getPaymentTxType([callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPaymentTxType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPaymentTxType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Transaction type performed on the payment being synchronized.

This is applicable to payment synchronization requests only. Possible values and their meanings are as follows:

ADDED If the payment being synchronized was new bill payment.
MODIFIED If the payment being synchronized was modified.
CANCELLEDIf the payment being synchronized was cancelled.

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 Node.js Edition - Version 20.0 [Build 7941]