plaid2.model.payment_initiation_recipient_create_request module

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

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. If BACS data is not provided, an IBAN is required.

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. We recommend using strings of length 18 or less and avoid special characters to ensure compatibility with all institutions.

classmethod parse_obj(data: Any) → PaymentInitiationRecipientCreateRequest

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

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

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