sync_payee_id Property
Server-assigned payee identifier.
Syntax
def get_sync_payee_id(sync_payee_index: int) -> str: ...
Default Value
""
Remarks
Server-assigned payee identifier.
The sync_payee_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 sync_payee_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 sync_payee_aggregate or payee details represented by required properties: sync_payee_name, sync_payee_addr1, sync_payee_city, sync_payee_state, sync_payee_postal_code, sync_payee_phone, and optional properties: sync_payee_addr2, sync_payee_addr3, sync_payee_country, sync_payee_account.
The sync_payee_id might be populated when: either a payment request (on_pay_bill method is called) or an add payee request (on_add_payee method is called) has been sent to the payment server, or when the sync_payee_aggregate has been set.
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.