PlaidEx.API.PaymentInitiation (plaid_ex v1.0.0)

Plaid Payment Initiation API — bank-to-bank payments (UK/EU).

Summary

Functions

create_payment(config, params, opts \\ [])

Creates a payment.

create_recipient(config, params, opts \\ [])

Creates a payment recipient.

get_payment(config, payment_id, opts \\ [])

Retrieves a payment by ID.

get_recipient(config, recipient_id, opts \\ [])

Retrieves a payment recipient.

list_payments(config, opts \\ [])

Lists all payments.

list_recipients(config, opts \\ [])

Lists all payment recipients.

reverse_payment(config, payment_id, idempotency_key, params \\ %{}, opts \\ [])

Reverses a payment.

Functions

create_payment(config, params, opts \\ [])

@spec create_payment(PlaidEx.Config.t(), map(), keyword()) ::
  {:ok, %{payment_id: String.t()}} | {:error, PlaidEx.Error.t()}

Creates a payment.

create_recipient(config, params, opts \\ [])

@spec create_recipient(PlaidEx.Config.t(), map(), keyword()) ::
  {:ok, %{recipient_id: String.t()}} | {:error, PlaidEx.Error.t()}

Creates a payment recipient.

get_payment(config, payment_id, opts \\ [])

@spec get_payment(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Retrieves a payment by ID.

get_recipient(config, recipient_id, opts \\ [])

@spec get_recipient(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Retrieves a payment recipient.

list_payments(config, opts \\ [])

@spec list_payments(
  PlaidEx.Config.t(),
  keyword()
) :: {:ok, map()} | {:error, PlaidEx.Error.t()}

Lists all payments.

list_recipients(config, opts \\ [])

@spec list_recipients(
  PlaidEx.Config.t(),
  keyword()
) :: {:ok, map()} | {:error, PlaidEx.Error.t()}

Lists all payment recipients.

reverse_payment(config, payment_id, idempotency_key, params \\ %{}, opts \\ [])

@spec reverse_payment(PlaidEx.Config.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Reverses a payment.