plaid2.model.payment_initiation_payment_create_request module

class plaid2.model.payment_initiation_payment_create_request.PaymentInitiationPaymentCreateRequest(*, amount: PaymentAmount, recipient_id: str, reference: str, schedule: Optional[ExternalPaymentScheduleBase] = None, options: Optional[ExternalPaymentOptions] = None)

Bases: BaseModel

amount: PaymentAmount

The amount and currency of a payment

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

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

json(**kwargs: Any) → str

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

options: Optional[ExternalPaymentOptions]

Additional payment options

classmethod parse_obj(data: Any) → PaymentInitiationPaymentCreateRequest

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

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

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

recipient_id: str

The ID of the recipient the payment is for.

reference: str

A reference for the payment. This must be an alphanumeric string with at most 18 characters and must not contain any special characters (since not all institutions support them).

schedule: Optional[ExternalPaymentScheduleBase]

The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.