on_sync_payees Event
Fired for each payee included in the synchronization response.
Syntax
class BillPaymentSyncPayeesEventParams(object): @property def payee_aggregate() -> str: ... @property def payee_tx_type() -> str: ... @property def payee_id() -> str: ... @property def payee_id_scope() -> str: ... @property def payee_list_id() -> str: ... @property def payee_account() -> str: ... @property def payee_name() -> str: ... @property def payee_addr1() -> str: ... @property def payee_addr2() -> str: ... @property def payee_addr3() -> str: ... @property def payee_city() -> str: ... @property def payee_state() -> str: ... @property def payee_postal_code() -> str: ... @property def payee_country() -> str: ... @property def payee_phone() -> str: ... # In class BillPayment: @property def on_sync_payees() -> Callable[[BillPaymentSyncPayeesEventParams], None]: ... @on_sync_payees.setter def on_sync_payees(event_hook: Callable[[BillPaymentSyncPayeesEventParams], None]) -> None: ...
Remarks
When this event is fired for each payee included in the response (if any), the following are returned for each payee identified by PayeeListId:
- PayeeAggregate contains the complete aggregate for a payee.
- PayeeTxType indicates the payee transaction type, if this is added, modified or deleted (possible values: ADDED, MODIFIED, DELETED).
- PayeeId contains the server-assigned id of a payee.
- PayeeIdScope contains Scope of a payee ID in the payee list (GLOBAL, USER), where GLOBAL = payee ID valid across the entire payment system USER = payee ID valid with all FI accounts set up for the user's payments account.
- PayeeListId contains the list record id of a payee in the payee list.
- PayeeAccount contains the account the user has with a payee in the payee list.
- PayeeName contains the name of a payee in the payee list.
- PayeeAddr1 contains the street address (line 1) of a payee in the payee list.
- PayeeAddr2 contains the address line 2 of a payee in the payee list.
- PayeeAddr3 contains the address line 3 of a payee in the payee list.
- PayeeCity contains the city name of a payee in the payee list.
- PayeeState contains the state name of a payee in the payee list.
- PayeePostalCode contains the postal code of a payee in the payee list.
- PayeeCountry contains the country name of a payee in the payee list.
- PayeePhone contains the phone number of a payee in the payee list.
If what you need is not returned through this event parameters, you can always parse each PayeeAggregate using our OFXAggregate component.