plaid2.model.payment_meta module

class plaid2.model.payment_meta.PaymentMeta(*, payment_method: Optional[str] = None, reason: Optional[str] = None, payer: Optional[str] = None, by_order_of: Optional[str] = None, payee: Optional[str] = None, ppd_id: Optional[str] = None, payment_processor: Optional[str] = None, reference_number: Optional[str] = None)[source]

Bases: BaseModel

by_order_of: Optional[str]

The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.

dict(**kwargs: Any) Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) PaymentMeta[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) PaymentMeta[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payee: Optional[str]

For transfers, the party that is receiving the transaction.

payer: Optional[str]

For transfers, the party that is paying the transaction.

payment_method: Optional[str]

The type of transfer, e.g. ‘ACH’

payment_processor: Optional[str]

The name of the payment processor

ppd_id: Optional[str]

The ACH PPD ID for the payer.

reason: Optional[str]

The payer-supplied description of the transfer.

reference_number: Optional[str]

The transaction reference number supplied by the financial institution.