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

Functions for Plaid payment_initiation/payment endpoints.

Link to this section Summary

Types

config()

params()

t()

Functions

create(params, config \\ %{})

Creates payment.

get(params, config \\ %{})

Gets payment by payment_id.

list(params, config \\ %{})

Lists all payments.

Link to this section Types

config()

Specs

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

params()

Specs

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

t()

Specs

t() :: %Plaid.PaymentInitiation.Payments{
  payment_id: String.t(),
  request_id: String.t(),
  status: String.t()
}

Link to this section Functions

create(params, config \\ %{})

Specs

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: ""
  },
}

get(params, config \\ %{})

Specs

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

Gets payment by payment_id.

Parameters

%{
  payment_id: ""
}

list(params, config \\ %{})

Specs

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

Lists all payments.

Parameters

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