plaid v2.3.0 Plaid.PaymentInitiation.Payments View Source

Functions for Plaid payment_initiation/payment endpoints.

Link to this section Summary

Functions

Gets payment by payment_id.

Lists all payments.

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.Payments{
  payment_id: String.t(),
  request_id: String.t(),
  status: 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 payment.

Parameters

%{
  recipient_id: "",
  reference: "",
  amount: %{
    currency: "",
    value: 0.00
  },
  schedule: %{
    interval: "",
    interval_execution_day: 1,
    start_date: ""
  },
}
Link to this function

get(params, config \\ %{})

View Source
get(params(), config() | nil) ::
  {:ok, Plaid.PaymentInitiation.Payments.Payment.t()}
  | {:error, Plaid.Error.t()}

Gets payment by payment_id.

Parameters

%{
  payment_id: ""
}
Link to this function

list(params, config \\ %{})

View Source
list(params(), config() | nil) ::
  {:ok, [Plaid.PaymentInitiation.Payments.Payment.t()]}
  | {:error, Plaid.Error.t()}

Lists all payments.

Parameters

%{
  options: %{
    count: 1,
    cursor: ""
  }
}