Tink.IncomeCheck (Tink v1.0.0)

Income verification reports. Requires income-checks:create, income-checks:readonly, income-checks:delete.

Summary

Create an income check. Requires income-checks:create.

Delete an income check. Requires income-checks:delete.

Trigger PDF generation for an income check. Requires income-checks:readonly.

get(client, id)

Get an income check by ID. Requires income-checks:readonly.

List income checks with pagination. Requires income-checks:readonly.

@spec create(Tink.Client.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}

Create an income check. Requires income-checks:create.

@spec delete(Tink.Client.t(), String.t()) :: :ok | {:error, Tink.Error.t()}

Delete an income check. Requires income-checks:delete.

@spec generate_pdf(Tink.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Trigger PDF generation for an income check. Requires income-checks:readonly.

@spec get(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

Get an income check by ID. Requires income-checks:readonly.

@spec list(
  Tink.Client.t(),
  keyword()
) :: {:ok, map()} | {:error, Tink.Error.t()}

List income checks with pagination. Requires income-checks:readonly.