PaymentDetail Type

This type corresponds to a single bill payment.

Remarks

PaymentDetail objects are used when paying or modifying a bill, or synchronizing the bill payments (when the corresponding methods: PayBill, ModifyPayment, and SynchronizePayments are called).

Fields

Aggregate
String

Wrapper for a payment details.

This string consists of all the payment's fields Id, Status, Amount, FromBankId, FromAccountId, FromAccountType, Memo, CheckNumber, etc..

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the bean's fields. However, some of these elements, and/or their potential values, may not be supported by the bean. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate bean or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the bean internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

Amount
String

Payment amount. This is to be provided when sending a bill payment request.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the bean will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the bean will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

BillRef
String

Biller-supplied reference information when paying a bill, if available.

This is optional when submitting a payment request.

CheckNumber
String

Check number assigned by the server to this payment.

This will be returned in the server response (if available) when the request succeeds.

CurrencyCode
String

Default currency code for this transaction.

This indicates the currency in which the payment will be carried out.

DateDue
String

Processing date requested by user for the payment to be sent.

This is required to be provided in any bill payment or payment modification requests.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

DateProcessed
String

Payment processing date.

This indicates the date when the event described by Status occurs.

This format specifies also how the returned dates are going to get parsed.

FromAccountId
String

Account number from which the money for this payment is drawn.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with that bank.

It 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).

If FromAccountType is set to CreditCard, the FromAccountId should be a credit card account number.

FromAccountType
int

Indicates the type of account from which the money for this payment is drawn.

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)

FromBankId
String

Number that identifies the bank where the money is to be withdrawn.

This is required to be provided when a bill payment request has been made.

Id
String

Transaction Id assigned by the server to the payment.

The Id is returned after a bill payment request (when calling the PayBill method, which can be either a single payment or a recurring payment model).

This identifier value can be used as reference to this payment or model in any modification or cancellation request (as parameter when the ModifyPayment or CancelPayment methods are called).

Memo
String

Memo attached to this payment from the customer to payee.

This is optional when submitting a payment request.

PayeeAccount
String

User's account number with the payee this payment was sent to.

This string uniquely identifies the customer in the payee (biller) system.

PayeeAggregate
String

Wrapper for the payee details this payment was sent to.

This string consists of these payee's data: name, address, city, state, country, postal code, country and phone.

When the SynchronizePayments is called, the SyncPayments event is fired for each payment in the payment list. Among other payment data returned through this event's parameters, there is also a PayeeAggregate parameter.

PayeeId
String

Server-assigned identifier to the payee this payment was sent to.

The PayeeId is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either PayeeAggregate or PayeeId can be returned in the response, but not both.

PayeeListId
String

Server-assigned payee list record ID for the payee this payment was sent to.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a PayeeId, the PayeeListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a PayeeId to this payee.

This is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

Status
String

Payment processing status.

The possible values of this property are as follows:


Value	Meaning
WILLPROCESSON	Will be processed on Date
PROCESSEDON	Was processed on Date
NOFUNDSON	There were insufficient funds to pay this bill as of Date
FAILEDON	The attempt to make a payment failed on Date for unspecified reasons
CANCELEDON	the request to make a payment was canceled by the user on Date

ToAccountId
String

Account number to which the money for this payment is sent.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with this bank.

It is optional 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).

If ToAccountType is set to CreditCard, the ToAccountId should be a credit card account number.

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 Id.

ToAccountType
int

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)

ToBankId
String

Number that identifies the bank where the money is to be deposited.

TxType
String

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.
CANCELLED	If the payment being synchronized was cancelled.

Constructors

public PaymentDetail();

public PaymentDetail(String id, String fromBankId, String fromAccountId, int fromAccountType, String toBankId, String toAccountId, int toAccountType, String amount, String dateDue, String memo);

public PaymentDetail(String fromBankId, String fromAccountId, int fromAccountType, String toBankId, String toAccountId, int toAccountType, String amount, String dateDue, String memo);

public PaymentDetail(String fromBankId, String fromAccountId, int fromAccountType, String amount, String dateDue, String memo);

public PaymentDetail(String fromBankId, String fromAccountId, int fromAccountType, String amount, String dateDue);

public PaymentDetail(String id, String fromBankId, String fromAccountId, int fromAccountType);

public PaymentDetail(String fromBankId, String fromAccountId, int fromAccountType);

public PaymentDetail(String id);