plaid2.model.payment_initiation_recipient module

class plaid2.model.payment_initiation_recipient.PaymentInitiationRecipient(*, bacs: Optional[RecipientBacs] = None, address: Optional[PaymentInitiationAddress] = None, name: str, iban: Optional[str] = None, recipient_id: str)

Bases: BaseModel

class Config

Bases: object

alias_generator()

allow_population_by_field_name = True

address: Optional[PaymentInitiationAddress]

The optional address of the payment recipient.

bacs: Optional[RecipientBacs]

An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.

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

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

iban: Optional[str]

The International Bank Account Number (IBAN) for the recipient.

json(**kwargs: Any) → str

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

name_: str

The name of the recipient.

classmethod parse_obj(data: Any) → PaymentInitiationRecipient

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

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → PaymentInitiationRecipient

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

recipient_id: str

The ID of the recipient.