payee_id Property

Server-assigned payee identifier.

Syntax

def get_payee_id() -> str: ...
def set_payee_id(value: str) -> None: ...

payee_id = property(get_payee_id, set_payee_id)

Default Value

""

Remarks

Server-assigned payee identifier.

The 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 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 payee_aggregate or payee details represented by required properties: payee_name, payee_addr1, payee_city, payee_state, payee_postal_code, payee_phone, and optional properties: payee_addr2, payee_addr3, payee_country, payee_account.

The 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 payee_aggregate has been set.