Rental payment record submission - reporting a tenant's verified rent payment history (typically derived from detected regular transactions) to a credit reference agency such as Experian, to help build their credit file.
Submitting a rental record requires separate user consent beyond the AIS connection - see Rental Recognition for the two-consent flow.
Summary
Functions
Creates a rental record. attrs typically includes the tenancy details
(landlord/letting agent, address, monthly rent amount) and references
the verified regular transaction series for the rent payments.
Fetches a rental record's status by id.
Types
@type rental_record() :: map()
Functions
@spec create(MoneyHub.Config.t(), String.t(), map()) :: {:ok, rental_record()} | {:error, MoneyHub.Error.t()}
Creates a rental record. attrs typically includes the tenancy details
(landlord/letting agent, address, monthly rent amount) and references
the verified regular transaction series for the rent payments.
@spec get(MoneyHub.Config.t(), String.t(), String.t()) :: {:ok, rental_record()} | {:error, MoneyHub.Error.t()}
Fetches a rental record's status by id.