plaid
plaid v3.3.0

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

Functions for Plaid payment_initiation/payment endpoints.

Link to this section Summary

Types

config()
error()
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

Link to this type

config()

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

error()

View Source 
@type error() :: {:error, Plaid.Error.t() | any()} | no_return()
Link to this type

params()

View Source 
@type params() :: %{required(atom()) => term()}
Link to this type

t()

View Source 
@type t() :: %Plaid.PaymentInitiation.Payments{
  next_cursor: String.t(),
  payments: [Plaid.PaymentInitiation.Payments.Payment.t()],
  request_id: String.t()
}

Link to this section Functions

Link to this function

create(params, config \\ %{})

View Source 
@spec create(params(), config()) ::
  {:ok, Plaid.PaymentInitiation.Payments.Payment.t()} | error()

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 
@spec get(params(), config()) ::
  {:ok, Plaid.PaymentInitiation.Payments.Payment.t()} | error()

Gets payment by payment_id.

Parameters

%{
  payment_id: ""
}
Link to this function

list(params, config \\ %{})

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

Lists all payments.

Parameters

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