PayeeDetail Type

This type corresponds to a single payee.

Remarks

PayeeDetail objects are used when adding, modifying, or paying a payee, or synchronizing the payees (when the corresponding methods: AddPayee, ModifyPayee, PayBill, and SynchronizePayees are called).

Fields

Account
String

User's account number with the payee. This string uniquely identifies the customer in the payee (biller) system.

This is optional and applicable only when the Id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

Addr1
String

Payee's address line 1.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Addr2
String

Payee's address line 2.

Addr3
String

Payee's address line 3.

Aggregate
String

Wrapper for payee details.

This string consists of all the payee's fields Id, Name, Addr1, Addr2, Addr3, City, State, PostalCode, Country, Phone, IdScope, DaysToPay, ListId, Account of the payee.

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

When sending a payment request (by calling PayBill) to an existing payee in the list returned via the payee synchronization request, and when the Id is unknown or not assigned, instead of setting all payee's fields, the user can set the Aggregate to the value of PayeeAggregate returned for that payee from the SyncPayees event. When the Aggregate is set to this value, all payee's fields are populated with the corresponding values in the aggregate.

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

City
String

Payee's city.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

Country
String

Payee's country. This is a 3 letter country code as representation of a country name (ISO/DIS-3166 3-letter country code standard).

DaysToPay
String

Minimum number of business days required to complete the payment transaction to this payee.

Id
String

Server-assigned payee identifier.

The Id 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 Id or payee full information should be provided in a payment request, but not both.

Payee full information can be provided in the request by setting either the Aggregate or payee details represented by required fields: Name, Addr1, City, State, PostalCode, Phone, and optional fields: Addr2, Addr3, Country, Account.

The Id might be populated when: either a payment request (PayBill method is called) or an add payee request (AddPayee method is called) has been sent to the payment server, or when the Aggregate has been set.

IdScope
String

Scope of the payee Id.

Possible values are:


Value	Meaning
GLOBAL	Payee Id is valid across the entire payee system
USER	Payee Id is valid across all FI accounts for this user

ListId
String

Server-assigned payee list record ID for this payee.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a Id, the ListId 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 Id to this payee.

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

The value of ListId is used as parameter when the ModifyPayee or DeletePayee methods are called (when modifying or deleting a payee). In all other payment requests is optional.

Name
String

Name of the payee to whom the given Id or ListId corresponds. This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

After sending payment or add/modify payee requests, if the returned IdScope is GLOBAL, the Name will contain the standard payee name returned by the server.

Phone
String

Payee's phone.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

PostalCode
String

Payee's postal code.

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

State
String

Payee's state

This is required to be provided in :

a payment request if payee detailed information is used to identify the payee (i.e., when Id is not provided in the request when either PayBill or ModifyPayment methods are called);
adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

TxType
String

Transaction type performed on the payee being synchronized.

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


ADDED	If the payee being synchronized was added in the payee list.
MODIFIED	If the payee being synchronized was modified.
DELETED	If the payee being synchronized was deleted from the payee list.

Constructors

[VB.NET]
Public PayeeDetail()

[C#]
public PayeeDetail();

[VB.NET]
Public PayeeDetail(ByVal Id As String)

[C#]
public PayeeDetail(string id);

[VB.NET]
Public PayeeDetail(ByVal Name As String, ByVal Addr1 As String, ByVal City As String, ByVal State As String, ByVal PostalCode As String, ByVal Phone As String)

[C#]
public PayeeDetail(string name, string addr1, string city, string state, string postalCode, string phone);

[VB.NET]
Public PayeeDetail(ByVal Name As String, ByVal Addr1 As String, ByVal Addr2 As String, ByVal Addr3 As String, ByVal City As String, ByVal State As String, ByVal PostalCode As String, ByVal Country As String, ByVal Phone As String, ByVal Account As String)

[C#]
public PayeeDetail(string name, string addr1, string addr2, string addr3, string city, string state, string postalCode, string country, string phone, string account);