plaid2.model.credit_relay_create_request module

class plaid2.model.credit_relay_create_request.CreditRelayCreateRequest(*, webhook: Optional[str] = None, report_tokens: List[ReportToken], secondary_client_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

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) → CreditRelayCreateRequest

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

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

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

report_tokens: List[ReportToken]

List of report tokens, with at most one token of each report type. Currently only Asset Report token is supported.

secondary_client_id: str

The secondary_client_id is the client id of the third party with whom you would like to share the Relay Token.

webhook: Optional[str]

URL to which Plaid will send webhooks when the Secondary Client successfully retrieves an Asset Report by calling /credit/relay/get.