Plaid.PaymentInitiation.list_payments

You're seeing just the function list_payments, go back to Plaid.PaymentInitiation module for more information.
Link to this function

list_payments(options \\ %{}, config)

View Source

Specs

list_payments(options, Plaid.config()) ::
  {:ok, Plaid.PaymentInitiation.ListPaymentsResponse.t()}
  | {:error, Plaid.Error.t()}
when options: %{optional(:count) => integer(), optional(:cursor) => String.t()}

List payments.

Does a POST /payment_initiation/payment/list call to get all created payments.

Options

  • :count - The maximum number of payments to return.
  • :cursor - A date string in RFC 3339 format. Only payments created before the cursor will be returned.

Examples

PaymentInitiation.list_payments(
  client_id: "123",
  secret: "abc"
)
{:ok, %PaymentInitiation.ListPaymentsResponse{}}