plaid2.model.location module

class plaid2.model.location.Location(*, lat: Optional[float] = None, store_number: Optional[str] = None, postal_code: Optional[str] = None, city: Optional[str] = None, region: Optional[str] = None, lon: Optional[float] = None, country: Optional[str] = None, address: Optional[str] = None)[source]

Bases: BaseModel

address: Optional[str]

The street address where the transaction occurred.

city: Optional[str]

The city where the transaction occurred.

country: Optional[str]

The ISO 3166-1 alpha-2 country code where the transaction occurred.

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

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

json(**kwargs: Any) str[source]

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

lat: Optional[float]

The latitude where the transaction occurred.

lon: Optional[float]

The longitude where the transaction occurred.

classmethod parse_obj(data: Any) Location[source]

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

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) Location[source]

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

postal_code: Optional[str]

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

region: Optional[str]

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

store_number: Optional[str]

The merchant defined store number where the transaction occurred.