IPWorks OFX 2020 Node.js Edition

Questions / Feedback?

PaymentToAccountType Property

Indicates the type of account to which this payment is sent.

Syntax

 billpayment.getPaymentToAccountType([callback])
 billpayment.setPaymentToAccountType( paymentToAccountType, [callback])

Possible Values

  0 (atChecking), 
  1 (atSavings), 
  2 (atMoneyMarket), 
  3 (atLineOfCredit), 
  4 (atCreditCard)

Default Value

0

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 getPaymentToAccountType([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 setPaymentToAccountType([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

Indicates the type of account to which this payment is sent.

This is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when PayBill or ModifyPayment methods are called).

This property uses the following four values:

  • atChecking (0)
  • atSavings (1)
  • atMoneyMarket (2)
  • atLineOfCredit (3)

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via PayeeId.

This property is not available at design time.

Data Type

Integer

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