Moov.PaymentMethods (Moov v1.0.0)

Copy Markdown View Source

A read-only, unified view of every payment method an account has - derived automatically from its linked bank accounts, cards, wallets, Apple Pay/Google Pay tokens, etc.

Common type values you'll see in responses: "moov-wallet", "ach-debit-fund", "ach-debit-collect", "ach-credit-standard", "ach-credit-same-day", "rtp-credit", "instant-bank-credit", "card-payment", "push-to-card", "pull-from-card", "card-present-payment", "apple-pay", "push-to-apple-pay", "pull-from-apple-pay", "google-pay".

See https://docs.moov.io/api/sources/payment-methods/.

Summary

Functions

Retrieves a single payment method.

Lists an account's payment methods. Filter with opts[:query], e.g. query: [source_id: bank_account_id] to find the payment method(s) derived from a specific bank account or card.

Functions

get(client, account_id, payment_method_id)

@spec get(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Retrieves a single payment method.

list(client, account_id, opts \\ [])

@spec list(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists an account's payment methods. Filter with opts[:query], e.g. query: [source_id: bank_account_id] to find the payment method(s) derived from a specific bank account or card.