plaid v2.3.0 Plaid.PaymentInitiation.Recipients View Source

Functions for Plaid payment_initiation/recipient endpoints.

Link to this section Summary

Functions

Creates recipient.

Gets recipient by recipient_id.

Lists all recipients.

Link to this section Types

Link to this type

config()

View Source
config() :: %{required(atom()) => String.t()}
Link to this type

params()

View Source
params() :: %{required(atom()) => String.t() | map()}
Link to this type

t()

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

Link to this section Functions

Link to this function

create(params, config \\ %{})

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

Creates recipient.

Parameters

%{

}
Link to this function

get(params, config \\ %{})

View Source

Gets recipient by recipient_id.

Parameters

%{
  recipient_id: ""
}

Lists all recipients.