plaid2.model.pay_stub_distribution_breakdown module

class plaid2.model.pay_stub_distribution_breakdown.PayStubDistributionBreakdown(*, mask: Optional[str] = None, type: Optional[str] = None, unofficial_currency_code: Optional[str] = None, iso_currency_code: Optional[str] = None, bank_name: Optional[str] = None, current_amount: Optional[float] = None, account_name: Optional[str] = None)

Bases: BaseModel

account_name: Optional[str]

Name of the account for the given distribution.

bank_name: Optional[str]

The name of the bank that the payment is being deposited to.

current_amount: Optional[float]

The amount distributed to this account.

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

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

iso_currency_code: Optional[str]

The ISO-4217 currency code of the net pay. Always null if unofficial_currency_code is non-null.

json(**kwargs: Any) → str

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

mask: Optional[str]

The last 2-4 alphanumeric characters of an account’s official account number.

classmethod parse_obj(data: Any) → PayStubDistributionBreakdown

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

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

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

type: Optional[str]

Type of the account that the paystub was sent to (e.g. ‘checking’).

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the net pay. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.