Tipalti.API.Payee.payee_status_update

You're seeing just the function payee_status_update, go back to Tipalti.API.Payee module for more information.
Link to this function

payee_status_update(idap, status, reason \\ nil)

View Source

Specs

payee_status_update(
  Tipalti.idap(),
  :active | :suspended | :blocked,
  String.t() | nil
) ::
  :ok | {:error, Tipalti.ClientError.t()} | {:error, Tipalti.RequestError.t()}

Update the status of payee.

Valid values for status are: :active, :suspended, or :blocked. When blocking a payee, a blocking reason may be supplied

Examples

  iex> payee_status_update("somepayee", :blocked, "Business closed")
  :ok