sync_payment_payee_id Property

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

Syntax

def get_sync_payment_payee_id(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

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

The sync_payment_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_payment_payee_aggregate or sync_payment_payee_id can be returned in the response, but not both.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.