PaymentPayeeListId Property

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

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetPaymentPayeeListId();

Unicode (Windows)
LPWSTR GetPaymentPayeeListId();

@property (nonatomic,readonly,assign,getter=paymentPayeeListId) NSString* paymentPayeeListId;
- (NSString*)paymentPayeeListId;

#define PID_BILLPAYMENT_PAYMENTPAYEELISTID 49

IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_BillPayment_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

Default Value

""

Remarks

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 PaymentPayeeId, the PaymentPayeeListId 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 PaymentPayeeId 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.

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

Data Type

String