Tipalti.API.Payee.payee_payable

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

payee_payable(idap, amount \\ 100.0)

View Source

Specs

payee_payable(Tipalti.idap(), integer() | float()) ::
  {:ok, true}
  | {:ok, false, String.t()}
  | {:error, Tipalti.ClientError.t()}
  | {:error, Tipalti.RequestError.t()}

Return payable status of payee.

If a payment request were to be issued, the payee might not get paid. Possible reasons for not being paid are - missing tax documents, payment below threshold, account locked, address missing, or other.

Parameters

  • idap: a payee id
  • amount: the amount for which you'd want to pay this payee (default: 100.0)

Examples

  iex> payee_payable("payablepayee", 100)
  {:ok, true}

  iex> payee_payable("unpayablepayee")
  {:ok, false, "Tax,No PM"}

  iex> payee_payable("badpayee", 123.45)
  {:error, %Tipalti.ClientError{error_code: "PayeeUnknown", error_message: "PayeeUnknown"}}