View Source Plaid.PaymentInitiation.Recipients (plaid v3.3.0)

Functions for Plaid payment_initiation/recipient endpoints.

Link to this section Summary

config()

error()

params()

t()

Creates recipient.

Gets recipient by recipient_id.

Lists all recipients.

@type config() :: %{required(atom()) => String.t() | keyword()}

@type error() :: {:error, Plaid.Error.t() | any()} | no_return()

@type params() :: %{required(atom()) => term()}

@type t() :: %Plaid.PaymentInitiation.Recipients{
  recipients: [Plaid.PaymentInitiation.Recipients.Recipient.t()],
  request_id: String.t()
}

@spec create(params(), config()) ::
  {:ok, Plaid.PaymentInitiation.Recipients.Recipient.t()} | error()

Creates recipient.

Parameters

%{

}

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

Gets recipient by recipient_id.

Parameters

%{
  recipient_id: ""
}

@spec list(config()) :: {:ok, t()} | error()

Lists all recipients.