Plaid.PaymentInitiation.Recipients (plaid v2.5.0) View Source

Functions for Plaid payment_initiation/recipient endpoints.

Link to this section Summary

config()

params()

t()

Creates recipient.

Gets recipient by recipient_id.

Lists all recipients.

config() :: %{required(atom()) => String.t()}

params() :: %{required(atom()) => String.t() | map()}

t() :: %Plaid.PaymentInitiation.Recipients{
  recipient_id: String.t(),
  request_id: String.t()
}

create(params(), config() | nil) :: {:ok, t()} | {:error, Plaid.Error.t()}

Creates recipient.

Parameters

%{

}

get(params(), config() | nil) ::
  {:ok, Plaid.PaymentInitiation.Recipients.Recipient.t()}
  | {:error, Plaid.Error.t()}

Gets recipient by recipient_id.

Parameters

%{
  recipient_id: ""
}

list(config() | nil) ::
  {:ok, [Plaid.PaymentInitiation.Recipients.Recipient.t()]}
  | {:error, Plaid.Error.t()}

Lists all recipients.