plaid2.model.income_verification_paystubs_get_response module

class plaid2.model.income_verification_paystubs_get_response.IncomeVerificationPaystubsGetResponse(*, document_metadata: Optional[List[DocumentMetadata]] = None, paystubs: List[Paystub], error: Optional[Error] = None, request_id: str)

Bases: BaseModel

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

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

document_metadata: Optional[List[DocumentMetadata]]

Metadata for an income document.

error: Optional[Error]

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be null if no error has occurred.

json(**kwargs: Any) → str

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

classmethod parse_obj(data: Any) → IncomeVerificationPaystubsGetResponse

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

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

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

paystubs: List[Paystub]

request_id: str

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.