sync_payee_list_id Property

Server-assigned payee list record ID for this payee.

Syntax

def get_sync_payee_list_id(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

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 sync_payee_id, the sync_payee_list_id 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 sync_payee_id to this payee.

It is assigned by the server to that payee when an add payee request (via on_add_payee method) or bill payment request (via on_pay_bill method) has been sent.

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

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.